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

    Type Alias UpdateWalletResponse

    type UpdateWalletResponse = {
        address?: string;
        custodial: boolean;
        dateCreated: string;
        dateDeleted?: string;
        externalId?: string;
        id: string;
        name?: string;
        network:
            | | "Algorand"
            | "AlgorandTestnet"
            | "Aptos"
            | "AptosTestnet"
            | "ArbitrumOne"
            | "ArbitrumGoerli"
            | "ArbitrumSepolia"
            | "AvalancheC"
            | "AvalancheCFuji"
            | "Adi"
            | "AdiTestnet"
            | "BabylonGenesis"
            | "BabylonTestnet5"
            | "Base"
            | "BaseGoerli"
            | "BaseSepolia"
            | "Berachain"
            | "BerachainBArtio"
            | "BerachainBepolia"
            | "Bitcoin"
            | "BitcoinSignet"
            | "BitcoinTestnet3"
            | "BitcoinCash"
            | "BitcoinCashTestnet"
            | "Bob"
            | "BobSepolia"
            | "Bsc"
            | "BscTestnet"
            | "Canton"
            | "CantonDevnet"
            | "CantonTestnet"
            | "Cardano"
            | "CardanoPreprod"
            | "Celo"
            | "CeloAlfajores"
            | "Codex"
            | "CodexSepolia"
            | "CosmosHub4"
            | "CosmosIcsTestnet"
            | "Dogecoin"
            | "DogecoinTestnet"
            | "Ethereum"
            | "EthereumGoerli"
            | "EthereumSepolia"
            | "EthereumHolesky"
            | "EthereumHoodi"
            | "FantomOpera"
            | "FantomTestnet"
            | "FlareC"
            | "FlareCCoston2"
            | "Hedera"
            | "HederaTestnet"
            | "Ink"
            | "InkSepolia"
            | "InternetComputer"
            | "Ion"
            | "IonTestnet"
            | "Iota"
            | "IotaTestnet"
            | "IotaZodianet"
            | "KadenaTestnet4"
            | "KadenaTestnet4:1"
            | "KadenaTestnet4:2"
            | "KadenaTestnet4:3"
            | "KadenaTestnet4:4"
            | "KadenaTestnet4:5"
            | "KadenaTestnet4:6"
            | "KadenaTestnet4:7"
            | "KadenaTestnet4:8"
            | "KadenaTestnet4:9"
            | "KadenaTestnet4:10"
            | "KadenaTestnet4:11"
            | "KadenaTestnet4:12"
            | "KadenaTestnet4:13"
            | "KadenaTestnet4:14"
            | "KadenaTestnet4:15"
            | "KadenaTestnet4:16"
            | "KadenaTestnet4:17"
            | "KadenaTestnet4:18"
            | "KadenaTestnet4:19"
            | "Kadena"
            | "Kadena:1"
            | "Kadena:2"
            | "Kadena:3"
            | "Kadena:4"
            | "Kadena:5"
            | "Kadena:6"
            | "Kadena:7"
            | "Kadena:8"
            | "Kadena:9"
            | "Kadena:10"
            | "Kadena:11"
            | "Kadena:12"
            | "Kadena:13"
            | "Kadena:14"
            | "Kadena:15"
            | "Kadena:16"
            | "Kadena:17"
            | "Kadena:18"
            | "Kadena:19"
            | "Kaspa"
            | "KaspaTestnet11"
            | "Kusama"
            | "Litecoin"
            | "LitecoinTestnet"
            | "Near"
            | "NearTestnet"
            | "Optimism"
            | "OptimismGoerli"
            | "OptimismSepolia"
            | "Origyn"
            | "Plume"
            | "PlumeSepolia"
            | "Polkadot"
            | "Polygon"
            | "PolygonAmoy"
            | "PolygonMumbai"
            | "Polymesh"
            | "PolymeshTestnet"
            | "Race"
            | "RaceSepolia"
            | "SeiAtlantic2"
            | "SeiPacific1"
            | "Solana"
            | "SolanaDevnet"
            | "Sonic"
            | "SonicTestnet"
            | "Stellar"
            | "StellarTestnet"
            | "Sui"
            | "SuiTestnet"
            | "Tsc"
            | "TscTestnet1"
            | "Tezos"
            | "TezosGhostnet"
            | "Ton"
            | "TonTestnet"
            | "Tron"
            | "TronNile"
            | "Westend"
            | "XrpLedger"
            | "XrpLedgerTestnet"
            | "KeyECDSA"
            | "KeyEdDSA"
            | "KeyECDSAStark";
        signingKey: {
            curve: "ed25519" | "secp256k1" | "stark";
            delegatedTo?: string;
            id: string;
            publicKey: string;
            scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
        };
        status: "Active"
        | "Archived";
        tags: string[];
        validatorId?: string;
    }
    Index

    Properties

    address?: 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.

    dateDeleted?: string

    ISO 8601 date string when wallet was deleted.

    externalId?: string

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

    id: string

    ID of the wallet.

    name?: string

    Wallet nickname.

    network:
        | | "Algorand"
        | "AlgorandTestnet"
        | "Aptos"
        | "AptosTestnet"
        | "ArbitrumOne"
        | "ArbitrumGoerli"
        | "ArbitrumSepolia"
        | "AvalancheC"
        | "AvalancheCFuji"
        | "Adi"
        | "AdiTestnet"
        | "BabylonGenesis"
        | "BabylonTestnet5"
        | "Base"
        | "BaseGoerli"
        | "BaseSepolia"
        | "Berachain"
        | "BerachainBArtio"
        | "BerachainBepolia"
        | "Bitcoin"
        | "BitcoinSignet"
        | "BitcoinTestnet3"
        | "BitcoinCash"
        | "BitcoinCashTestnet"
        | "Bob"
        | "BobSepolia"
        | "Bsc"
        | "BscTestnet"
        | "Canton"
        | "CantonDevnet"
        | "CantonTestnet"
        | "Cardano"
        | "CardanoPreprod"
        | "Celo"
        | "CeloAlfajores"
        | "Codex"
        | "CodexSepolia"
        | "CosmosHub4"
        | "CosmosIcsTestnet"
        | "Dogecoin"
        | "DogecoinTestnet"
        | "Ethereum"
        | "EthereumGoerli"
        | "EthereumSepolia"
        | "EthereumHolesky"
        | "EthereumHoodi"
        | "FantomOpera"
        | "FantomTestnet"
        | "FlareC"
        | "FlareCCoston2"
        | "Hedera"
        | "HederaTestnet"
        | "Ink"
        | "InkSepolia"
        | "InternetComputer"
        | "Ion"
        | "IonTestnet"
        | "Iota"
        | "IotaTestnet"
        | "IotaZodianet"
        | "KadenaTestnet4"
        | "KadenaTestnet4:1"
        | "KadenaTestnet4:2"
        | "KadenaTestnet4:3"
        | "KadenaTestnet4:4"
        | "KadenaTestnet4:5"
        | "KadenaTestnet4:6"
        | "KadenaTestnet4:7"
        | "KadenaTestnet4:8"
        | "KadenaTestnet4:9"
        | "KadenaTestnet4:10"
        | "KadenaTestnet4:11"
        | "KadenaTestnet4:12"
        | "KadenaTestnet4:13"
        | "KadenaTestnet4:14"
        | "KadenaTestnet4:15"
        | "KadenaTestnet4:16"
        | "KadenaTestnet4:17"
        | "KadenaTestnet4:18"
        | "KadenaTestnet4:19"
        | "Kadena"
        | "Kadena:1"
        | "Kadena:2"
        | "Kadena:3"
        | "Kadena:4"
        | "Kadena:5"
        | "Kadena:6"
        | "Kadena:7"
        | "Kadena:8"
        | "Kadena:9"
        | "Kadena:10"
        | "Kadena:11"
        | "Kadena:12"
        | "Kadena:13"
        | "Kadena:14"
        | "Kadena:15"
        | "Kadena:16"
        | "Kadena:17"
        | "Kadena:18"
        | "Kadena:19"
        | "Kaspa"
        | "KaspaTestnet11"
        | "Kusama"
        | "Litecoin"
        | "LitecoinTestnet"
        | "Near"
        | "NearTestnet"
        | "Optimism"
        | "OptimismGoerli"
        | "OptimismSepolia"
        | "Origyn"
        | "Plume"
        | "PlumeSepolia"
        | "Polkadot"
        | "Polygon"
        | "PolygonAmoy"
        | "PolygonMumbai"
        | "Polymesh"
        | "PolymeshTestnet"
        | "Race"
        | "RaceSepolia"
        | "SeiAtlantic2"
        | "SeiPacific1"
        | "Solana"
        | "SolanaDevnet"
        | "Sonic"
        | "SonicTestnet"
        | "Stellar"
        | "StellarTestnet"
        | "Sui"
        | "SuiTestnet"
        | "Tsc"
        | "TscTestnet1"
        | "Tezos"
        | "TezosGhostnet"
        | "Ton"
        | "TonTestnet"
        | "Tron"
        | "TronNile"
        | "Westend"
        | "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.

    Type Declaration

    • curve: "ed25519" | "secp256k1" | "stark"
    • 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"

      Key scheme.

    status: "Active" | "Archived"

    Wallet status.

    tags: string[]

    List of tags.

    validatorId?: string

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