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

@orangecheck/auth-client


@orangecheck/auth-client / OcAccount

Interface: OcAccount

Defined in: src/types.ts:1

Properties

PropertyTypeDescriptionDefined in
<a id="property-accountid"></a> accountIdstring-src/types.ts:2
<a id="property-address"></a> addressstring-src/types.ts:3
<a id="property-displayname"></a> displayName?string | null-src/types.ts:4
<a id="property-homefederation"></a> homeFederation?string | nullSlug of the federation this user is bound to (their "home" federation). Multi-federation routing reads this; null/undefined means "not yet bound — fall back to the directory default at /api/federations". v1 has one live federation, so this is set on first signin and rarely changes.src/types.ts:13
<a id="property-nostrnpub"></a> nostrNpub?string | null-src/types.ts:5
<a id="property-signingmethod"></a> signingMethod?"fedimint_threshold" | "fedimint_client" | "bip322" | nullWhere this user is on the custody-state graph: - 'fedimint_threshold' — federation custody (OC-introduced) - 'fedimint_client' — federation custody (user-picked) - 'bip322' — full self-custody Graduation is the product thesis. Treat undefined as 'fedimint_threshold' for did:email: addresses and 'bip322' for Bitcoin addresses (the default-by-construction mapping for tokens minted before this field shipped).src/types.ts:26