Class ExternalAddress

A representation of a blockchain Address, which is a user-controlled account on a Network. Addresses are used to send and receive Assets. An ExternalAddress is an Address that is not controlled by the developer, but is instead controlled by the user.

Hierarchy (view full)

Address
- ExternalAddress

Constructors

constructor

new ExternalAddress(networkId, id): ExternalAddress
Initializes a new Address instance.
Parameters
- networkId: string
  The network id.
- id: string
  The onchain address id.
Returns ExternalAddress
Inherited from Address.constructor
- Defined in src/coinbase/address.ts:37

Properties

`Protected` `Optional` _reputation

_reputation?: AddressReputation

`Protected` id

id: string

`Protected` networkId

networkId: string

Methods

broadcastExternalTransaction

broadcastExternalTransaction(signedPayload): Promise<BroadcastExternalTransactionResponse>
Broadcast an external transaction
Parameters
- signedPayload: string
  The signed payload of the transaction to broadcast
Returns Promise<BroadcastExternalTransactionResponse>
The broadcasted transaction
- Defined in src/coinbase/address/external_address.ts:142

buildClaimStakeOperation

buildClaimStakeOperation(amount, assetId, mode?, options?): Promise<StakingOperation>
Builds a claim stake operation for the supplied asset.
Parameters
- amount: Amount
  The amount of the asset 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
Returns Promise<StakingOperation>
The claim stake operation.
- Defined in src/coinbase/address/external_address.ts:83

buildStakeOperation

buildStakeOperation(amount, assetId, mode?, options?): Promise<StakingOperation>
Builds a stake operation for the supplied asset. The stake operation may take a few minutes to complete in the case when infrastructure is spun up.
Parameters
- amount: Amount
  The amount of the asset 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
Returns Promise<StakingOperation>
The stake operation.
- Defined in src/coinbase/address/external_address.ts:33

`Private` buildStakingOperation

buildStakingOperation(amount, assetId, action, mode, options): Promise<StakingOperation>
Private
Builds the staking operation based on the supplied input.
Parameters
- amount: Amount
  The amount for the staking operation.
- assetId: string
  The asset for the staking operation.
- action: string
  The specific action for the staking operation. e.g. stake, unstake, claim_stake
- mode: StakeOptionsMode
  The staking mode. Defaults to DEFAULT.
- options: {
  [key: string]: string;
  }
  Additional options to build a stake operation.
  - [key: string]: string
Returns Promise<StakingOperation>
The staking operation.

Throws
If the supplied input cannot build a valid staking operation.
- Defined in src/coinbase/address/external_address.ts:105

buildUnstakeOperation

buildUnstakeOperation(amount, assetId, mode?, options?): Promise<StakingOperation>
Builds an unstake operation for the supplied asset.
Parameters
- amount: Amount
  The amount of the asset 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
Returns Promise<StakingOperation>
The unstake operation.
- Defined in src/coinbase/address/external_address.ts:60

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

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

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

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

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

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

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

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

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

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

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

Returns string
A string representing the address.
Inherited from Address.toString
- Defined in src/coinbase/address.ts:344

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` 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 ExternalAddress

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ExternalAddress

Properties

Protected Optional _reputation

Protected id

Protected networkId

Methods

broadcastExternalTransaction

Parameters

Returns Promise<BroadcastExternalTransactionResponse>

buildClaimStakeOperation

Parameters

[key: string]: string

Returns Promise<StakingOperation>

buildStakeOperation

Parameters

[key: string]: string

Returns Promise<StakingOperation>

Private buildStakingOperation

Parameters

[key: string]: string

Returns Promise<StakingOperation>

Throws

buildUnstakeOperation

Parameters

[key: string]: string

Returns Promise<StakingOperation>

claimableBalance

Parameters

[key: string]: string

Returns Promise<Decimal>

Private copyOptions

Parameters

[key: string]: string

Returns { [key: string]: string; }

[key: string]: string

faucet

Parameters

Returns Promise<FaucetTransaction>

Throws

Throws

getBalance

Parameters

Returns Promise<Decimal>

getId

Returns string

getNetworkId

Returns string

historicalStakingBalances

Parameters

Returns Promise<StakingBalance[]>

listBalances

Returns Promise<BalanceMap>

listHistoricalBalances

Parameters

Returns Promise<PaginationResponse<HistoricalBalance>>

listTransactions

Parameters

Returns Promise<PaginationResponse<Transaction>>

pendingClaimableBalance

Parameters

[key: string]: string

Returns Promise<Decimal>

reputation

Returns Promise<AddressReputation>

Throws

Throws

stakeableBalance

Parameters

[key: string]: string

Returns Promise<Decimal>

stakingRewards

`Protected` `Optional` _reputation

`Protected` id

`Protected` networkId

`Private` buildStakingOperation

`Private` copyOptions

Returns {
[key: string]: string;
}

`Private` validateCanClaimStake

`Private` validateCanStake

`Private` validateCanUnstake