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

@orangecheck/pledge-core


@orangecheck/pledge-core / createAbandonment

Function: createAbandonment()

function createAbandonment(input: CreateAbandonmentInput): Promise<AbandonmentEnvelope>;

Defined in: pledge-core/src/abandonment.ts:36

Build, validate, and sign an abandonment envelope.

SPEC §5: abandonment counts as broken in the public ledger. Agents MUST NOT publish abandonments in v0.1 — only the original swearer (principal) may sign. The SDK enforces this by requiring swearerSigner.address to equal the address that signed the original pledge, but it cannot verify cross-envelope reference here (the original pledge isn't an input). Callers MUST cross-check against the referenced pledge before relying on the resulting envelope.

Parameters

ParameterType
inputCreateAbandonmentInput

Returns

Promise&lt;AbandonmentEnvelope>