oc · docs
docs / documentation

@orangecheck/react


@orangecheck/react / OcGateProps

Interface: OcGateProps

Defined in: gate.tsx:23

Properties

PropertyTypeDescriptionDefined in
<a id="property-address"></a> address?stringBitcoin address. Pick one of address / attestationId / identity.gate.tsx:25
<a id="property-attestationid"></a> attestationId?stringAttestation ID (SHA-256 hex).gate.tsx:27
<a id="property-children"></a> children?anyRendered when the check passes. The resolved CheckResult is passed through.gate.tsx:37
<a id="property-fallback"></a> fallback?anyRendered when the check fails. Receives the CheckResult so you can explain why.gate.tsx:41
<a id="property-identity"></a> identity?&#123; identifier: string; protocol: string; &#125;Identity binding, e.g. { protocol: 'github', identifier: 'alice' }.gate.tsx:29
identity.identifierstring-gate.tsx:29
identity.protocolstring-gate.tsx:29
<a id="property-loading"></a> loading?anyRendered while the check is pending. Default null.gate.tsx:39
<a id="property-mindays"></a> minDays?numberMinimum days unspent. Default 0.gate.tsx:34
<a id="property-minsats"></a> minSats?numberMinimum sats bonded. Default 0.gate.tsx:32
<a id="property-onresult"></a> onResult?(result: CheckResult) => voidOptional callback when the check resolves (pass or fail).gate.tsx:44
<a id="property-relays"></a> relays?string[]Override discovery relays.gate.tsx:47