@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
get
Supported
Chains
list
Wallets
Constructors
constructor
new
UtilaWalletClient
(
args
:
{
baseUrl
:
string
;
serviceAccountEmail
:
string
;
serviceAccountPrivateKey
:
string
;
vaultEnv
:
UtilaVaultEnv
;
}
,
)
:
UtilaWalletClient
Parameters
args
:
{
baseUrl
:
string
;
serviceAccountEmail
:
string
;
serviceAccountPrivateKey
:
string
;
vaultEnv
:
UtilaVaultEnv
;
}
Returns
UtilaWalletClient
Properties
Protected
Readonly
client
client
:
Client
<
paths
>
Methods
create
create
(
args
:
{
chains
:
UtilaBlockchain
[]
;
displayName
:
string
;
vaultId
:
string
;
}
,
)
:
Promise
<
{
archived
?:
boolean
;
btcDetails
?:
{
btcNetworkDetails
?:
{
mainAddress
?:
string
;
network
?:
string
;
xpub
?:
string
;
}
[]
;
}
;
convertedValue
?:
{
amount
?:
string
;
currencyCode
?:
string
}
;
createParams
?:
{
walletGroups
?:
string
[]
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
hasFrozenAssets
?:
boolean
;
id
:
string
;
name
?:
string
;
networks
:
string
[]
;
solanaDetails
?:
{
address
?:
string
}
;
tonDetails
?:
{
address
?:
string
}
;
tronDetails
?:
{
address
?:
string
}
;
}
,
>
Parameters
args
:
{
chains
:
UtilaBlockchain
[]
;
displayName
:
string
;
vaultId
:
string
}
Returns
Promise
<
{
archived
?:
boolean
;
btcDetails
?:
{
btcNetworkDetails
?:
{
mainAddress
?:
string
;
network
?:
string
;
xpub
?:
string
;
}
[]
;
}
;
convertedValue
?:
{
amount
?:
string
;
currencyCode
?:
string
}
;
createParams
?:
{
walletGroups
?:
string
[]
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
hasFrozenAssets
?:
boolean
;
id
:
string
;
name
?:
string
;
networks
:
string
[]
;
solanaDetails
?:
{
address
?:
string
}
;
tonDetails
?:
{
address
?:
string
}
;
tronDetails
?:
{
address
?:
string
}
;
}
,
>
create
Address
createAddress
(
args
:
{
chain
:
UtilaBlockchain
;
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
:
{
chain
:
UtilaBlockchain
;
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
}
;
createParams
?:
{
walletGroups
?:
string
[]
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
hasFrozenAssets
?:
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
}
;
createParams
?:
{
walletGroups
?:
string
[]
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
hasFrozenAssets
?:
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"
;
}
[]
;
}
,
>
get
Supported
Chains
getSupportedChains
()
:
UtilaBlockchain
[]
Returns
UtilaBlockchain
[]
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
}
;
createParams
?:
{
walletGroups
?:
string
[]
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
hasFrozenAssets
?:
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
}
;
createParams
?:
{
walletGroups
?:
string
[]
}
;
displayName
:
string
;
evmDetails
?:
{
address
?:
string
}
;
external
?:
boolean
;
hasFrozenAssets
?:
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
get
Supported
Chains
list
Wallets
@cfxlabsinc/b2b-services
Loading...