Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/security / / canonicalizeForSignature

Function: canonicalizeForSignature()

ts
function canonicalizeForSignature(skillMd): {
  bytes: Uint8Array;
  canonicalText: string;
};

Defined in: packages/security/src/supply-chain/frontmatter.ts:159

Compute the canonical bytes used for ed25519 signing / verification. The algorithm:

  1. Strip the graphorin-signature key from the frontmatter.
  2. Recursively sort every object's keys.
  3. Stringify back to YAML using yaml's deterministic emitter.
  4. Concatenate frontmatter\n---\n<body> and return the UTF-8 bytes.

Parameters

ParameterType
skillMdstring

Returns

ts
{
  bytes: Uint8Array;
  canonicalText: string;
}
NameTypeDefined in
bytesUint8Arraypackages/security/src/supply-chain/frontmatter.ts:160
canonicalTextstringpackages/security/src/supply-chain/frontmatter.ts:161

Stable