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

@orangecheck/sdk


@orangecheck/sdk / CheckParams

Interface: CheckParams

Defined in: check.ts:23

Properties

PropertyTypeDescriptionDefined in
<a id="property-addr"></a> addr?stringBitcoin address to look up.check.ts:25
<a id="property-id"></a> id?stringContent-addressed attestation ID (hex).check.ts:27
<a id="property-identity"></a> identity?&#123; identifier: string; protocol: string; &#125;Identity binding, e.g. { protocol: 'github', identifier: 'alice' }.check.ts:29
identity.identifierstring-check.ts:29
identity.protocolstring-check.ts:29
<a id="property-mindays"></a> minDays?numberMinimum days unspent to pass. Default 0.check.ts:33
<a id="property-minsats"></a> minSats?numberMinimum sats bonded to pass. Default 0.check.ts:31
<a id="property-relays"></a> relays?string[]Optional relay overrides for discovery.check.ts:35
<a id="property-verifyoptions"></a> verifyOptions?VerifyOptionsOptional verify-time options (esplora bases, test mode).check.ts:37