verus-rpc 0.1.0

package/dist/methods/identity.d.ts

@@ -0,0 +1,284 @@
+import type { RpcTransport } from "../transport.js";
+/** The identity object embedded in `getidentity`-style responses. */
+export interface IdentityDefinition {
+    version: number;
+    flags: number;
+    primaryaddresses: string[];
+    minimumsignatures: number;
+    name: string;
+    identityaddress: string;
+    parent: string;
+    systemid: string;
+    contentmap?: Record<string, unknown> | undefined;
+    contentmultimap?: Record<string, unknown> | undefined;
+    revocationauthority: string;
+    recoveryauthority: string;
+    privateaddress?: string | undefined;
+    timelock?: number | undefined;
+    [key: string]: unknown;
+}
+export interface GetIdentityResult {
+    fullyqualifiedname?: string | undefined;
+    friendlyname?: string | undefined;
+    identity: IdentityDefinition;
+    /** "active" | "revoked" — daemon-reported lifecycle state. */
+    status?: string | undefined;
+    canspendfor?: boolean | undefined;
+    cansignfor?: boolean | undefined;
+    blockheight?: number | undefined;
+    txid?: string | undefined;
+    vout?: number | undefined;
+    [key: string]: unknown;
+}
+export interface GetIdentityOptions {
+    /** `name@` or i-address. */
+    nameOrAddress: string;
+    /** Return the identity as of this height (default: current). */
+    height?: number;
+    /** Include a transaction proof. */
+    txProof?: boolean;
+    /** Height for which to return the proof. */
+    txProofHeight?: number;
+}
+export interface GetIdentityContentOptions {
+    nameOrAddress: string;
+    heightStart?: number;
+    heightEnd?: number;
+    txProofs?: boolean;
+    txProofHeight?: number;
+    /** Restrict contentmultimap to this VDXF key. */
+    vdxfKey?: string;
+}
+export interface GetIdentityHistoryOptions {
+    nameOrAddress: string;
+    heightStart?: number;
+    heightEnd?: number;
+    txProofs?: boolean;
+    txProofHeight?: number;
+}
+export interface IdentityHistoryEntry {
+    blockhash?: string | undefined;
+    height: number;
+    /** Raw outpoint info (txid/voutnum) — passthrough. */
+    output?: unknown;
+    identity: IdentityDefinition;
+    [key: string]: unknown;
+}
+export interface GetIdentityHistoryResult {
+    fullyqualifiedname?: string | undefined;
+    friendlyname?: string | undefined;
+    status?: string | undefined;
+    canspendfor?: boolean | undefined;
+    cansignfor?: boolean | undefined;
+    blockheight?: number | undefined;
+    history: IdentityHistoryEntry[];
+    [key: string]: unknown;
+}
+export interface ListIdentitiesOptions {
+    includeCanSpend?: boolean;
+    includeCanSign?: boolean;
+    includeWatchOnly?: boolean;
+}
+/** Query object for the getidentitieswith* index methods. */
+export interface IdentitiesByAddressQuery {
+    address: string;
+    fromHeight?: number;
+    toHeight?: number;
+    /** Only identities whose defining output is unspent. */
+    unspent?: boolean;
+}
+export interface IdentitiesByAuthorityQuery {
+    identityId: string;
+    fromHeight?: number;
+    toHeight?: number;
+    unspent?: boolean;
+}
+/**
+ * Flat identity entry returned by the getidentitieswith* index methods —
+ * the definition itself, not wrapped in `{identity: …}`.
+ */
+export type IndexedIdentity = IdentityDefinition;
+/** Identity JSON accepted by register/update/recover — daemon field names. */
+export interface IdentitySpec {
+    name: string;
+    parent?: string;
+    primaryaddresses?: string[];
+    minimumsignatures?: number;
+    revocationauthority?: string;
+    recoveryauthority?: string;
+    privateaddress?: string;
+    contentmap?: Record<string, string>;
+    contentmultimap?: Record<string, unknown>;
+    timelock?: number;
+    version?: number;
+    flags?: number;
+    [key: string]: unknown;
+}
+export interface RegisterNameCommitmentOptions {
+    /** Name to commit, without parent suffix (`"myname"`). */
+    name: string;
+    /** Transparent address that controls the commitment. */
+    controlAddress: string;
+    /** Identity that referred the registration (fee discount). */
+    referralIdentity?: string;
+    /** Parent name/currency for sub-ID registration (default: current chain). */
+    parent?: string;
+    /** Address/identity that funds the commitment. */
+    sourceOfFunds?: string;
+}
+export interface NameReservation {
+    name: string;
+    salt: string;
+    version?: number | undefined;
+    referral?: string | undefined;
+    parent?: string | undefined;
+    nameid?: string | undefined;
+    [key: string]: unknown;
+}
+export interface NameCommitmentResult {
+    txid: string;
+    namereservation: NameReservation;
+    [key: string]: unknown;
+}
+export interface RegisterIdentityOptions {
+    /** Commitment txid from `registerNameCommitment`. */
+    txid: string;
+    /** Reservation from `registerNameCommitment`, verbatim. */
+    namereservation: NameReservation;
+    identity: IdentitySpec;
+    /** Return the raw tx hex instead of broadcasting. */
+    returnTx?: boolean;
+    /** Registration fee offer — bigint sats. */
+    feeOffer?: bigint;
+    sourceOfFunds?: string;
+}
+export interface UpdateIdentityOptions {
+    /** Full identity JSON (typically a modified `getidentity` result's `identity`). */
+    identity: IdentitySpec;
+    returnTx?: boolean;
+    /** Sub-ID on a token-managed currency. */
+    tokenUpdate?: boolean;
+    feeOffer?: bigint;
+    sourceOfFunds?: string;
+}
+export interface RevokeIdentityOptions {
+    nameOrId: string;
+    returnTx?: boolean;
+    tokenRevoke?: boolean;
+    feeOffer?: bigint;
+    sourceOfFunds?: string;
+}
+export interface RecoverIdentityOptions {
+    /** New identity JSON signed by the recovery authority. */
+    identity: IdentitySpec;
+    returnTx?: boolean;
+    tokenRecover?: boolean;
+    feeOffer?: bigint;
+    sourceOfFunds?: string;
+}
+export interface SetIdentityTimelockOptions {
+    nameOrId: string;
+    /** Absolute block height to unlock at… */
+    unlockAtBlock?: number;
+    /** …or a delay (blocks) applied when unlock is requested. */
+    setUnlockDelay?: number;
+    returnTx?: boolean;
+    feeOffer?: bigint;
+    sourceOfFunds?: string;
+}
+export interface RegisterIdentityFlowOptions {
+    name: string;
+    controlAddress: string;
+    referralIdentity?: string;
+    parent?: string;
+    /** Overrides for the registered identity (defaults derive from name/controlAddress). */
+    identity?: Partial<IdentitySpec>;
+    feeOffer?: bigint;
+    sourceOfFunds?: string;
+    /** Poll interval while waiting for the commitment to confirm. Default 5s. */
+    pollIntervalMs?: number;
+    /** Deadline for the commitment confirmation. Default 10 min. */
+    confirmationTimeoutMs?: number;
+}
+export interface RegisterIdentityFlowResult {
+    commitment: NameCommitmentResult;
+    registrationTxid: string;
+}
+export interface SignFileOptions {
+    signer: string;
+    /** Server-side file path. */
+    filename: string;
+    currentSignature?: string;
+}
+export declare function mapIdentityDefinition(raw: unknown, method: string, field: string): IdentityDefinition;
+export declare function mapIdentityResult(raw: unknown, method?: string): GetIdentityResult;
+/** Back-compat alias for the Etappe-1 export name. */
+export declare const mapGetIdentity: typeof mapIdentityResult;
+export declare function mapIdentityHistory(raw: unknown): GetIdentityHistoryResult;
+export declare function mapNameCommitment(raw: unknown): NameCommitmentResult;
+/** VerusID family — reads, lifecycle, and the guided registration flow. */
+export declare class IdentityApi {
+    private readonly transport;
+    constructor(transport: RpcTransport);
+    /** Look up a VerusID by `name@` or i-address. */
+    getIdentity(options: GetIdentityOptions): Promise<GetIdentityResult>;
+    /** Identity incl. aggregated contentmultimap over a height range. */
+    getIdentityContent(options: GetIdentityContentOptions): Promise<GetIdentityResult>;
+    /** Every historical state of an identity. */
+    getIdentityHistory(options: GetIdentityHistoryOptions): Promise<GetIdentityHistoryResult>;
+    /** Identities this wallet can spend/sign for. */
+    listIdentities(options?: ListIdentitiesOptions): Promise<GetIdentityResult[]>;
+    /** Identities containing an address in their primary addresses (index query). */
+    getIdentitiesWithAddress(query: IdentitiesByAddressQuery): Promise<IndexedIdentity[]>;
+    /** Identities that name this identity as revocation authority. */
+    getIdentitiesWithRevocation(query: IdentitiesByAuthorityQuery): Promise<IndexedIdentity[]>;
+    /** Identities that name this identity as recovery authority. */
+    getIdentitiesWithRecovery(query: IdentitiesByAuthorityQuery): Promise<IndexedIdentity[]>;
+    private identitiesByAuthority;
+    /** Step 1 of registration: commit to a name. Keep the result — it is required for step 2. */
+    registerNameCommitment(options: RegisterNameCommitmentOptions): Promise<NameCommitmentResult>;
+    /** Step 2 of registration: register the identity for a confirmed commitment. Returns the txid. */
+    registerIdentity(options: RegisterIdentityOptions): Promise<string>;
+    /** Update an identity (addresses, authorities, content, …). Returns the txid. */
+    updateIdentity(options: UpdateIdentityOptions): Promise<string>;
+    /** Revoke an identity — only its recovery authority can recover it. Returns the txid. */
+    revokeIdentity(options: RevokeIdentityOptions): Promise<string>;
+    /** Recover a revoked identity (signed by the recovery authority). Returns the txid. */
+    recoverIdentity(options: RecoverIdentityOptions): Promise<string>;
+    /** Timelock an identity (absolute unlock height or unlock delay). Returns the txid. */
+    setIdentityTimelock(options: SetIdentityTimelockOptions): Promise<string>;
+    private lifecycleCall;
+    /**
+     * Guided registration: commitment → wait for confirmation → register.
+     * Defaults: single-sig identity controlled by `controlAddress`.
+     * Throws `OperationTimeoutError` if the commitment does not confirm in time.
+     */
+    registerIdentityFlow(options: RegisterIdentityFlowOptions): Promise<RegisterIdentityFlowResult>;
+    /** Sign structured data/messages/hashes (daemon JSON options, passthrough). T2. */
+    signData(options: Record<string, unknown>): Promise<Record<string, unknown>>;
+    /** Sign a server-side file with an address or identity key. T2. */
+    signFile(options: SignFileOptions): Promise<Record<string, unknown>>;
+    /** Verify a file signature. T2. */
+    verifyFile(options: {
+        signer: string;
+        signature: string;
+        filename: string;
+        checkLatest?: boolean;
+    }): Promise<boolean>;
+    /** Verify a hash signature. T2. */
+    verifyHash(options: {
+        signer: string;
+        signature: string;
+        hash: string;
+        checkLatest?: boolean;
+    }): Promise<boolean>;
+    /** Verify structured-data signatures (daemon JSON options, passthrough). T2. */
+    verifySignature(options: Record<string, unknown>): Promise<Record<string, unknown>>;
+    /** Trust ratings this wallet keeps for identities. T2. */
+    getIdentityTrust(options?: {
+        identityIds?: string[];
+    }): Promise<Record<string, unknown>>;
+    /** Set/clear wallet-local identity trust ratings (daemon JSON options). T2. */
+    setIdentityTrust(options: Record<string, unknown>): Promise<void>;
+}
+//# sourceMappingURL=identity.d.ts.map

package/dist/methods/identity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../../src/methods/identity.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAIpD,qEAAqE;AACrE,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACjD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACtD,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,4BAA4B;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,4CAA4C;IAC5C,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iDAAiD;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,6DAA6D;AAC7D,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAAC;AAEjD,8EAA8E;AAC9E,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,6BAA6B;IAC5C,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,cAAc,EAAE,MAAM,CAAC;IACvB,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,6EAA6E;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,eAAe,CAAC;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,eAAe,EAAE,eAAe,CAAC;IACjC,QAAQ,EAAE,YAAY,CAAC;IACvB,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,mFAAmF;IACnF,QAAQ,EAAE,YAAY,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC,0DAA0D;IAC1D,QAAQ,EAAE,YAAY,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6DAA6D;IAC7D,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wFAAwF;IACxF,QAAQ,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6EAA6E;IAC7E,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gEAAgE;IAChE,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,oBAAoB,CAAC;IACjC,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAyBrG;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,SAAgB,GAAG,iBAAiB,CAczF;AAED,sDAAsD;AACtD,eAAO,MAAM,cAAc,0BAAoB,CAAC;AAEhD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,wBAAwB,CAuBzE;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,oBAAoB,CAgBpE;AAUD,2EAA2E;AAC3E,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,YAAY;IAKpD,iDAAiD;IAC3C,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAU1E,qEAAqE;IAC/D,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IASxF,6CAA6C;IACvC,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAS/F,iDAAiD;IAC3C,cAAc,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAUnF,iFAAiF;IAC3E,wBAAwB,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAS3F,kEAAkE;IAC5D,2BAA2B,CAAC,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAIhG,gEAAgE;IAC1D,yBAAyB,CAAC,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;YAIhF,qBAAqB;IAYnC,6FAA6F;IACvF,sBAAsB,CAAC,OAAO,EAAE,6BAA6B,GAAG,OAAO,CAAC,oBAAoB,CAAC;IASnG,kGAAkG;IAC5F,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBzE,iFAAiF;IAC3E,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIrE,yFAAyF;IACnF,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIrE,uFAAuF;IACjF,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvE,uFAAuF;IACjF,mBAAmB,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;YAsBjE,aAAa;IAe3B;;;;OAIG;IACG,oBAAoB,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,0BAA0B,CAAC;IA0CrG,mFAAmF;IAC7E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAIlF,mEAAmE;IAC7D,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAM1E,mCAAmC;IAC7B,UAAU,CAAC,OAAO,EAAE;QACxB,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,GAAG,OAAO,CAAC,OAAO,CAAC;IAMpB,mCAAmC;IAC7B,UAAU,CAAC,OAAO,EAAE;QACxB,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,GAAG,OAAO,CAAC,OAAO,CAAC;IAMpB,gFAAgF;IAC1E,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAIzF,0DAA0D;IACpD,gBAAgB,CAAC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAK9F,+EAA+E;IACzE,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGxE"}

package/dist/methods/identity.js

@@ -0,0 +1,333 @@
+import { formatAmount } from "../amount.js";
+import { OperationTimeoutError } from "../errors.js";
+import { LosslessNumber, toSafeNumbers } from "../lossless.js";
+import { expectArray, expectObject, mapBooleanOptional, mapInt, mapIntOptional, mapString, mapStringArray, mapStringOptional, withPassthrough, } from "../mapping.js";
+import { requestT2 } from "./t2.js";
+import { mapGetTransaction } from "./wallet.js";
+export function mapIdentityDefinition(raw, method, field) {
+    const obj = expectObject(raw, method);
+    const ctx = (name) => ({ method, field: `${field}.${name}` });
+    return withPassthrough(obj, {
+        version: mapInt(obj["version"], ctx("version")),
+        flags: mapInt(obj["flags"], ctx("flags")),
+        primaryaddresses: mapStringArray(obj["primaryaddresses"], ctx("primaryaddresses")),
+        minimumsignatures: mapInt(obj["minimumsignatures"], ctx("minimumsignatures")),
+        name: mapString(obj["name"], ctx("name")),
+        identityaddress: mapString(obj["identityaddress"], ctx("identityaddress")),
+        parent: mapString(obj["parent"], ctx("parent")),
+        systemid: mapString(obj["systemid"], ctx("systemid")),
+        contentmap: obj["contentmap"] === undefined || obj["contentmap"] === null
+            ? undefined
+            : toSafeNumbers(expectObject(obj["contentmap"], method)),
+        contentmultimap: obj["contentmultimap"] === undefined || obj["contentmultimap"] === null
+            ? undefined
+            : toSafeNumbers(expectObject(obj["contentmultimap"], method)),
+        revocationauthority: mapString(obj["revocationauthority"], ctx("revocationauthority")),
+        recoveryauthority: mapString(obj["recoveryauthority"], ctx("recoveryauthority")),
+        privateaddress: mapStringOptional(obj["privateaddress"], ctx("privateaddress")),
+        timelock: mapIntOptional(obj["timelock"], ctx("timelock")),
+    });
+}
+export function mapIdentityResult(raw, method = "getidentity") {
+    const obj = expectObject(raw, method);
+    const ctx = (field) => ({ method, field });
+    return withPassthrough(obj, {
+        fullyqualifiedname: mapStringOptional(obj["fullyqualifiedname"], ctx("fullyqualifiedname")),
+        friendlyname: mapStringOptional(obj["friendlyname"], ctx("friendlyname")),
+        identity: mapIdentityDefinition(obj["identity"], method, "identity"),
+        status: mapStringOptional(obj["status"], ctx("status")),
+        canspendfor: mapBooleanOptional(obj["canspendfor"], ctx("canspendfor")),
+        cansignfor: mapBooleanOptional(obj["cansignfor"], ctx("cansignfor")),
+        blockheight: mapIntOptional(obj["blockheight"], ctx("blockheight")),
+        txid: mapStringOptional(obj["txid"], ctx("txid")),
+        vout: mapIntOptional(obj["vout"], ctx("vout")),
+    });
+}
+/** Back-compat alias for the Etappe-1 export name. */
+export const mapGetIdentity = mapIdentityResult;
+export function mapIdentityHistory(raw) {
+    const method = "getidentityhistory";
+    const obj = expectObject(raw, method);
+    const ctx = (field) => ({ method, field });
+    const history = expectArray(obj["history"] ?? [], method, "history").map((item, i) => {
+        const entry = expectObject(item, method);
+        const ectx = (field) => ({ method, field: `history[${i}].${field}` });
+        return withPassthrough(entry, {
+            blockhash: mapStringOptional(entry["blockhash"], ectx("blockhash")),
+            height: mapInt(entry["height"], ectx("height")),
+            output: entry["output"] === undefined ? undefined : toSafeNumbers(entry["output"]),
+            identity: mapIdentityDefinition(entry["identity"], method, `history[${i}].identity`),
+        });
+    });
+    return withPassthrough(obj, {
+        fullyqualifiedname: mapStringOptional(obj["fullyqualifiedname"], ctx("fullyqualifiedname")),
+        friendlyname: mapStringOptional(obj["friendlyname"], ctx("friendlyname")),
+        status: mapStringOptional(obj["status"], ctx("status")),
+        canspendfor: mapBooleanOptional(obj["canspendfor"], ctx("canspendfor")),
+        cansignfor: mapBooleanOptional(obj["cansignfor"], ctx("cansignfor")),
+        blockheight: mapIntOptional(obj["blockheight"], ctx("blockheight")),
+        history,
+    });
+}
+export function mapNameCommitment(raw) {
+    const method = "registernamecommitment";
+    const obj = expectObject(raw, method);
+    const reservation = expectObject(obj["namereservation"], method);
+    const rctx = (field) => ({ method, field: `namereservation.${field}` });
+    return withPassthrough(obj, {
+        txid: mapString(obj["txid"], { method, field: "txid" }),
+        namereservation: withPassthrough(reservation, {
+            name: mapString(reservation["name"], rctx("name")),
+            salt: mapString(reservation["salt"], rctx("salt")),
+            version: mapIntOptional(reservation["version"], rctx("version")),
+            referral: mapStringOptional(reservation["referral"], rctx("referral")),
+            parent: mapStringOptional(reservation["parent"], rctx("parent")),
+            nameid: mapStringOptional(reservation["nameid"], rctx("nameid")),
+        }),
+    });
+}
+function feeParam(sats) {
+    return new LosslessNumber(formatAmount(sats));
+}
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+/** VerusID family — reads, lifecycle, and the guided registration flow. */
+export class IdentityApi {
+    transport;
+    constructor(transport) {
+        this.transport = transport;
+    }
+    // -------------------------------------------------------------------------
+    // T1 — reads
+    /** Look up a VerusID by `name@` or i-address. */
+    async getIdentity(options) {
+        const params = [options.nameOrAddress];
+        const needHeight = options.height !== undefined || options.txProof !== undefined || options.txProofHeight !== undefined;
+        if (needHeight)
+            params.push(options.height ?? 0);
+        if (options.txProof !== undefined || options.txProofHeight !== undefined)
+            params.push(options.txProof ?? false);
+        if (options.txProofHeight !== undefined)
+            params.push(options.txProofHeight);
+        return mapIdentityResult(await this.transport.request("getidentity", params));
+    }
+    /** Identity incl. aggregated contentmultimap over a height range. */
+    async getIdentityContent(options) {
+        const params = [options.nameOrAddress];
+        const opts = [options.heightStart, options.heightEnd, options.txProofs, options.txProofHeight, options.vdxfKey];
+        const defaults = [0, 0, false, 0, null];
+        const lastSet = opts.reduce((last, value, i) => (value === undefined ? last : i), -1);
+        for (let i = 0; i <= lastSet; i++)
+            params.push(opts[i] ?? defaults[i]);
+        return mapIdentityResult(await this.transport.request("getidentitycontent", params), "getidentitycontent");
+    }
+    /** Every historical state of an identity. */
+    async getIdentityHistory(options) {
+        const params = [options.nameOrAddress];
+        const opts = [options.heightStart, options.heightEnd, options.txProofs, options.txProofHeight];
+        const defaults = [0, 0, false, 0];
+        const lastSet = opts.reduce((last, value, i) => (value === undefined ? last : i), -1);
+        for (let i = 0; i <= lastSet; i++)
+            params.push(opts[i] ?? defaults[i]);
+        return mapIdentityHistory(await this.transport.request("getidentityhistory", params));
+    }
+    /** Identities this wallet can spend/sign for. */
+    async listIdentities(options) {
+        const params = [];
+        const opts = [options?.includeCanSpend, options?.includeCanSign, options?.includeWatchOnly];
+        const defaults = [true, true, false];
+        const lastSet = opts.reduce((last, value, i) => (value === undefined ? last : i), -1);
+        for (let i = 0; i <= lastSet; i++)
+            params.push(opts[i] ?? defaults[i]);
+        const result = expectArray(await this.transport.request("listidentities", params), "listidentities");
+        return result.map((item) => mapIdentityResult(item, "listidentities"));
+    }
+    /** Identities containing an address in their primary addresses (index query). */
+    async getIdentitiesWithAddress(query) {
+        const raw = { address: query.address };
+        if (query.fromHeight !== undefined)
+            raw["fromheight"] = query.fromHeight;
+        if (query.toHeight !== undefined)
+            raw["toheight"] = query.toHeight;
+        if (query.unspent !== undefined)
+            raw["unspent"] = query.unspent;
+        const result = expectArray(await this.transport.request("getidentitieswithaddress", [raw]), "getidentitieswithaddress");
+        return result.map((item, i) => mapIdentityDefinition(item, "getidentitieswithaddress", `[${i}]`));
+    }
+    /** Identities that name this identity as revocation authority. */
+    async getIdentitiesWithRevocation(query) {
+        return this.identitiesByAuthority("getidentitieswithrevocation", query);
+    }
+    /** Identities that name this identity as recovery authority. */
+    async getIdentitiesWithRecovery(query) {
+        return this.identitiesByAuthority("getidentitieswithrecovery", query);
+    }
+    async identitiesByAuthority(method, query) {
+        const raw = { identityid: query.identityId };
+        if (query.fromHeight !== undefined)
+            raw["fromheight"] = query.fromHeight;
+        if (query.toHeight !== undefined)
+            raw["toheight"] = query.toHeight;
+        if (query.unspent !== undefined)
+            raw["unspent"] = query.unspent;
+        const result = expectArray(await this.transport.request(method, [raw]), method);
+        return result.map((item, i) => mapIdentityDefinition(item, method, `[${i}]`));
+    }
+    // -------------------------------------------------------------------------
+    // T1 — lifecycle
+    /** Step 1 of registration: commit to a name. Keep the result — it is required for step 2. */
+    async registerNameCommitment(options) {
+        const params = [options.name, options.controlAddress];
+        const opts = [options.referralIdentity, options.parent, options.sourceOfFunds];
+        const lastSet = opts.reduce((last, value, i) => (value === undefined ? last : i), -1);
+        // Skipped middle positions are sent as JSON null (daemon treats null as "not provided").
+        for (let i = 0; i <= lastSet; i++)
+            params.push(opts[i] ?? null);
+        return mapNameCommitment(await this.transport.request("registernamecommitment", params));
+    }
+    /** Step 2 of registration: register the identity for a confirmed commitment. Returns the txid. */
+    async registerIdentity(options) {
+        const first = {
+            txid: options.txid,
+            namereservation: options.namereservation,
+            identity: options.identity,
+        };
+        const params = [first];
+        const opts = [
+            options.returnTx,
+            options.feeOffer === undefined ? undefined : feeParam(options.feeOffer),
+            options.sourceOfFunds,
+        ];
+        const lastSet = opts.reduce((last, value, i) => (value === undefined ? last : i), -1);
+        for (let i = 0; i <= lastSet; i++)
+            params.push(opts[i] ?? (i === 0 ? false : null));
+        return mapString(await this.transport.request("registeridentity", params), {
+            method: "registeridentity",
+            field: "(result)",
+        });
+    }
+    /** Update an identity (addresses, authorities, content, …). Returns the txid. */
+    async updateIdentity(options) {
+        return this.lifecycleCall("updateidentity", options.identity, options.returnTx, options.tokenUpdate, options.feeOffer, options.sourceOfFunds);
+    }
+    /** Revoke an identity — only its recovery authority can recover it. Returns the txid. */
+    async revokeIdentity(options) {
+        return this.lifecycleCall("revokeidentity", options.nameOrId, options.returnTx, options.tokenRevoke, options.feeOffer, options.sourceOfFunds);
+    }
+    /** Recover a revoked identity (signed by the recovery authority). Returns the txid. */
+    async recoverIdentity(options) {
+        return this.lifecycleCall("recoveridentity", options.identity, options.returnTx, options.tokenRecover, options.feeOffer, options.sourceOfFunds);
+    }
+    /** Timelock an identity (absolute unlock height or unlock delay). Returns the txid. */
+    async setIdentityTimelock(options) {
+        if ((options.unlockAtBlock === undefined) === (options.setUnlockDelay === undefined)) {
+            throw new TypeError("setIdentityTimelock: exactly one of unlockAtBlock / setUnlockDelay is required");
+        }
+        const lockSpec = options.unlockAtBlock !== undefined
+            ? { unlockatblock: options.unlockAtBlock }
+            : { setunlockdelay: options.setUnlockDelay };
+        const params = [options.nameOrId, lockSpec];
+        const opts = [
+            options.returnTx,
+            options.feeOffer === undefined ? undefined : feeParam(options.feeOffer),
+            options.sourceOfFunds,
+        ];
+        const lastSet = opts.reduce((last, value, i) => (value === undefined ? last : i), -1);
+        for (let i = 0; i <= lastSet; i++)
+            params.push(opts[i] ?? (i === 0 ? false : null));
+        return mapString(await this.transport.request("setidentitytimelock", params), {
+            method: "setidentitytimelock",
+            field: "(result)",
+        });
+    }
+    async lifecycleCall(method, first, returnTx, tokenFlag, feeOffer, sourceOfFunds) {
+        const params = [first];
+        const opts = [returnTx, tokenFlag, feeOffer === undefined ? undefined : feeParam(feeOffer), sourceOfFunds];
+        const lastSet = opts.reduce((last, value, i) => (value === undefined ? last : i), -1);
+        for (let i = 0; i <= lastSet; i++)
+            params.push(opts[i] ?? (i <= 1 ? false : null));
+        return mapString(await this.transport.request(method, params), { method, field: "(result)" });
+    }
+    /**
+     * Guided registration: commitment → wait for confirmation → register.
+     * Defaults: single-sig identity controlled by `controlAddress`.
+     * Throws `OperationTimeoutError` if the commitment does not confirm in time.
+     */
+    async registerIdentityFlow(options) {
+        const interval = options.pollIntervalMs ?? 5_000;
+        const timeout = options.confirmationTimeoutMs ?? 600_000;
+        const commitment = await this.registerNameCommitment({
+            name: options.name,
+            controlAddress: options.controlAddress,
+            ...(options.referralIdentity !== undefined ? { referralIdentity: options.referralIdentity } : {}),
+            ...(options.parent !== undefined ? { parent: options.parent } : {}),
+            ...(options.sourceOfFunds !== undefined ? { sourceOfFunds: options.sourceOfFunds } : {}),
+        });
+        const deadline = Date.now() + timeout;
+        for (;;) {
+            const tx = mapGetTransaction(await this.transport.request("gettransaction", [commitment.txid]));
+            if (tx.confirmations >= 1)
+                break;
+            const remaining = deadline - Date.now();
+            if (remaining <= 0) {
+                throw new OperationTimeoutError(commitment.txid, timeout);
+            }
+            await sleep(Math.min(interval, remaining));
+        }
+        const registrationTxid = await this.registerIdentity({
+            txid: commitment.txid,
+            namereservation: commitment.namereservation,
+            identity: {
+                name: options.name,
+                primaryaddresses: [options.controlAddress],
+                minimumsignatures: 1,
+                ...options.identity,
+            },
+            ...(options.feeOffer !== undefined ? { feeOffer: options.feeOffer } : {}),
+            ...(options.sourceOfFunds !== undefined ? { sourceOfFunds: options.sourceOfFunds } : {}),
+        });
+        return { commitment, registrationTxid };
+    }
+    // -------------------------------------------------------------------------
+    // T2 — signatures, trust, data
+    /** Sign structured data/messages/hashes (daemon JSON options, passthrough). T2. */
+    async signData(options) {
+        return requestT2(this.transport, "signdata", [options]);
+    }
+    /** Sign a server-side file with an address or identity key. T2. */
+    async signFile(options) {
+        const params = [options.signer, options.filename];
+        if (options.currentSignature !== undefined)
+            params.push(options.currentSignature);
+        return requestT2(this.transport, "signfile", params);
+    }
+    /** Verify a file signature. T2. */
+    async verifyFile(options) {
+        const params = [options.signer, options.signature, options.filename];
+        if (options.checkLatest !== undefined)
+            params.push(options.checkLatest);
+        return requestT2(this.transport, "verifyfile", params);
+    }
+    /** Verify a hash signature. T2. */
+    async verifyHash(options) {
+        const params = [options.signer, options.signature, options.hash];
+        if (options.checkLatest !== undefined)
+            params.push(options.checkLatest);
+        return requestT2(this.transport, "verifyhash", params);
+    }
+    /** Verify structured-data signatures (daemon JSON options, passthrough). T2. */
+    async verifySignature(options) {
+        return requestT2(this.transport, "verifysignature", [options]);
+    }
+    /** Trust ratings this wallet keeps for identities. T2. */
+    async getIdentityTrust(options) {
+        const params = options?.identityIds === undefined ? [] : [{ identities: options.identityIds }];
+        return requestT2(this.transport, "getidentitytrust", params);
+    }
+    /** Set/clear wallet-local identity trust ratings (daemon JSON options). T2. */
+    async setIdentityTrust(options) {
+        await this.transport.request("setidentitytrust", [options]);
+    }
+}
+//# sourceMappingURL=identity.js.map