Open Cap Table Protocol Canton SDK - v0.2.239
    Preparing search index...

    Interface ValidatorApiClient

    Client for interacting with Canton's ValidatorApi

    interface ValidatorApiClient {
        acceptTransferOffer: (
            params: { contractId: string },
        ) => Promise<{ accepted_offer_contract_id: string }>;
        apiType: ApiType;
        authManager: AuthenticationManager;
        clientConfig: ClientConfig;
        config: PartialProviderConfig;
        createAnsEntry: (
            params: { description: string; name: string; url: string },
        ) => Promise<
            {
                description: string;
                entryContextCid: any;
                name: string;
                subscriptionRequestCid: any;
                url: string;
            },
        >;
        createBuyTrafficRequest: (
            params: {
                receiving_validator_party_id?: string;
                traffic_amount: number;
            },
        ) => Promise<{ request_contract_id: string }>;
        createTokenStandardTransfer: (
            params: {
                amount: string;
                description: string;
                expires_at: number;
                receiver_party_id: string;
                tracking_id: string;
            },
        ) => Promise<
            {
                meta: { [key: string]: string };
                output: any;
                sender_change_cids: string[];
            },
        >;
        createTransferOffer: (
            params: {
                amount: string;
                description: string;
                expires_at: number;
                receiver_party_id: string;
                tracking_id: string;
            },
        ) => Promise<{ offer_contract_id: string }>;
        createUser: (
            params: {
                createPartyIfMissing?: boolean;
                name: string;
                party_id?: string;
            },
        ) => Promise<{ party_id: string }>;
        dumpParticipantIdentities: () => Promise<
            {
                authorizedStoreSnapshot: string;
                id: string;
                keys: any[];
                version?: string;
            },
        >;
        generateExternalPartyTopology: (
            params: { party_hint: string; public_key: string },
        ) => Promise<{ party_id: string; topology_txs: any[] }>;
        getAllocationCancelContext: (
            params: {
                allocationId: string;
                excludeDebugFields?: boolean;
                meta?: Record<string, string>;
            },
        ) => Promise<
            {
                choiceContextData: Record<string, never>;
                disclosedContracts: {
                    contractId: string;
                    createdEventBlob: string;
                    debugCreatedAt?: string;
                    debugPackageName?: string;
                    debugPayload?: Record<string, never>;
                    synchronizerId: string;
                    templateId: string;
                }[];
            },
        >;
        getAllocationFactory: (
            params: {
                choiceArguments: Record<
                    string,
                    | string
                    | number
                    | boolean
                    | (
                        | string
                        | number
                        | boolean
                        | (string | number | boolean | (...)[] | { [key: ...]: ... } | null)[]
                        | { [key: string]: any }
                        | null
                    )[]
                    | { [key: string]: any }
                    | null,
                >;
                excludeDebugFields?: boolean;
            },
        ) => Promise<
            {
                choiceContext: {
                    choiceContextData: Record<string, never>;
                    disclosedContracts: {
                        contractId: string;
                        createdEventBlob: string;
                        debugCreatedAt?: string;
                        debugPackageName?: string;
                        debugPayload?: Record<string, never>;
                        synchronizerId: string;
                        templateId: string;
                    }[];
                };
                factoryId: string;
            },
        >;
        getAllocationTransferContext: (
            params: {
                allocationId: string;
                excludeDebugFields?: boolean;
                meta?: Record<string, string>;
            },
        ) => Promise<
            {
                choiceContextData: Record<string, never>;
                disclosedContracts: {
                    contractId: string;
                    createdEventBlob: string;
                    debugCreatedAt?: string;
                    debugPackageName?: string;
                    debugPayload?: Record<string, never>;
                    synchronizerId: string;
                    templateId: string;
                }[];
            },
        >;
        getAllocationWithdrawContext: (
            params: {
                allocationId: string;
                excludeDebugFields?: boolean;
                meta?: Record<string, string>;
            },
        ) => Promise<
            {
                choiceContextData: Record<string, never>;
                disclosedContracts: {
                    contractId: string;
                    createdEventBlob: string;
                    debugCreatedAt?: string;
                    debugPackageName?: string;
                    debugPayload?: Record<string, never>;
                    synchronizerId: string;
                    templateId: string;
                }[];
            },
        >;
        getAmuletRules: () => Promise<
            {
                amulet_rules: {
                    contract: {
                        contract_id: string;
                        created_at: string;
                        created_event_blob: string;
                        payload: Record<
                            string,
                            | string
                            | number
                            | boolean
                            | (string | number | boolean | (...)[] | { [key: ...]: ... } | null)[]
                            | { [key: string]: any }
                            | null,
                        >;
                        template_id: string;
                    };
                    domain_id: string;
                };
            },
        >;
        getAmulets: () => Promise<
            {
                amulets: {
                    accrued_holding_fee: string;
                    contract: {
                        contract: {
                            contract_id: string;
                            created_at: string;
                            created_event_blob: string;
                            payload: Record<
                                string,
                                string
                                | number
                                | boolean
                                | (...)[]
                                | { [key: string]: any }
                                | null,
                            >;
                            template_id: string;
                        };
                        domain_id: string;
                    };
                    effective_amount: string;
                    round: number;
                }[];
                locked_amulets: {
                    accrued_holding_fee: string;
                    contract: {
                        contract: {
                            contract_id: string;
                            created_at: string;
                            created_event_blob: string;
                            payload: Record<
                                string,
                                string
                                | number
                                | boolean
                                | (...)[]
                                | { [key: string]: any }
                                | null,
                            >;
                            template_id: string;
                        };
                        domain_id: string;
                    };
                    effective_amount: string;
                    round: number;
                }[];
            },
        >;
        getAnsRules: (
            params: {
                cached_ans_rules_contract_id?: any;
                cached_ans_rules_domain_id?: string;
            },
        ) => Promise<{ ans_rules_update: any }>;
        getBuyTrafficRequestStatus: (
            params: { trackingId: string },
        ) => Promise<
            {
                failure_reason?: "expired"
                | "rejected";
                rejection_reason?: string;
                status: "created" | "failed" | "completed";
                transaction_id?: string;
            },
        >;
        getDsoPartyId: () => Promise<{ dso_party_id: string }>;
        getExternalPartyBalance: (
            params: { partyId: string },
        ) => Promise<
            {
                accumulated_holding_fees_locked: string;
                accumulated_holding_fees_total: string;
                accumulated_holding_fees_unlocked: string;
                computed_as_of_round: number;
                party_id: string;
                total_available_coin: string;
                total_coin_holdings: string;
                total_locked_coin: string;
                total_unlocked_coin: string;
            },
        >;
        getInstrument: (
            params: { instrumentId: string },
        ) => Promise<
            {
                decimals: number;
                id: string;
                name: string;
                supportedApis: { [key: string]: number };
                symbol: string;
                totalSupply?: string;
                totalSupplyAsOf?: string;
            },
        >;
        getMemberTrafficStatus: (
            params: { domainId?: string; memberId?: string } | undefined,
        ) => Promise<operations>;
        getMiningRoundDetails: (
            params: { roundNumber: number },
        ) => Promise<
            {
                mining_round: {
                    effective_at: string;
                    issuance_per_featured_app_reward_coupon: string;
                    issuance_per_unfeatured_app_reward_coupon: string;
                    round_number: number;
                    status: "open"
                    | "issuing"
                    | "closed";
                };
            },
        >;
        getOpenAndIssuingMiningRounds: () => Promise<
            {
                issuing_mining_rounds: { contract_id: string; round_number: number }[];
                open_mining_rounds: {
                    contract: {
                        contract_id: string;
                        created_event_blob: string;
                        payload: { opensAt: string; round_number: number };
                        template_id: string;
                    };
                    domain_id: string;
                }[];
            },
        >;
        getRegistryInfo: () => Promise<
            { adminId: string; supportedApis: { [key: string]: number } },
        >;
        getTransferFactory: (
            params: {
                choiceArguments: Record<
                    string,
                    | string
                    | number
                    | boolean
                    | (
                        | string
                        | number
                        | boolean
                        | (string | number | boolean | (...)[] | { [key: ...]: ... } | null)[]
                        | { [key: string]: any }
                        | null
                    )[]
                    | { [key: string]: any }
                    | null,
                >;
                excludeDebugFields?: boolean;
            },
        ) => Promise<
            {
                choiceContext: {
                    choiceContextData: Record<string, never>;
                    disclosedContracts: {
                        contractId: string;
                        createdEventBlob: string;
                        debugCreatedAt?: string;
                        debugPackageName?: string;
                        debugPayload?: Record<string, never>;
                        synchronizerId: string;
                        templateId: string;
                    }[];
                };
                factoryId: string;
                transferKind: "self"
                | "direct"
                | "offer";
            },
        >;
        getTransferInstructionAcceptContext: (
            params: {
                excludeDebugFields?: boolean;
                meta?: Record<string, string>;
                transferInstructionId: string;
            },
        ) => Promise<
            {
                choiceContextData: Record<string, never>;
                disclosedContracts: {
                    contractId: string;
                    createdEventBlob: string;
                    debugCreatedAt?: string;
                    debugPackageName?: string;
                    debugPayload?: Record<string, never>;
                    synchronizerId: string;
                    templateId: string;
                }[];
            },
        >;
        getTransferInstructionRejectContext: (
            params: {
                excludeDebugFields?: boolean;
                meta?: Record<string, string>;
                transferInstructionId: string;
            },
        ) => Promise<
            {
                choiceContextData: Record<string, never>;
                disclosedContracts: {
                    contractId: string;
                    createdEventBlob: string;
                    debugCreatedAt?: string;
                    debugPackageName?: string;
                    debugPayload?: Record<string, never>;
                    synchronizerId: string;
                    templateId: string;
                }[];
            },
        >;
        getTransferInstructionWithdrawContext: (
            params: {
                excludeDebugFields?: boolean;
                meta?: Record<string, string>;
                transferInstructionId: string;
            },
        ) => Promise<
            {
                choiceContextData: Record<string, never>;
                disclosedContracts: {
                    contractId: string;
                    createdEventBlob: string;
                    debugCreatedAt?: string;
                    debugPackageName?: string;
                    debugPayload?: Record<string, never>;
                    synchronizerId: string;
                    templateId: string;
                }[];
            },
        >;
        getTransferOfferStatus: (
            params: { trackingId: string },
        ) => Promise<
            {
                contract_id?: string;
                failure_kind?: "expired"
                | "rejected"
                | "withdrawn";
                status: "created" | "failed" | "completed" | "accepted";
                transaction_id?: string;
                withdrawn_reason?: string;
            },
        >;
        getUserStatus: () => Promise<
            {
                has_featured_app_right: boolean;
                party_id: string;
                user_onboarded: boolean;
                user_wallet_installed: boolean;
            },
        >;
        getValidatorUserInfo: () => Promise<GetValidatorUserInfoResponse>;
        getWalletBalance: () => Promise<
            {
                effective_locked_qty: string;
                effective_unlocked_qty: string;
                round: number;
                total_holding_fees: string;
            },
        >;
        httpClient: HttpClient;
        listAnsEntries: () => Promise<{ entries: any[] }>;
        listExternalPartySetupProposals: () => Promise<{ contracts: any[] }>;
        listInstruments: (
            params: { pageSize?: number; pageToken?: string },
        ) => Promise<
            {
                instruments: {
                    decimals: number;
                    id: string;
                    name: string;
                    supportedApis: { [key: string]: number };
                    symbol: string;
                    totalSupply?: string;
                    totalSupplyAsOf?: string;
                }[];
                nextPageToken?: string;
            },
        >;
        listTokenStandardTransfers: () => Promise<{ transfers: any[] }>;
        listTransferOffers: () => Promise<
            {
                offers: {
                    amount: string;
                    contract_id: string;
                    description: string;
                    expires_at: number;
                    receiver_party_id: string;
                    status?: string;
                    tracking_id: string;
                    [x: string]: unknown;
                }[];
            },
        >;
        listUsers: () => Promise<{ usernames: string[] }>;
        lookupAnsEntryByName: (params: { name: string }) => Promise<{ entry: any }>;
        lookupAnsEntryByParty: (
            params: { party: string },
        ) => Promise<{ entry: any }>;
        lookupFeaturedAppRight: (
            params: { partyId: string },
        ) => Promise<{ featured_app_right?: any }>;
        lookupTransferCommandCounterByParty: (
            params: { party: string },
        ) => Promise<{ counter: number }>;
        lookupTransferCommandStatus: (
            params: { nonce: number; sender: string },
        ) => Promise<{ status: string }>;
        lookupTransferPreapprovalByParty: (
            params: { partyId: string },
        ) => Promise<
            {
                transfer_preapproval: {
                    contract: {
                        contract_id: string;
                        created_at?: string;
                        created_event_blob: string;
                        payload: Record<
                            string,
                            | string
                            | number
                            | boolean
                            | (string | number | boolean | (...)[] | { [key: ...]: ... } | null)[]
                            | { [key: string]: any }
                            | null,
                        >;
                        template_id: string;
                    };
                    domain_id: string;
                };
            },
        >;
        registerNewUser: () => Promise<{ party_id: string }>;
        rejectTransferOffer: (
            params: { contractId: string },
        ) => Promise<{ rejected_offer_contract_id: string }>;
        submitExternalPartyTopology: (
            params: { public_key: string; signed_topology_txs: any[] },
        ) => Promise<{ party_id: string }>;
        withdrawTransferOffer: (
            params: { contractId: string },
        ) => Promise<{ withdrawn_offer_contract_id: string }>;
        authenticate(): Promise<string>;
        buildPartyList(additionalParties?: readonly string[]): string[];
        clearToken(): void;
        getApiType(): ApiType;
        getApiUrl(): string;
        getAuthUrl(): string;
        getLogger(): Logger | undefined;
        getManagedParties(): readonly string[];
        getNetwork(): NetworkType;
        getPartyId(): PartyId;
        getProvider(): string | undefined;
        getProviderName(): string;
        getTokenExpiryTime(): number | null;
        getTokenIssuedAt(): number | null;
        getTokenLifetimeMs(): number | null;
        getUserId(): UserId | undefined;
        makeDeleteRequest<T>(url: string, config?: RequestConfig): Promise<T>;
        makeGetRequest<T>(url: string, config?: RequestConfig): Promise<T>;
        makePatchRequest<T>(
            url: string,
            data: unknown,
            config?: RequestConfig,
        ): Promise<T>;
        makePostRequest<T>(
            url: string,
            data: unknown,
            config?: RequestConfig,
        ): Promise<T>;
        setPartyId(partyId: string | PartyId): void;
    }

    Hierarchy

    • BaseClient
      • ValidatorApiClient
    Index

    Properties

    acceptTransferOffer apiType authManager clientConfig config createAnsEntry createBuyTrafficRequest createTokenStandardTransfer createTransferOffer createUser dumpParticipantIdentities generateExternalPartyTopology getAllocationCancelContext getAllocationFactory getAllocationTransferContext getAllocationWithdrawContext getAmuletRules getAmulets getAnsRules getBuyTrafficRequestStatus getDsoPartyId getExternalPartyBalance getInstrument getMemberTrafficStatus getMiningRoundDetails getOpenAndIssuingMiningRounds getRegistryInfo getTransferFactory getTransferInstructionAcceptContext getTransferInstructionRejectContext getTransferInstructionWithdrawContext getTransferOfferStatus getUserStatus getValidatorUserInfo getWalletBalance httpClient listAnsEntries listExternalPartySetupProposals listInstruments listTokenStandardTransfers listTransferOffers listUsers lookupAnsEntryByName lookupAnsEntryByParty lookupFeaturedAppRight lookupTransferCommandCounterByParty lookupTransferCommandStatus lookupTransferPreapprovalByParty registerNewUser rejectTransferOffer submitExternalPartyTopology withdrawTransferOffer

    Methods

    authenticate buildPartyList clearToken getApiType getApiUrl getAuthUrl getLogger getManagedParties getNetwork getPartyId getProvider getProviderName getTokenExpiryTime getTokenIssuedAt getTokenLifetimeMs getUserId makeDeleteRequest makeGetRequest makePatchRequest makePostRequest setPartyId

    Properties

    acceptTransferOffer: (
        params: { contractId: string },
    ) => Promise<{ accepted_offer_contract_id: string }>

    Accept a transfer offer by contract ID

    apiType: ApiType
    authManager: AuthenticationManager
    clientConfig: ClientConfig
    config: PartialProviderConfig
    createAnsEntry: (
        params: { description: string; name: string; url: string },
    ) => Promise<
        {
            description: string;
            entryContextCid: any;
            name: string;
            subscriptionRequestCid: any;
            url: string;
        },
    >

    Create a new ANS entry

    createBuyTrafficRequest: (
        params: {
            receiving_validator_party_id?: string;
            traffic_amount: number;
        },
    ) => Promise<{ request_contract_id: string }>

    Create a new buy traffic request to purchase traffic from another validator

    createTokenStandardTransfer: (
        params: {
            amount: string;
            description: string;
            expires_at: number;
            receiver_party_id: string;
            tracking_id: string;
        },
    ) => Promise<
        {
            meta: { [key: string]: string };
            output: any;
            sender_change_cids: string[];
        },
    >

    Create a new token standard transfer to send tokens to another party

    createTransferOffer: (
        params: {
            amount: string;
            description: string;
            expires_at: number;
            receiver_party_id: string;
            tracking_id: string;
        },
    ) => Promise<{ offer_contract_id: string }>

    Create a new transfer offer to send tokens to another party

    createUser: (
        params: {
            createPartyIfMissing?: boolean;
            name: string;
            party_id?: string;
        },
    ) => Promise<{ party_id: string }>

    Create a new user in the system

    dumpParticipantIdentities: () => Promise<
        {
            authorizedStoreSnapshot: string;
            id: string;
            keys: any[];
            version?: string;
        },
    >

    Dump all participant identities

    generateExternalPartyTopology: (
        params: { party_hint: string; public_key: string },
    ) => Promise<{ party_id: string; topology_txs: any[] }>

    Generate external party topology transactions

    getAllocationCancelContext: (
        params: {
            allocationId: string;
            excludeDebugFields?: boolean;
            meta?: Record<string, string>;
        },
    ) => Promise<
        {
            choiceContextData: Record<string, never>;
            disclosedContracts: {
                contractId: string;
                createdEventBlob: string;
                debugCreatedAt?: string;
                debugPackageName?: string;
                debugPayload?: Record<string, never>;
                synchronizerId: string;
                templateId: string;
            }[];
        },
    >

    Get the choice context to cancel an allocation

    getAllocationFactory: (
        params: {
            choiceArguments: Record<
                string,
                | string
                | number
                | boolean
                | (
                    | string
                    | number
                    | boolean
                    | (string | number | boolean | (...)[] | { [key: ...]: ... } | null)[]
                    | { [key: string]: any }
                    | null
                )[]
                | { [key: string]: any }
                | null,
            >;
            excludeDebugFields?: boolean;
        },
    ) => Promise<
        {
            choiceContext: {
                choiceContextData: Record<string, never>;
                disclosedContracts: {
                    contractId: string;
                    createdEventBlob: string;
                    debugCreatedAt?: string;
                    debugPackageName?: string;
                    debugPayload?: Record<string, never>;
                    synchronizerId: string;
                    templateId: string;
                }[];
            };
            factoryId: string;
        },
    >

    Get the factory and choice context for creating allocations using the AllocationFactory_Allocate choice

    getAllocationTransferContext: (
        params: {
            allocationId: string;
            excludeDebugFields?: boolean;
            meta?: Record<string, string>;
        },
    ) => Promise<
        {
            choiceContextData: Record<string, never>;
            disclosedContracts: {
                contractId: string;
                createdEventBlob: string;
                debugCreatedAt?: string;
                debugPackageName?: string;
                debugPayload?: Record<string, never>;
                synchronizerId: string;
                templateId: string;
            }[];
        },
    >

    Get the choice context to execute a transfer on an allocation

    getAllocationWithdrawContext: (
        params: {
            allocationId: string;
            excludeDebugFields?: boolean;
            meta?: Record<string, string>;
        },
    ) => Promise<
        {
            choiceContextData: Record<string, never>;
            disclosedContracts: {
                contractId: string;
                createdEventBlob: string;
                debugCreatedAt?: string;
                debugPackageName?: string;
                debugPayload?: Record<string, never>;
                synchronizerId: string;
                templateId: string;
            }[];
        },
    >

    Get the choice context to withdraw an allocation

    getAmuletRules: () => Promise<
        {
            amulet_rules: {
                contract: {
                    contract_id: string;
                    created_at: string;
                    created_event_blob: string;
                    payload: Record<
                        string,
                        | string
                        | number
                        | boolean
                        | (string | number | boolean | (...)[] | { [key: ...]: ... } | null)[]
                        | { [key: string]: any }
                        | null,
                    >;
                    template_id: string;
                };
                domain_id: string;
            };
        },
    >

    Get amulet rules

    getAmulets: () => Promise<
        {
            amulets: {
                accrued_holding_fee: string;
                contract: {
                    contract: {
                        contract_id: string;
                        created_at: string;
                        created_event_blob: string;
                        payload: Record<
                            string,
                            string
                            | number
                            | boolean
                            | (...)[]
                            | { [key: string]: any }
                            | null,
                        >;
                        template_id: string;
                    };
                    domain_id: string;
                };
                effective_amount: string;
                round: number;
            }[];
            locked_amulets: {
                accrued_holding_fee: string;
                contract: {
                    contract: {
                        contract_id: string;
                        created_at: string;
                        created_event_blob: string;
                        payload: Record<
                            string,
                            string
                            | number
                            | boolean
                            | (...)[]
                            | { [key: string]: any }
                            | null,
                        >;
                        template_id: string;
                    };
                    domain_id: string;
                };
                effective_amount: string;
                round: number;
            }[];
        },
    >

    Get the list of amulets and locked amulets for the current user

    getAnsRules: (
        params: {
            cached_ans_rules_contract_id?: any;
            cached_ans_rules_domain_id?: string;
        },
    ) => Promise<{ ans_rules_update: any }>

    Get ANS rules

    getBuyTrafficRequestStatus: (
        params: { trackingId: string },
    ) => Promise<
        {
            failure_reason?: "expired"
            | "rejected";
            rejection_reason?: string;
            status: "created" | "failed" | "completed";
            transaction_id?: string;
        },
    >

    Get the status of a buy traffic request by tracking ID

    getDsoPartyId: () => Promise<{ dso_party_id: string }>

    Get the DSO party ID

    getExternalPartyBalance: (
        params: { partyId: string },
    ) => Promise<
        {
            accumulated_holding_fees_locked: string;
            accumulated_holding_fees_total: string;
            accumulated_holding_fees_unlocked: string;
            computed_as_of_round: number;
            party_id: string;
            total_available_coin: string;
            total_coin_holdings: string;
            total_locked_coin: string;
            total_unlocked_coin: string;
        },
    >

    Get external party balance information

    getInstrument: (
        params: { instrumentId: string },
    ) => Promise<
        {
            decimals: number;
            id: string;
            name: string;
            supportedApis: { [key: string]: number };
            symbol: string;
            totalSupply?: string;
            totalSupplyAsOf?: string;
        },
    >

    Retrieve an instrument's metadata

    getMemberTrafficStatus: (
        params: { domainId?: string; memberId?: string } | undefined,
    ) => Promise<operations>

    Get a member's traffic status as reported by the sequencer

    getMiningRoundDetails: (
        params: { roundNumber: number },
    ) => Promise<
        {
            mining_round: {
                effective_at: string;
                issuance_per_featured_app_reward_coupon: string;
                issuance_per_unfeatured_app_reward_coupon: string;
                round_number: number;
                status: "open"
                | "issuing"
                | "closed";
            };
        },
    >

    Get details for a specific mining round

    getOpenAndIssuingMiningRounds: () => Promise<
        {
            issuing_mining_rounds: { contract_id: string; round_number: number }[];
            open_mining_rounds: {
                contract: {
                    contract_id: string;
                    created_event_blob: string;
                    payload: { opensAt: string; round_number: number };
                    template_id: string;
                };
                domain_id: string;
            }[];
        },
    >

    Get open and issuing mining rounds

    getRegistryInfo: () => Promise<
        { adminId: string; supportedApis: { [key: string]: number } },
    >

    Get information about the registry including supported standards

    getTransferFactory: (
        params: {
            choiceArguments: Record<
                string,
                | string
                | number
                | boolean
                | (
                    | string
                    | number
                    | boolean
                    | (string | number | boolean | (...)[] | { [key: ...]: ... } | null)[]
                    | { [key: string]: any }
                    | null
                )[]
                | { [key: string]: any }
                | null,
            >;
            excludeDebugFields?: boolean;
        },
    ) => Promise<
        {
            choiceContext: {
                choiceContextData: Record<string, never>;
                disclosedContracts: {
                    contractId: string;
                    createdEventBlob: string;
                    debugCreatedAt?: string;
                    debugPackageName?: string;
                    debugPayload?: Record<string, never>;
                    synchronizerId: string;
                    templateId: string;
                }[];
            };
            factoryId: string;
            transferKind: "self"
            | "direct"
            | "offer";
        },
    >

    Get the factory and choice context for executing a direct transfer

    getTransferInstructionAcceptContext: (
        params: {
            excludeDebugFields?: boolean;
            meta?: Record<string, string>;
            transferInstructionId: string;
        },
    ) => Promise<
        {
            choiceContextData: Record<string, never>;
            disclosedContracts: {
                contractId: string;
                createdEventBlob: string;
                debugCreatedAt?: string;
                debugPackageName?: string;
                debugPayload?: Record<string, never>;
                synchronizerId: string;
                templateId: string;
            }[];
        },
    >

    Get the choice context to accept a transfer instruction

    getTransferInstructionRejectContext: (
        params: {
            excludeDebugFields?: boolean;
            meta?: Record<string, string>;
            transferInstructionId: string;
        },
    ) => Promise<
        {
            choiceContextData: Record<string, never>;
            disclosedContracts: {
                contractId: string;
                createdEventBlob: string;
                debugCreatedAt?: string;
                debugPackageName?: string;
                debugPayload?: Record<string, never>;
                synchronizerId: string;
                templateId: string;
            }[];
        },
    >

    Get the choice context to reject a transfer instruction

    getTransferInstructionWithdrawContext: (
        params: {
            excludeDebugFields?: boolean;
            meta?: Record<string, string>;
            transferInstructionId: string;
        },
    ) => Promise<
        {
            choiceContextData: Record<string, never>;
            disclosedContracts: {
                contractId: string;
                createdEventBlob: string;
                debugCreatedAt?: string;
                debugPackageName?: string;
                debugPayload?: Record<string, never>;
                synchronizerId: string;
                templateId: string;
            }[];
        },
    >

    Get the choice context to withdraw a transfer instruction

    getTransferOfferStatus: (
        params: { trackingId: string },
    ) => Promise<
        {
            contract_id?: string;
            failure_kind?: "expired"
            | "rejected"
            | "withdrawn";
            status: "created" | "failed" | "completed" | "accepted";
            transaction_id?: string;
            withdrawn_reason?: string;
        },
    >

    Get the status of a transfer offer by tracking ID

    getUserStatus: () => Promise<
        {
            has_featured_app_right: boolean;
            party_id: string;
            user_onboarded: boolean;
            user_wallet_installed: boolean;
        },
    >

    Get the current user status including onboarding and wallet installation status

    getValidatorUserInfo: () => Promise<GetValidatorUserInfoResponse>

    Get public information about the validator operator

    getWalletBalance: () => Promise<
        {
            effective_locked_qty: string;
            effective_unlocked_qty: string;
            round: number;
            total_holding_fees: string;
        },
    >

    Get the current wallet balance including unlocked and locked quantities

    httpClient: HttpClient
    listAnsEntries: () => Promise<{ entries: any[] }>

    List ANS entries

    listExternalPartySetupProposals: () => Promise<{ contracts: any[] }>

    List all external party setup proposals

    listInstruments: (
        params: { pageSize?: number; pageToken?: string },
    ) => Promise<
        {
            instruments: {
                decimals: number;
                id: string;
                name: string;
                supportedApis: { [key: string]: number };
                symbol: string;
                totalSupply?: string;
                totalSupplyAsOf?: string;
            }[];
            nextPageToken?: string;
        },
    >

    List all instruments managed by this instrument admin

    listTokenStandardTransfers: () => Promise<{ transfers: any[] }>

    List all token standard transfers for the current user

    listTransferOffers: () => Promise<
        {
            offers: {
                amount: string;
                contract_id: string;
                description: string;
                expires_at: number;
                receiver_party_id: string;
                status?: string;
                tracking_id: string;
                [x: string]: unknown;
            }[];
        },
    >

    List all transfer offers for the current user

    listUsers: () => Promise<{ usernames: string[] }>

    List all users onboarded onto this validator

    lookupAnsEntryByName: (params: { name: string }) => Promise<{ entry: any }>

    Lookup ANS entry by name

    lookupAnsEntryByParty: (params: { party: string }) => Promise<{ entry: any }>

    Lookup ANS entry by party

    lookupFeaturedAppRight: (
        params: { partyId: string },
    ) => Promise<{ featured_app_right?: any }>

    Lookup featured app right

    lookupTransferCommandCounterByParty: (
        params: { party: string },
    ) => Promise<{ counter: number }>

    Lookup transfer command counter by party

    lookupTransferCommandStatus: (
        params: { nonce: number; sender: string },
    ) => Promise<{ status: string }>

    Lookup transfer command status

    lookupTransferPreapprovalByParty: (
        params: { partyId: string },
    ) => Promise<
        {
            transfer_preapproval: {
                contract: {
                    contract_id: string;
                    created_at?: string;
                    created_event_blob: string;
                    payload: Record<
                        string,
                        | string
                        | number
                        | boolean
                        | (string | number | boolean | (...)[] | { [key: ...]: ... } | null)[]
                        | { [key: string]: any }
                        | null,
                    >;
                    template_id: string;
                };
                domain_id: string;
            };
        },
    >

    Lookup transfer preapproval by party

    registerNewUser: () => Promise<{ party_id: string }>

    Register a new user to the validator API (one-time operation)

    rejectTransferOffer: (
        params: { contractId: string },
    ) => Promise<{ rejected_offer_contract_id: string }>

    Reject a transfer offer by contract ID

    submitExternalPartyTopology: (
        params: { public_key: string; signed_topology_txs: any[] },
    ) => Promise<{ party_id: string }>

    Submit signed external party topology transactions

    withdrawTransferOffer: (
        params: { contractId: string },
    ) => Promise<{ withdrawn_offer_contract_id: string }>

    Withdraw a transfer offer by contract ID

    Methods

    • Returns Promise<string>

    • Parameters

      • OptionaladditionalParties: readonly string[]

      Returns string[]

    • Clears the cached authentication token, forcing a refresh on the next authenticate() call. Useful when a token has expired mid-operation (e.g., during a long-running WebSocket stream).

      Returns void

    • Returns ApiType

    • Returns string

    • Returns string

    • Returns Logger | undefined

    • Returns readonly string[]

    • Returns NetworkType

    • Returns PartyId

    • Returns string | undefined

    • Returns string

    • Returns the token expiry timestamp in milliseconds since epoch, or null if not available. Use this to schedule proactive token refresh before expiration, especially for long-running WebSocket connections.

      Returns number | null

    • Returns the timestamp when the current token was issued, in milliseconds since epoch, or null if not available.

      Returns number | null

    • Returns the token lifetime in milliseconds, or null if not available. Useful for calculating when to schedule proactive token refresh (e.g., at 50% of lifetime or 2 minutes before expiry, whichever is later).

      Returns number | null

    • Returns UserId | undefined

    • Type Parameters

      • T

      Parameters

      • url: string
      • Optionalconfig: RequestConfig

      Returns Promise<T>

    • Type Parameters

      • T

      Parameters

      • url: string
      • Optionalconfig: RequestConfig

      Returns Promise<T>

    • Type Parameters

      • T

      Parameters

      • url: string
      • data: unknown
      • Optionalconfig: RequestConfig

      Returns Promise<T>

    • Type Parameters

      • T

      Parameters

      • url: string
      • data: unknown
      • Optionalconfig: RequestConfig

      Returns Promise<T>

    • Set the party ID for this client. Useful for LocalNet where party ID is discovered at runtime after client initialization.

      Parameters

      • partyId: string | PartyId

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    acceptTransferOfferapiTypeauthManagerclientConfigconfigcreateAnsEntrycreateBuyTrafficRequestcreateTokenStandardTransfercreateTransferOffercreateUserdumpParticipantIdentitiesgenerateExternalPartyTopologygetAllocationCancelContextgetAllocationFactorygetAllocationTransferContextgetAllocationWithdrawContextgetAmuletRulesgetAmuletsgetAnsRulesgetBuyTrafficRequestStatusgetDsoPartyIdgetExternalPartyBalancegetInstrumentgetMemberTrafficStatusgetMiningRoundDetailsgetOpenAndIssuingMiningRoundsgetRegistryInfogetTransferFactorygetTransferInstructionAcceptContextgetTransferInstructionRejectContextgetTransferInstructionWithdrawContextgetTransferOfferStatusgetUserStatusgetValidatorUserInfogetWalletBalancehttpClientlistAnsEntrieslistExternalPartySetupProposalslistInstrumentslistTokenStandardTransferslistTransferOfferslistUserslookupAnsEntryByNamelookupAnsEntryByPartylookupFeaturedAppRightlookupTransferCommandCounterByPartylookupTransferCommandStatuslookupTransferPreapprovalByPartyregisterNewUserrejectTransferOffersubmitExternalPartyTopologywithdrawTransferOffer
    Methods