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

    Type Alias CreateWalletBody

    type CreateWalletBody = {
        delayDelegation?: boolean;
        delegateTo?: string;
        externalId?: 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";
            id?: string;
            scheme?: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
            storeId?: string;
        };
        tags?: string[];
        validatorId?: string;
    }
    Index

    Properties

    delayDelegation? delegateTo? externalId? name? network signingKey? tags? validatorId?

    Properties

    delayDelegation?: boolean

    Specify if you want to create the wallet from a service account and later delegate it to an end user.

    delegateTo?: string

    ID of the end user to delegate this wallet to. The wallet will only be usable by the end user. More info here.

    externalId?: string

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

    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 used for the wallet.

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

    Options for the wallet's underlying key

    Type Declaration

    • Optionalcurve?: "ed25519" | "secp256k1" | "stark"

      Use this to specify the new key curve for networks that support multiple key formats.

    • Optionalid?: string

      Use this parameter to create a wallet from an existing key. This enables one key to be used across multiple networks and have the same address if networks share the same address format, ex. Ethereum and Polygon. If specified, requires the Keys:Reuse permission. If the key is delegated to an end user, then the new wallet will be automatically delegated to the same end user.

    • Optionalscheme?: "DH" | "ECDSA" | "EdDSA" | "Schnorr"

      Use this to specify the new key scheme for networks that support multiple key formats. ex. use Schnorr to create a Bitcoin Taproot wallet.

    • OptionalstoreId?: string

      Use this to specify the key store the key material is saved to.

    tags?: string[]

    List of tags to be created for this wallet. If specified, requires the Wallets:Tags:Add permission, like the Tag Wallet endpoint.

    validatorId?: string

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

    Settings

    Member Visibility

    On This Page

    Properties