@cfxlabsinc/b2b-services
Preparing search index...
@cfxlabsinc/clients
utila
UtilaWalletClient
Class UtilaWalletClient
Hierarchy
UtilaBaseClient
UtilaWalletClient
Index
Constructors
constructor
Properties
client
Methods
create
create
Address
generate
Token
get
get
Addresses
list
Wallets
Constructors
constructor
new
UtilaWalletClient
(
args
:
{
baseUrl
:
string
;
serviceAccountEmail
:
string
;
serviceAccountPrivateKey
:
string
;
}
,
)
:
UtilaWalletClient
Parameters
args
:
{
baseUrl
:
string
;
serviceAccountEmail
:
string
;
serviceAccountPrivateKey
:
string
;
}
Returns
UtilaWalletClient
Properties
Protected
Readonly
client
client
:
Client
<
paths
>
Methods
create
create
(
args
:
{
displayName
:
string
;
networks
:
(
|
"networks/base-mainnet"
|
"networks/bitcoin-mainnet"
|
"networks/ethereum-mainnet"
|
"networks/optimism-mainnet"
|
"networks/polygon-mainnet"
|
"networks/arbitrum-mainnet"
|
"networks/avalanche-c-chain-mainnet"
|
"networks/bnb-smart-chain-mainnet"
|
"networks/fuse-mainnet"
|
"networks/tron-mainnet"
|
"networks/solana-mainnet"
|
"networks/cosmoshub-mainnet"
|
"networks/osmosis-mainnet"
|
"networks/injective-mainnet"
|
"networks/rootstock-mainnet"
|
"networks/ton-mainnet"
|
"networks/blast-mainnet"
|
"networks/aptos-mainnet"
|
"networks/sui-mainnet"
|
"networks/bittensor-mainnet"
|
"networks/litecoin-mainnet"
|
"networks/xrpl-mainnet"
|
"networks/bitcoin-testnet"
|
"networks/bnb-smart-chain-testnet"
|
"networks/solana-devnet"
|
"networks/ethereum-testnet-sepolia"
|
"networks/polygon-testnet-amoy"
|
"networks/avalanche-c-chain-testnet-fuji"
|
"networks/tron-testnet-shasta"
)
[]
;
vaultId
:
string
;
}
,
)
:
Promise
<
{
archived
?:
boolean
;
btcDetails
?:
{
btcNetworkDetails
?:
{
mainAddress
?:
string
;
network
?:
string
;
xpub
?:
string
;
}
[]
;
}
;
convertedValue
?:
{
amount
?:
string
;
currencyCode
?:
string
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
id
:
string
;
name
?:
string
;
networks
:
string
[]
;
solanaDetails
?:
{
address
?:
string
}
;
tonDetails
?:
{
address
?:
string
}
;
tronDetails
?:
{
address
?:
string
}
;
}
,
>
Parameters
args
:
{
displayName
:
string
;
networks
:
(
|
"networks/base-mainnet"
|
"networks/bitcoin-mainnet"
|
"networks/ethereum-mainnet"
|
"networks/optimism-mainnet"
|
"networks/polygon-mainnet"
|
"networks/arbitrum-mainnet"
|
"networks/avalanche-c-chain-mainnet"
|
"networks/bnb-smart-chain-mainnet"
|
"networks/fuse-mainnet"
|
"networks/tron-mainnet"
|
"networks/solana-mainnet"
|
"networks/cosmoshub-mainnet"
|
"networks/osmosis-mainnet"
|
"networks/injective-mainnet"
|
"networks/rootstock-mainnet"
|
"networks/ton-mainnet"
|
"networks/blast-mainnet"
|
"networks/aptos-mainnet"
|
"networks/sui-mainnet"
|
"networks/bittensor-mainnet"
|
"networks/litecoin-mainnet"
|
"networks/xrpl-mainnet"
|
"networks/bitcoin-testnet"
|
"networks/bnb-smart-chain-testnet"
|
"networks/solana-devnet"
|
"networks/ethereum-testnet-sepolia"
|
"networks/polygon-testnet-amoy"
|
"networks/avalanche-c-chain-testnet-fuji"
|
"networks/tron-testnet-shasta"
)
[]
;
vaultId
:
string
;
}
Returns
Promise
<
{
archived
?:
boolean
;
btcDetails
?:
{
btcNetworkDetails
?:
{
mainAddress
?:
string
;
network
?:
string
;
xpub
?:
string
;
}
[]
;
}
;
convertedValue
?:
{
amount
?:
string
;
currencyCode
?:
string
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
id
:
string
;
name
?:
string
;
networks
:
string
[]
;
solanaDetails
?:
{
address
?:
string
}
;
tonDetails
?:
{
address
?:
string
}
;
tronDetails
?:
{
address
?:
string
}
;
}
,
>
create
Address
createAddress
(
args
:
{
network
:
|
"networks/base-mainnet"
|
"networks/bitcoin-mainnet"
|
"networks/ethereum-mainnet"
|
"networks/optimism-mainnet"
|
"networks/polygon-mainnet"
|
"networks/arbitrum-mainnet"
|
"networks/avalanche-c-chain-mainnet"
|
"networks/bnb-smart-chain-mainnet"
|
"networks/fuse-mainnet"
|
"networks/tron-mainnet"
|
"networks/solana-mainnet"
|
"networks/cosmoshub-mainnet"
|
"networks/osmosis-mainnet"
|
"networks/injective-mainnet"
|
"networks/rootstock-mainnet"
|
"networks/ton-mainnet"
|
"networks/blast-mainnet"
|
"networks/aptos-mainnet"
|
"networks/sui-mainnet"
|
"networks/bittensor-mainnet"
|
"networks/litecoin-mainnet"
|
"networks/xrpl-mainnet"
|
"networks/bitcoin-testnet"
|
"networks/bnb-smart-chain-testnet"
|
"networks/solana-devnet"
|
"networks/ethereum-testnet-sepolia"
|
"networks/polygon-testnet-amoy"
|
"networks/avalanche-c-chain-testnet-fuji"
|
"networks/tron-testnet-shasta"
;
vaultId
:
string
;
walletId
:
string
;
}
,
)
:
Promise
<
{
address
?:
string
;
chain
:
UtilaBlockchain
;
displayName
?:
string
;
format
?:
|
"BITCOIN_P2PKH"
|
"BITCOIN_P2WPKH"
|
"EVM"
|
"TRON_BASE58"
|
"BASE58"
|
"TON_NON_BOUNCEABLE"
|
"SUBSTRATE_58"
;
key
?:
string
;
keyDerivationPath
?:
string
[]
;
name
?:
string
;
network
:
string
;
note
?:
string
;
type
?:
"MAIN"
|
"DEPOSIT"
|
"CHANGE"
;
}
,
>
Parameters
args
:
{
network
:
|
"networks/base-mainnet"
|
"networks/bitcoin-mainnet"
|
"networks/ethereum-mainnet"
|
"networks/optimism-mainnet"
|
"networks/polygon-mainnet"
|
"networks/arbitrum-mainnet"
|
"networks/avalanche-c-chain-mainnet"
|
"networks/bnb-smart-chain-mainnet"
|
"networks/fuse-mainnet"
|
"networks/tron-mainnet"
|
"networks/solana-mainnet"
|
"networks/cosmoshub-mainnet"
|
"networks/osmosis-mainnet"
|
"networks/injective-mainnet"
|
"networks/rootstock-mainnet"
|
"networks/ton-mainnet"
|
"networks/blast-mainnet"
|
"networks/aptos-mainnet"
|
"networks/sui-mainnet"
|
"networks/bittensor-mainnet"
|
"networks/litecoin-mainnet"
|
"networks/xrpl-mainnet"
|
"networks/bitcoin-testnet"
|
"networks/bnb-smart-chain-testnet"
|
"networks/solana-devnet"
|
"networks/ethereum-testnet-sepolia"
|
"networks/polygon-testnet-amoy"
|
"networks/avalanche-c-chain-testnet-fuji"
|
"networks/tron-testnet-shasta"
;
vaultId
:
string
;
walletId
:
string
;
}
Returns
Promise
<
{
address
?:
string
;
chain
:
UtilaBlockchain
;
displayName
?:
string
;
format
?:
|
"BITCOIN_P2PKH"
|
"BITCOIN_P2WPKH"
|
"EVM"
|
"TRON_BASE58"
|
"BASE58"
|
"TON_NON_BOUNCEABLE"
|
"SUBSTRATE_58"
;
key
?:
string
;
keyDerivationPath
?:
string
[]
;
name
?:
string
;
network
:
string
;
note
?:
string
;
type
?:
"MAIN"
|
"DEPOSIT"
|
"CHANGE"
;
}
,
>
generate
Token
generateToken
()
:
string
Returns
string
get
get
(
args
:
{
vaultId
:
string
;
walletId
:
string
}
,
)
:
Promise
<
{
wallet
?:
{
archived
?:
boolean
;
btcDetails
?:
{
btcNetworkDetails
?:
{
mainAddress
?:
string
;
network
?:
string
;
xpub
?:
string
;
}
[]
;
}
;
convertedValue
?:
{
amount
?:
string
;
currencyCode
?:
string
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
name
?:
string
;
networks
:
string
[]
;
solanaDetails
?:
{
address
?:
string
}
;
tonDetails
?:
{
address
?:
string
}
;
tronDetails
?:
{
address
?:
string
}
;
}
;
}
,
>
Parameters
args
:
{
vaultId
:
string
;
walletId
:
string
}
Returns
Promise
<
{
wallet
?:
{
archived
?:
boolean
;
btcDetails
?:
{
btcNetworkDetails
?:
{
mainAddress
?:
string
;
network
?:
string
;
xpub
?:
string
;
}
[]
;
}
;
convertedValue
?:
{
amount
?:
string
;
currencyCode
?:
string
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
name
?:
string
;
networks
:
string
[]
;
solanaDetails
?:
{
address
?:
string
}
;
tonDetails
?:
{
address
?:
string
}
;
tronDetails
?:
{
address
?:
string
}
;
}
;
}
,
>
get
Addresses
getAddresses
(
args
:
{
pageToken
?:
string
;
vaultId
:
string
;
walletId
:
string
}
,
)
:
Promise
<
{
nextPageToken
?:
string
;
totalSize
?:
number
;
walletAddresses
:
{
address
?:
string
;
chain
:
UtilaBlockchain
;
displayName
?:
string
;
format
?:
|
"BITCOIN_P2PKH"
|
"BITCOIN_P2WPKH"
|
"EVM"
|
"TRON_BASE58"
|
"BASE58"
|
"TON_NON_BOUNCEABLE"
|
"SUBSTRATE_58"
;
key
?:
string
;
keyDerivationPath
?:
string
[]
;
name
?:
string
;
network
:
string
;
note
?:
string
;
type
?:
"MAIN"
|
"DEPOSIT"
|
"CHANGE"
;
}
[]
;
}
,
>
Parameters
args
:
{
pageToken
?:
string
;
vaultId
:
string
;
walletId
:
string
}
Returns
Promise
<
{
nextPageToken
?:
string
;
totalSize
?:
number
;
walletAddresses
:
{
address
?:
string
;
chain
:
UtilaBlockchain
;
displayName
?:
string
;
format
?:
|
"BITCOIN_P2PKH"
|
"BITCOIN_P2WPKH"
|
"EVM"
|
"TRON_BASE58"
|
"BASE58"
|
"TON_NON_BOUNCEABLE"
|
"SUBSTRATE_58"
;
key
?:
string
;
keyDerivationPath
?:
string
[]
;
name
?:
string
;
network
:
string
;
note
?:
string
;
type
?:
"MAIN"
|
"DEPOSIT"
|
"CHANGE"
;
}
[]
;
}
,
>
list
Wallets
listWallets
(
args
:
{
pageToken
?:
string
;
vaultId
:
string
}
,
)
:
Promise
<
{
nextPageToken
?:
string
;
totalSize
?:
number
;
wallets
?:
{
archived
?:
boolean
;
btcDetails
?:
{
btcNetworkDetails
?:
{
mainAddress
?:
(...)
|
(...)
;
network
?:
(...)
|
(...)
;
xpub
?:
(...)
|
(...)
;
}
[]
;
}
;
convertedValue
?:
{
amount
?:
string
;
currencyCode
?:
string
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
name
?:
string
;
networks
:
string
[]
;
solanaDetails
?:
{
address
?:
string
}
;
tonDetails
?:
{
address
?:
string
}
;
tronDetails
?:
{
address
?:
string
}
;
}
[]
;
}
,
>
Parameters
args
:
{
pageToken
?:
string
;
vaultId
:
string
}
Returns
Promise
<
{
nextPageToken
?:
string
;
totalSize
?:
number
;
wallets
?:
{
archived
?:
boolean
;
btcDetails
?:
{
btcNetworkDetails
?:
{
mainAddress
?:
(...)
|
(...)
;
network
?:
(...)
|
(...)
;
xpub
?:
(...)
|
(...)
;
}
[]
;
}
;
convertedValue
?:
{
amount
?:
string
;
currencyCode
?:
string
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
name
?:
string
;
networks
:
string
[]
;
solanaDetails
?:
{
address
?:
string
}
;
tonDetails
?:
{
address
?:
string
}
;
tronDetails
?:
{
address
?:
string
}
;
}
[]
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
Methods
create
create
Address
generate
Token
get
get
Addresses
list
Wallets
@cfxlabsinc/b2b-services
Loading...