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

    Type Alias ListWalletsResponse

    type ListWalletsResponse = {
        items: {
            address?: string;
            custodial: boolean;
            dateCreated: string;
            dateDeleted?: string;
            externalId?: string;
            id: string;
            name?: 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"
                | "KeyECDSA"
                | "KeyEdDSA"
                | "KeyECDSAStark";
            signingKey: {
                curve: "ed25519" | "secp256k1" | "stark";
                delegatedTo?: string;
                id: string;
                publicKey: string;
                scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
            };
            status: "Active"
            | "Inactive"
            | "Archived";
            tags: string[];
            validatorId?: string;
            vaultId?: string;
        }[];
        nextPageToken?: string;
    }
    Index

    Properties

    items nextPageToken?

    Properties

    items: {
        address?: string;
        custodial: boolean;
        dateCreated: string;
        dateDeleted?: string;
        externalId?: string;
        id: string;
        name?: 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"
            | "KeyECDSA"
            | "KeyEdDSA"
            | "KeyECDSAStark";
        signingKey: {
            curve: "ed25519" | "secp256k1" | "stark";
            delegatedTo?: string;
            id: string;
            publicKey: string;
            scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
        };
        status: "Active"
        | "Inactive"
        | "Archived";
        tags: string[];
        validatorId?: string;
        vaultId?: string;
    }[]

    Current page items.

    Type Declaration

    • Optionaladdress?: string

      Wallet address on its corresponding network.

    • custodial: boolean

      Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial).

    • dateCreated: string

      ISO 8601 date string when wallet was created.

    • OptionaldateDeleted?: string

      ISO 8601 date string when wallet was deleted.

    • OptionalexternalId?: string

      User-defined value that can be used to correlate the entity with an external system.

    • id: string

      ID of the wallet.

    • Optionalname?: string

      Wallet nickname.

    • 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"
          | "KeyECDSA"
          | "KeyEdDSA"
          | "KeyECDSAStark"

      Network this wallet is bound to.

    • signingKey: {
          curve: "ed25519" | "secp256k1" | "stark";
          delegatedTo?: string;
          id: string;
          publicKey: string;
          scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
      }

      Details about the key underlying the wallet.

      • curve: "ed25519" | "secp256k1" | "stark"

        The elliptic curve for the key.

      • OptionaldelegatedTo?: string

        The end user ID the key (and wallet) is delegated to.

      • id: string

        Key id.

      • publicKey: string

        Hex-encoded value of the public key.

      • scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr"

        The cryptographic scheme for the key.

    • status: "Active" | "Inactive" | "Archived"

      Wallet status.

    • tags: string[]

      List of tags.

    • OptionalvalidatorId?: string

      Id of the validator on which the wallet is created for Canton networks

    • OptionalvaultId?: string

      The vault controlling this wallet, absent for ordinary wallets. A vault wallet is read-only, its funds move through the vault endpoints, and it carries its vault name and tags as its own.

    nextPageToken?: string

    token to use as paginationToken to request the next page.

    Settings

    Member Visibility

    On This Page

    Properties