Dfns TypeScript SDK - v0.8.29
    Preparing search index...

    Type Alias GetBulkWalletJobResponse

    type GetBulkWalletJobResponse = {
        completedCount: number;
        dateCompleted?: string;
        dateCreated: string;
        dateUpdated: string;
        id: string;
        keystoreId: string;
        masterKeyId?: string;
        namePrefix: string;
        network:
            | "Algorand"
            | "AlgorandTestnet"
            | "Aptos"
            | "AptosTestnet"
            | "ArbitrumOne"
            | "ArbitrumGoerli"
            | "ArbitrumSepolia"
            | "ArcTestnet"
            | "Areum"
            | "AvalancheC"
            | "AvalancheCFuji"
            | "Adi"
            | "AdiTestnet"
            | "AdiTestnetAb"
            | "BabylonGenesis"
            | "BabylonTestnet5"
            | "Base"
            | "BaseGoerli"
            | "BaseSepolia"
            | "Berachain"
            | "BerachainBArtio"
            | "BerachainBepolia"
            | "Besu"
            | "Besu2"
            | "Besu3"
            | "Besu4"
            | "Besu5"
            | "BesuTestnet"
            | "BesuTestnet2"
            | "BesuTestnet3"
            | "BesuTestnet4"
            | "Bitcoin"
            | "BitcoinSignet"
            | "BitcoinTestnet3"
            | "BitcoinTestnet4"
            | "BitcoinCash"
            | "BitcoinCashTestnet"
            | "Bob"
            | "BobSepolia"
            | "Bsc"
            | "BscTestnet"
            | "Canton"
            | "CantonDevnet"
            | "CantonTestnet"
            | "Cardano"
            | "CardanoPreprod"
            | "Concordium"
            | "ConcordiumTestnet"
            | "Celo"
            | "CeloAlfajores"
            | "Codex"
            | "CodexSepolia"
            | "CosmosHub4"
            | "CosmosIcsTestnet"
            | "Dogecoin"
            | "DogecoinTestnet"
            | "Ethereum"
            | "EthereumClassic"
            | "EthereumClassicMordor"
            | "EthereumGoerli"
            | "EthereumSepolia"
            | "EthereumHolesky"
            | "EthereumHoodi"
            | "FantomOpera"
            | "FantomTestnet"
            | "FlareC"
            | "FlareCCoston2"
            | "FlowEvm"
            | "FlowEvmTestnet"
            | "IconTestnet"
            | "Hedera"
            | "HederaTestnet"
            | "Ink"
            | "InkSepolia"
            | "InternetComputer"
            | "Ion"
            | "IonTestnet"
            | "Iota"
            | "IotaTestnet"
            | "IotaZodianet"
            | "Kaspa"
            | "KaspaTestnet11"
            | "Kusama"
            | "KusamaAssetHub"
            | "Litecoin"
            | "LitecoinTestnet"
            | "Movement"
            | "MovementTestnet"
            | "Near"
            | "NearTestnet"
            | "Optimism"
            | "OptimismGoerli"
            | "OptimismSepolia"
            | "Origyn"
            | "Plasma"
            | "PlasmaTestnet"
            | "Plume"
            | "PlumeSepolia"
            | "Paseo"
            | "PaseoAssetHub"
            | "Polkadot"
            | "PolkadotAssetHub"
            | "Polygon"
            | "PolygonAmoy"
            | "PolygonMumbai"
            | "Polymesh"
            | "PolymeshTestnet"
            | "Race"
            | "RaceSepolia"
            | "Rayls"
            | "RaylsTestnet"
            | "Robinhood"
            | "RobinhoodSepolia"
            | "SeiAtlantic2"
            | "SeiPacific1"
            | "Solana"
            | "SolanaDevnet"
            | "Sonic"
            | "SonicTestnet"
            | "Starknet"
            | "StarknetSepolia"
            | "Stellar"
            | "StellarTestnet"
            | "Sui"
            | "SuiTestnet"
            | "Tezos"
            | "TezosGhostnet"
            | "TezosShadownet"
            | "Tempo"
            | "TempoAndantino"
            | "TempoModerato"
            | "Tsc"
            | "TscTestnet1"
            | "Ton"
            | "TonTestnet"
            | "Tron"
            | "TronNile"
            | "Westend"
            | "WestendAssetHub"
            | "Xdc"
            | "XdcApothem"
            | "XLayer"
            | "XLayerSepolia"
            | "XrpLedger"
            | "XrpLedgerTestnet";
        nextRetryAttempt?: number;
        nextRetryDate?: string;
        orgId: string;
        reason?: string;
        status: | "Pending"
        | "InProgress"
        | "Completed"
        | "PartiallyCompleted"
        | "Failed";
        tags: string[];
        totalCount: number;
    }
    Index

    Properties

    completedCount dateCompleted? dateCreated dateUpdated id keystoreId masterKeyId? namePrefix network nextRetryAttempt? nextRetryDate? orgId reason? status tags totalCount

    Properties

    completedCount: number

    Number of wallets created so far.

    dateCompleted?: string

    ISO 8601 date string when the job finished.

    dateCreated: string

    ISO 8601 date string when the job was created.

    dateUpdated: string

    ISO 8601 date string when the job was last updated.

    id: string

    ID of the bulk wallet creation job.

    keystoreId: string

    Key store the batch keys are minted in.

    masterKeyId?: string

    Master key the batch wallets are derived from.

    namePrefix: string

    Name prefix shared by every wallet in the batch; wallet at index N is named ${namePrefix}${N}.

    network:
        | "Algorand"
        | "AlgorandTestnet"
        | "Aptos"
        | "AptosTestnet"
        | "ArbitrumOne"
        | "ArbitrumGoerli"
        | "ArbitrumSepolia"
        | "ArcTestnet"
        | "Areum"
        | "AvalancheC"
        | "AvalancheCFuji"
        | "Adi"
        | "AdiTestnet"
        | "AdiTestnetAb"
        | "BabylonGenesis"
        | "BabylonTestnet5"
        | "Base"
        | "BaseGoerli"
        | "BaseSepolia"
        | "Berachain"
        | "BerachainBArtio"
        | "BerachainBepolia"
        | "Besu"
        | "Besu2"
        | "Besu3"
        | "Besu4"
        | "Besu5"
        | "BesuTestnet"
        | "BesuTestnet2"
        | "BesuTestnet3"
        | "BesuTestnet4"
        | "Bitcoin"
        | "BitcoinSignet"
        | "BitcoinTestnet3"
        | "BitcoinTestnet4"
        | "BitcoinCash"
        | "BitcoinCashTestnet"
        | "Bob"
        | "BobSepolia"
        | "Bsc"
        | "BscTestnet"
        | "Canton"
        | "CantonDevnet"
        | "CantonTestnet"
        | "Cardano"
        | "CardanoPreprod"
        | "Concordium"
        | "ConcordiumTestnet"
        | "Celo"
        | "CeloAlfajores"
        | "Codex"
        | "CodexSepolia"
        | "CosmosHub4"
        | "CosmosIcsTestnet"
        | "Dogecoin"
        | "DogecoinTestnet"
        | "Ethereum"
        | "EthereumClassic"
        | "EthereumClassicMordor"
        | "EthereumGoerli"
        | "EthereumSepolia"
        | "EthereumHolesky"
        | "EthereumHoodi"
        | "FantomOpera"
        | "FantomTestnet"
        | "FlareC"
        | "FlareCCoston2"
        | "FlowEvm"
        | "FlowEvmTestnet"
        | "IconTestnet"
        | "Hedera"
        | "HederaTestnet"
        | "Ink"
        | "InkSepolia"
        | "InternetComputer"
        | "Ion"
        | "IonTestnet"
        | "Iota"
        | "IotaTestnet"
        | "IotaZodianet"
        | "Kaspa"
        | "KaspaTestnet11"
        | "Kusama"
        | "KusamaAssetHub"
        | "Litecoin"
        | "LitecoinTestnet"
        | "Movement"
        | "MovementTestnet"
        | "Near"
        | "NearTestnet"
        | "Optimism"
        | "OptimismGoerli"
        | "OptimismSepolia"
        | "Origyn"
        | "Plasma"
        | "PlasmaTestnet"
        | "Plume"
        | "PlumeSepolia"
        | "Paseo"
        | "PaseoAssetHub"
        | "Polkadot"
        | "PolkadotAssetHub"
        | "Polygon"
        | "PolygonAmoy"
        | "PolygonMumbai"
        | "Polymesh"
        | "PolymeshTestnet"
        | "Race"
        | "RaceSepolia"
        | "Rayls"
        | "RaylsTestnet"
        | "Robinhood"
        | "RobinhoodSepolia"
        | "SeiAtlantic2"
        | "SeiPacific1"
        | "Solana"
        | "SolanaDevnet"
        | "Sonic"
        | "SonicTestnet"
        | "Starknet"
        | "StarknetSepolia"
        | "Stellar"
        | "StellarTestnet"
        | "Sui"
        | "SuiTestnet"
        | "Tezos"
        | "TezosGhostnet"
        | "TezosShadownet"
        | "Tempo"
        | "TempoAndantino"
        | "TempoModerato"
        | "Tsc"
        | "TscTestnet1"
        | "Ton"
        | "TonTestnet"
        | "Tron"
        | "TronNile"
        | "Westend"
        | "WestendAssetHub"
        | "Xdc"
        | "XdcApothem"
        | "XLayer"
        | "XLayerSepolia"
        | "XrpLedger"
        | "XrpLedgerTestnet"

    Network the wallets are created on.

    nextRetryAttempt?: number

    Number of retry attempts made so far.

    nextRetryDate?: string

    ISO 8601 date string when the job is next retried.

    orgId: string

    ID of the org that owns the job.

    reason?: string

    Failure reason, set when the job did not complete fully.

    status: "Pending" | "InProgress" | "Completed" | "PartiallyCompleted" | "Failed"

    Bulk wallet creation job status.

    tags: string[]

    List of tags.

    totalCount: number

    Total number of wallets requested in the batch.

    Settings

    Member Visibility

    On This Page

    Properties