Class WalletAddress

A representation of a blockchain address, which is a wallet-controlled account on a network.

Hierarchy (view full)

Address
- WalletAddress

Index

Constructors

constructor

new WalletAddress(model, key?): WalletAddress
Initializes a new Wallet Address instance.
Parameters
- model: Address
  The address model data.
- Optional key: Wallet
  The ethers.js SigningKey the Address uses to sign data.
Returns WalletAddress
Throws
If the address model is empty.
Overrides Address.constructor
- Defined in src/coinbase/address/wallet_address.ts:49

Properties

`Protected` `Optional` _reputation

_reputation?: AddressReputation

`Protected` id

id: string

`Private` `Optional` key

key?: Wallet

`Private` model

model: Address

`Protected` networkId

networkId: string

Methods

`Private` broadcastStakingOperationRequest

broadcastStakingOperationRequest(stakingOperationID, signedPayload, transactionIndex): Promise<StakingOperation>
Private
A helper function that broadcasts the signed payload.
Parameters
- stakingOperationID: string
  The staking operation id related to the signed payload.
- signedPayload: string
  The payload that's being broadcasted.
- transactionIndex: number
  The index of the transaction in the array from the staking operation.
Returns Promise<StakingOperation>
An updated staking operation with the broadcasted transaction.
- Defined in src/coinbase/address/wallet_address.ts:1103

canSign

canSign(): boolean
Returns whether the Address has a private key backing it to sign transactions.

Returns boolean
Whether the Address has a private key backing it to sign transactions.
- Defined in src/coinbase/address/wallet_address.ts:108

claimableBalance

claimableBalance(asset_id, mode?, options?): Promise<Decimal>
Get the claimable balance for the supplied asset.
Parameters
- asset_id: string
  The asset to check claimable balance for.
- mode: StakeOptionsMode = StakeOptionsMode.DEFAULT
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  } = {}
  Additional options for getting the claimable balance.
  - [key: string]: string
Returns Promise<Decimal>
The claimable balance.
Inherited from Address.claimableBalance
- Defined in src/coinbase/address.ts:273

`Private` copyOptions

copyOptions(options?): {
[key: string]: string;
}
Private
Create a shallow copy of given options.
Parameters
- Optional options: {
  [key: string]: string;
  }
  The supplied options to be copied
  - [key: string]: string
Returns {
[key: string]: string;
}
A copy of the options.
- [key: string]: string
Inherited from Address.copyOptions
- Defined in src/coinbase/address.ts:434

createClaimStake

createClaimStake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>
Creates a staking operation to claim stake.
Parameters
- amount: Amount
  The amount to claim stake.
- assetId: string
  The asset to claim stake.
- mode: StakeOptionsMode = StakeOptionsMode.DEFAULT
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  } = {}
  Additional options for the claim stake operation.
  
  A. Shared ETH Staking
  - integrator_contract_address (optional): The contract address to which the claim stake operation is directed to. Defaults to the integrator contract address associated with CDP account (if available) or else defaults to a shared integrator contract address for that network.
  - [key: string]: string
- timeoutSeconds: number = 600
  The amount to wait for the transaction to complete when broadcasted.
- intervalSeconds: number = 0.2
  The amount to check each time for a successful broadcast.
Returns Promise<StakingOperation>
The staking operation after it's completed successfully.
- Defined in src/coinbase/address/wallet_address.ts:746

`Private` createContractInvocation

createContractInvocation(contractAddress, method, abi, args, atomicAmount?): Promise<ContractInvocation>
Creates a contract invocation with the given data.
Parameters
- contractAddress: string
  The address of the contract the method will be invoked on.
- method: string
  The method to invoke on the contract.
- abi: object
  The ABI of the contract.
- args: object
  The arguments to pass to the contract method invocation. The keys should be the argument names and the values should be the argument values.
- Optional atomicAmount: string
  The atomic amount of the native asset to send to a payable contract method.
Returns Promise<ContractInvocation>
The ContractInvocation object.

Throws
if the API request to create a contract invocation fails.
- Defined in src/coinbase/address/wallet_address.ts:630

`Private` createCustomContract

createCustomContract(options): Promise<SmartContract>
Private
Creates a custom contract.
Parameters
- options: CreateCustomContractOptions
  The options for creating the custom contract.
Returns Promise<SmartContract>
A Promise that resolves to the created SmartContract.

Throws
If the API request to compile or subsequently create a smart contract fails.
- Defined in src/coinbase/address/wallet_address.ts:591

`Private` createERC1155

createERC1155(options): Promise<SmartContract>
Private
Creates an ERC1155 multi-token contract.
Parameters
- options: CreateERC1155Options
  The options for creating the ERC1155 token.
Returns Promise<SmartContract>
A Promise that resolves to the created SmartContract.

Throws
If the API request to create a smart contract fails.
- Defined in src/coinbase/address/wallet_address.ts:565

`Private` createERC20

createERC20(options): Promise<SmartContract>
Private
Creates an ERC20 token contract.
Parameters
- options: CreateERC20Options
  The options for creating the ERC20 token.
Returns Promise<SmartContract>
A Promise that resolves to the created SmartContract.

Throws
If the API request to create a smart contract fails.
- Defined in src/coinbase/address/wallet_address.ts:506

`Private` createERC721

createERC721(options): Promise<SmartContract>
Creates an ERC721 token contract.
Parameters
- options: CreateERC721Options
  The options for creating the ERC721 token.
Returns Promise<SmartContract>
A Promise that resolves to the deployed SmartContract object.

Throws
If the private key is not loaded when not using server signer.
- Defined in src/coinbase/address/wallet_address.ts:536

createPayloadSignature

createPayloadSignature(unsignedPayload): Promise<PayloadSignature>
Creates a Payload Signature.
Parameters
- unsignedPayload: string
  The Unsigned Payload to sign.
Returns Promise<PayloadSignature>
A promise that resolves to the Payload Signature object.

Throws
if the API request to create a Payload Signature fails.

Throws
if the address does not have a private key loaded or an associated Server-Signer.
- Defined in src/coinbase/address/wallet_address.ts:774

createStake

createStake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>
Creates a staking operation to stake.
Parameters
- amount: Amount
  The amount to stake.
- assetId: string
  The asset to stake.
- mode: StakeOptionsMode = StakeOptionsMode.DEFAULT
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  } = {}
  Additional options for the stake operation:
  
  A. Shared ETH Staking
  - integrator_contract_address (optional): The contract address to which the stake operation is directed to. Defaults to the integrator contract address associated with CDP account (if available) or else defaults to a shared integrator contract address for that network.
  B. Dedicated ETH Staking
  - funding_address (optional): Ethereum address for funding the stake operation. Defaults to the address initiating the stake operation.
  - withdrawal_address (optional): Ethereum address for receiving rewards and withdrawal funds. Defaults to the address initiating the stake operation.
  - fee_recipient_address (optional): Ethereum address for receiving transaction fees. Defaults to the address initiating the stake operation.
  - [key: string]: string
- timeoutSeconds: number = 600
  The amount to wait for the transaction to complete when broadcasted.
- intervalSeconds: number = 0.2
  The amount to check each time for a successful broadcast.
Returns Promise<StakingOperation>
The staking operation after it's completed successfully.
- Defined in src/coinbase/address/wallet_address.ts:672

`Private` createStakingOperation

createStakingOperation(amount, assetId, action, mode, options, timeoutSeconds, intervalSeconds): Promise<StakingOperation>
Creates a staking operation to stake, signs it, and broadcasts it on the blockchain.
Parameters
- amount: Amount
  The amount for the staking operation.
- assetId: string
  The asset to the staking operation.
- action: string
  The type of staking action to perform.
- mode: StakeOptionsMode
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  }
  Additional options such as setting the mode for the staking action.
  - [key: string]: string
- timeoutSeconds: number
  The amount to wait for the transaction to complete when broadcasted.
- intervalSeconds: number
  The amount to check each time for a successful broadcast.
Returns Promise<StakingOperation>
The staking operation after it's completed fully.

Throws
if the API request to create or broadcast staking operation fails.

Throws
if the amount is less than zero.
- Defined in src/coinbase/address/wallet_address.ts:1002

`Private` createStakingOperationRequest

createStakingOperationRequest(amount, assetId, action, mode?, options?): Promise<StakingOperation>
Private
A helper function that creates the staking operation.
Parameters
- amount: Amount
  The amount for the staking operation.
- assetId: string
  The asset for the staking operation.
- action: string
  The type of staking action to perform.
- mode: StakeOptionsMode = StakeOptionsMode.DEFAULT
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  } = {}
  Additional options such as setting the mode for the staking action.
  - [key: string]: string
Returns Promise<StakingOperation>
The created staking operation.

Throws
if the API request to create staking operation fails.
- Defined in src/coinbase/address/wallet_address.ts:1066

createTrade

createTrade(options): Promise<Trade>
Trades the given amount of the given Asset for another Asset. Only same-network Trades are supported.
Parameters
- options: CreateTradeOptions
  The options to create the Trade.
Returns Promise<Trade>
The Trade object.

Throws
if the API request to create or broadcast a Trade fails.

Throws
if the Trade times out.
- Defined in src/coinbase/address/wallet_address.ts:289

`Private` createTradeRequest

createTradeRequest(amount, fromAsset, toAsset): Promise<Trade>
Creates a trade model for the specified amount and assets.
Parameters
- amount: Amount
  The amount of the Asset to send.
- fromAsset: Asset
  The Asset to trade from.
- toAsset: Asset
  The Asset to trade to.
Returns Promise<Trade>
A promise that resolves to a Trade object representing the new trade.
- Defined in src/coinbase/address/wallet_address.ts:950

createTransfer

createTransfer(options): Promise<Transfer>
Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported. This returns a Transfer object that has been signed and broadcasted, you can wait for this to land on-chain (or fail) by calling transfer.wait().
Parameters
- options: CreateTransferOptions
  The options to create the Transfer.
Returns Promise<Transfer>
The transfer object.

Throws
if the API request to create a Transfer fails.

Throws
if the API request to broadcast a Transfer fails.
- Defined in src/coinbase/address/wallet_address.ts:212

createUnstake

createUnstake(amount, assetId, mode?, options?, timeoutSeconds?, intervalSeconds?): Promise<StakingOperation>
Creates a staking operation to unstake.
Parameters
- amount: Amount
  The amount to unstake.
- assetId: string
  The asset to unstake.
- mode: StakeOptionsMode = StakeOptionsMode.DEFAULT
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  } = {}
  Additional options for the unstake operation:
  
  A. Shared ETH Staking
  - integrator_contract_address (optional): The contract address to which the unstake operation is directed to. Defaults to the integrator contract address associated with CDP account (if available) or else defaults to a shared integrator contract address for that network.
  B. Dedicated ETH Staking
  - immediate (optional): Set this to "true" to unstake immediately i.e. leverage "Coinbase managed unstake" process . Defaults to "false" i.e. "User managed unstake" process.
  - validator_pub_keys (optional): List of comma separated validator public keys to unstake. Defaults to validators being picked up on your behalf corresponding to the unstake amount.
  - [key: string]: string
- timeoutSeconds: number = 600
  The amount to wait for the transaction to complete when broadcasted.
- intervalSeconds: number = 0.2
  The amount to check each time for a successful broadcast.
Returns Promise<StakingOperation>
The staking operation after it's completed successfully.
- Defined in src/coinbase/address/wallet_address.ts:711

deployContract

deployContract(options): Promise<SmartContract>
Deploys a custom contract.
Parameters
- options: CreateCustomContractOptions
  The options for creating the custom contract.
Returns Promise<SmartContract>
A Promise that resolves to the deployed SmartContract object.

Throws
If the API request to create a smart contract fails.
- Defined in src/coinbase/address/wallet_address.ts:468

deployMultiToken

deployMultiToken(options): Promise<SmartContract>
Deploys an ERC1155 multi-token contract.
Parameters
- options: CreateERC1155Options
  The options for creating the ERC1155 token.
Returns Promise<SmartContract>
A Promise that resolves to the deployed SmartContract object.

Throws
If the API request to create a smart contract fails.
- Defined in src/coinbase/address/wallet_address.ts:440

deployNFT

deployNFT(options): Promise<SmartContract>
Deploys an ERC721 token contract.
Parameters
- options: CreateERC721Options
  The options for creating the ERC721 token.
Returns Promise<SmartContract>
A Promise that resolves to the deployed SmartContract object.

Throws
If the API request to create a smart contract fails.
- Defined in src/coinbase/address/wallet_address.ts:415

deployToken

deployToken(options): Promise<SmartContract>
Deploys an ERC20 token contract.
Parameters
- options: CreateERC20Options
  The options for creating the ERC20 token.
Returns Promise<SmartContract>
A Promise that resolves to the deployed SmartContract object.

Throws
If the API request to create a smart contract fails.
- Defined in src/coinbase/address/wallet_address.ts:384

export

export(): string
Exports the Address's private key to a hex string.

Returns string
The Address's private key as a hex string.
- Defined in src/coinbase/address/wallet_address.ts:95

faucet

faucet(assetId?): Promise<FaucetTransaction>
Requests faucet funds for the address. Only supported on testnet networks.
Parameters
- Optional assetId: string
  The ID of the asset to transfer from the faucet.
Returns Promise<FaucetTransaction>
The faucet transaction object.

Throws
If the request does not return a transaction hash.

Throws
If the request fails.
Inherited from Address.faucet
- Defined in src/coinbase/address.ts:308

fund

fund(options): Promise<FundOperation>
Fund the address from your account on the Coinbase Platform.
Parameters
- options: CreateFundOptions
  The options to create the fund operation
Returns Promise<FundOperation>
The created fund operation object
- Defined in src/coinbase/address/wallet_address.ts:870

getBalance

getBalance(assetId): Promise<Decimal>
Returns the balance of the provided asset.
Parameters
- assetId: string
  The asset ID.
Returns Promise<Decimal>
The balance of the asset.
Inherited from Address.getBalance
- Defined in src/coinbase/address.ts:80

`Private` getDestinationAddressAndNetwork

getDestinationAddressAndNetwork(destination): Promise<[string, string]>
Returns the address and network ID of the given destination.
Parameters
- destination: Destination
  The destination to get the address and network ID of.
Returns Promise<[string, string]>
The address and network ID of the destination.
- Defined in src/coinbase/address/wallet_address.ts:927

getId

getId(): string
Returns the address ID.

Returns string
The address ID.
Inherited from Address.getId
- Defined in src/coinbase/address.ts:56

getNetworkId

getNetworkId(): string
Returns the network ID.

Returns string
The network ID.
Inherited from Address.getNetworkId
- Defined in src/coinbase/address.ts:47

getPayloadSignature

getPayloadSignature(payloadSignatureId): Promise<PayloadSignature>
Gets a Payload Signature.
Parameters
- payloadSignatureId: string
  The ID of the Payload Signature to fetch.
Returns Promise<PayloadSignature>
A promise that resolves to the Payload Signature object.

Throws
if the API request to get the Payload Signature fails.
- Defined in src/coinbase/address/wallet_address.ts:807

`Private` getSigner

getSigner(): Wallet
Gets a signer for the private key.

Returns Wallet
The signer for the private key.

Throws
If the private key is not loaded.
- Defined in src/coinbase/address/wallet_address.ts:271

getWalletId

getWalletId(): string
Returns the wallet ID.

Returns string
The wallet ID.
- Defined in src/coinbase/address/wallet_address.ts:73

historicalStakingBalances

historicalStakingBalances(assetId, startTime?, endTime?): Promise<StakingBalance[]>
Lists the historical staking balances for the address.
Parameters
- assetId: string
  The asset ID.
- startTime: string = ...
  The start time.
- endTime: string = ...
  The end time.
Returns Promise<StakingBalance[]>
The staking balances.
Inherited from Address.historicalStakingBalances
- Defined in src/coinbase/address.ts:215

invokeContract

invokeContract(options): Promise<ContractInvocation>
Invokes a contract with the given data.
Parameters
- options: CreateContractInvocationOptions
  The options to invoke the contract
Returns Promise<ContractInvocation>
The ContractInvocation object.

Throws
if the API request to create a contract invocation fails.

Throws
if the address cannot sign.

Throws
if the address does not have sufficient balance.
- Defined in src/coinbase/address/wallet_address.ts:324

listBalances

listBalances(): Promise<BalanceMap>
Returns the list of balances for the address.

Returns Promise<BalanceMap>
The map from asset ID to balance.
Inherited from Address.listBalances
- Defined in src/coinbase/address.ts:65

listFundOperations

listFundOperations(options?): Promise<PaginationResponse<FundOperation>>
Returns all the fund operations associated with the address.
Parameters
- options: PaginationOptions = {}
  The pagination options.
Returns Promise<PaginationResponse<FundOperation>>
The paginated list response of fund operations.
- Defined in src/coinbase/address/wallet_address.ts:911

listHistoricalBalances

listHistoricalBalances(assetId, options?): Promise<PaginationResponse<HistoricalBalance>>
Returns the historical balances of the provided asset.
Parameters
- assetId: string
  The asset ID.
- options: PaginationOptions = {}
  The pagination options.
Returns Promise<PaginationResponse<HistoricalBalance>>
The paginated list response of Historical Balances for the given Asset ID.
Inherited from Address.listHistoricalBalances
- Defined in src/coinbase/address.ts:104

listPayloadSignatures

listPayloadSignatures(options?): Promise<PaginationResponse<PayloadSignature>>
Lists all the Payload Signatures associated with the Address.
Parameters
- options: PaginationOptions = {}
  The pagination options.
Returns Promise<PaginationResponse<PayloadSignature>>
A promise that resolves to the paginated list response of Payload Signatures.

Throws
if the API request to list the Payload Signatures fails.
- Defined in src/coinbase/address/wallet_address.ts:829

listTrades

listTrades(options?): Promise<PaginationResponse<Trade>>
Returns all the trades associated with the address.
Parameters
- options: PaginationOptions = {}
  The pagination options.
Returns Promise<PaginationResponse<Trade>>
The paginated list response of trades.
- Defined in src/coinbase/address/wallet_address.ts:121

listTransactions

listTransactions(options?): Promise<PaginationResponse<Transaction>>
Returns the transactions of the address.
Parameters
- options: PaginationOptions = {}
  The pagination options.
Returns Promise<PaginationResponse<Transaction>>
The paginated list response of Transactions.
Inherited from Address.listTransactions
- Defined in src/coinbase/address.ts:148

listTransfers

listTransfers(options?): Promise<PaginationResponse<Transfer>>
Returns all the transfers associated with the address.
Parameters
- options: PaginationOptions = {}
  The pagination options.
Returns Promise<PaginationResponse<Transfer>>
The paginated list response of transfers.
- Defined in src/coinbase/address/wallet_address.ts:163

pendingClaimableBalance

pendingClaimableBalance(asset_id, mode?, options?): Promise<Decimal>
Get the pending claimable balance for the supplied asset.
Parameters
- asset_id: string
  The asset to check pending claimable balance for.
- mode: StakeOptionsMode = StakeOptionsMode.DEFAULT
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  } = {}
  Additional options for getting the pending claimable balance.
  - [key: string]: string
Returns Promise<Decimal>
The pending claimable balance.
Inherited from Address.pendingClaimableBalance
- Defined in src/coinbase/address.ts:290

quoteFund

quoteFund(options): Promise<FundQuote>
Get a quote for funding the address from your Coinbase platform account.
Parameters
- options: CreateFundOptions
  The options to create the fund quote
Returns Promise<FundQuote>
The fund quote object
- Defined in src/coinbase/address/wallet_address.ts:890

reputation

reputation(): Promise<AddressReputation>
Returns the reputation of the Address.

Returns Promise<AddressReputation>
The reputation of the Address.

Throws
if the API request to get the Address reputation fails.

Throws
if the Address reputation is not available.
Inherited from Address.reputation
- Defined in src/coinbase/address.ts:325

setKey

setKey(key): void
Sets the private key.
Parameters
- key: Wallet
  The ethers.js SigningKey the Address uses to sign data.
Returns void
Throws
If the private key is already set.
- Defined in src/coinbase/address/wallet_address.ts:83

stakeableBalance

stakeableBalance(asset_id, mode?, options?): Promise<Decimal>
Get the stakeable balance for the supplied asset.
Parameters
- asset_id: string
  The asset to check the stakeable balance for.
- mode: StakeOptionsMode = StakeOptionsMode.DEFAULT
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  } = {}
  Additional options for getting the stakeable balance.
  - [key: string]: string
Returns Promise<Decimal>
The stakeable balance.
Inherited from Address.stakeableBalance
- Defined in src/coinbase/address.ts:237

stakingRewards

stakingRewards(assetId, startTime?, endTime?, format?): Promise<StakingReward[]>
Lists the staking rewards for the address.
Parameters
- assetId: string
  The asset ID.
- startTime: string = ...
  The start time.
- endTime: string = ...
  The end time.
- format: StakingRewardFormat = StakingRewardFormat.USD
  The format to return the rewards in. (usd, native). Defaults to usd.
Returns Promise<StakingReward[]>
The staking rewards.
Inherited from Address.stakingRewards
- Defined in src/coinbase/address.ts:191

toString

toString(): string
Returns a string representation of the wallet address.

Returns string
A string representing the wallet address.
Overrides Address.toString
- Defined in src/coinbase/address/wallet_address.ts:64

unstakeableBalance

unstakeableBalance(asset_id, mode?, options?): Promise<Decimal>
Get the unstakeable balance for the supplied asset.
Parameters
- asset_id: string
  The asset to check the unstakeable balance for.
- mode: StakeOptionsMode = StakeOptionsMode.DEFAULT
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  } = {}
  Additional options for getting the unstakeable balance. A. Dedicated ETH Staking
  - validator_pub_keys (optional): List of comma separated validator public keys to retrieve unstakeable balance for. Defaults to all validators.
  - [key: string]: string
Returns Promise<Decimal>
The unstakeable balance.
Inherited from Address.unstakeableBalance
- Defined in src/coinbase/address.ts:256

`Private` validateCanClaimStake

validateCanClaimStake(amount, assetId, mode, options): Promise<void>
Private
Validate if the operation is able to claim stake with the supplied input.
Parameters
- amount: Amount
  The amount of the asset to claim stake.
- assetId: string
  The asset to claim stake.
- mode: StakeOptionsMode
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  }
  Additional options for the claim stake operation.
  - [key: string]: string
Returns Promise<void>
Throws
If the supplied input is not able to create a claim stake operation.
Inherited from Address.validateCanClaimStake
- Defined in src/coinbase/address.ts:408

`Private` validateCanStake

validateCanStake(amount, assetId, mode, options): Promise<void>
Private
Validate if the operation is able to stake with the supplied input.
Parameters
- amount: Amount
  The amount of the asset to stake.
- assetId: string
  The asset to stake.
- mode: StakeOptionsMode
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  }
  Additional options for the stake operation.
  - [key: string]: string
Returns Promise<void>
Throws
If the supplied input is not able to create a stake operation.
Inherited from Address.validateCanStake
- Defined in src/coinbase/address.ts:358

`Private` validateCanTrade

validateCanTrade(amount, fromAssetId): Promise<void>
Checks if trading is possible and raises an error if not.
Parameters
- amount: Amount
  The amount of the Asset to send.
- fromAssetId: string
  The ID of the Asset to trade from. For Ether, eth, gwei, and wei are supported.
Returns Promise<void>
Throws
If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds.
- Defined in src/coinbase/address/wallet_address.ts:975

`Private` validateCanUnstake

validateCanUnstake(amount, assetId, mode, options): Promise<void>
Private
Validate if the operation is able to unstake with the supplied input.
Parameters
- amount: Amount
  The amount of the asset to unstake.
- assetId: string
  The asset to unstake.
- mode: StakeOptionsMode
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  }
  Additional options for the unstake operation.
  - [key: string]: string
Returns Promise<void>
Throws
If the supplied input is not able to create an unstake operation.
Inherited from Address.validateCanUnstake
- Defined in src/coinbase/address.ts:383

Class WalletAddress

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WalletAddress

Throws

Properties

Protected Optional _reputation

Protected id

Private Optional key

Private model

Protected networkId

Methods

Private broadcastStakingOperationRequest

Parameters

Returns Promise<StakingOperation>

canSign

Returns boolean

claimableBalance

Parameters

[key: string]: string

Returns Promise<Decimal>

Private copyOptions

Parameters

[key: string]: string

Returns { [key: string]: string; }

[key: string]: string

createClaimStake

Parameters

[key: string]: string

Returns Promise<StakingOperation>

Private createContractInvocation

Parameters

Returns Promise<ContractInvocation>

Throws

Private createCustomContract

Parameters

Returns Promise<SmartContract>

Throws

Private createERC1155

Parameters

Returns Promise<SmartContract>

Throws

Private createERC20

Parameters

Returns Promise<SmartContract>

Throws

Private createERC721

Parameters

Returns Promise<SmartContract>

Throws

createPayloadSignature

Parameters

Returns Promise<PayloadSignature>

Throws

Throws

createStake

Parameters

[key: string]: string

Returns Promise<StakingOperation>

Private createStakingOperation

Parameters

[key: string]: string

Returns Promise<StakingOperation>

Throws

Throws

Private createStakingOperationRequest

Parameters

[key: string]: string

Returns Promise<StakingOperation>

Throws

createTrade

Parameters

Returns Promise<Trade>

Throws

`Protected` `Optional` _reputation

`Protected` id

`Private` `Optional` key

`Private` model

`Protected` networkId

`Private` broadcastStakingOperationRequest

`Private` copyOptions

Returns {
[key: string]: string;
}

`Private` createContractInvocation

`Private` createCustomContract

`Private` createERC1155

`Private` createERC20

`Private` createERC721

`Private` createStakingOperation

`Private` createStakingOperationRequest

`Private` createTradeRequest

`Private` getDestinationAddressAndNetwork

`Private` getSigner