Skip to content
On this page

Function: checkStake()

TypeScript
function checkStake(
   envelope: StampEnvelope, 
   attestation: 
  | ResolvedAttestation
  | null
  | undefined, 
   policy: StakePolicy): StakeCheck;

Defined in: stamp-core/src/stake.ts:34 (opens in a new tab)

Check an envelope's stake against a policy. Pass the attestation as resolved now, or null if it did not resolve. The declared sats_bonded / days_unspent are ignored.

ParametersLink to this section

ParameterType
envelopeStampEnvelope
attestation| ResolvedAttestation | null | undefined
policyStakePolicy

ReturnsLink to this section

StakeCheck