live · mainnetoc · docs
specs · api · guides
docs / documentation

@orangecheck/pledge-core


@orangecheck/pledge-core / verifyPledge

Function: verifyPledge()

function verifyPledge(input: VerifyPledgeInput): Promise<VerifyPledgeResult>;

Defined in: pledge-core/src/pledge.ts:221

Verify a pledge envelope per SPEC §9.1 steps 1–4 (envelope-only checks).

What this does cover:

  • Version check (§9.1.1)
  • Shape check (§9.1.2)
  • Canonical-message reconstruction + id check (§9.1.3)
  • BIP-322 signature verify (§9.1.4) — when verifyBip322 is supplied

What this does NOT cover (delegated to other functions / caller hooks):

  • Bond verification (§9.1.5) — see verifyBond()
  • Outcome / abandonment side-channel verification — see verifyOutcome() and verifyAbandonment()
  • Mechanism re-evaluation against public state (§9.1.8) — out of scope for the envelope-only SDK; consumers wire their chain/relay/dns clients
  • State classification (§9.1.9) — see classifyState()

skipSignatureVerification = true is the test-vector path (placeholder sigs); production callers MUST supply verifyBip322.

Parameters

ParameterType
inputVerifyPledgeInput

Returns

Promise&lt;VerifyPledgeResult>