Class: Coinbase::WalletAddress

Inherits:
Address
  • Object
show all
Defined in:
lib/coinbase/address/wallet_address.rb

Overview

A representation of a blockchain Address that belongs to a Coinbase::Wallet. Addresses are used to send and receive Assets, and should be created using Wallet#create_address. Addresses require an Eth::Key to sign transaction data.

Instance Attribute Summary

Attributes inherited from Address

#id, #network

Instance Method Summary collapse

Methods inherited from Address

#balance, #balances, #build_claim_stake_operation, #build_stake_operation, #build_unstake_operation, #claimable_balance, #faucet, #historical_balances, #historical_staking_balances, #inspect, #stakeable_balance, #staking_balances, #staking_rewards, #unstakeable_balance

Constructor Details

#initialize(model, key) ⇒ WalletAddress

Returns a new Address object. Do not use this method directly. Instead, use Wallet#create_address, or use the Wallet’s default_address.

Parameters:

  • model (Coinbase::Client::Address) —

    The underlying Address object

  • key (Eth::Key) —

    The key backing the Address. Can be nil.



15
16
17
18
19
20
 
# File 'lib/coinbase/address/wallet_address.rb', line 15

def initialize(model, key)
  @model = model
  @key = key

  super(model.network_id, model.address_id)
end

Instance Method Details

#can_sign? ⇒ 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.



154
155
156
 
# File 'lib/coinbase/address/wallet_address.rb', line 154

def can_sign?
  !@key.nil?
end

#claim_stake(amount, asset_id, mode: :default, options: {}, interval_seconds: 5, timeout_seconds: 600) ⇒ Coinbase::StakingOperation

Claims the given amount of the given Asset

Parameters:

  • amount (Integer, Float, BigDecimal) —

    The amount of the Asset to claim.

  • asset_id (Symbol) —

    The ID of the Asset to stake. For Ether, :eth, :gwei, and :wei are supported.

  • mode (Symbol) (defaults to: :default) —

    The staking mode. Defaults to :default.

  • options (Hash) (defaults to: {}) —

    (Optional) Additional options for the claim_stake operation. (see_more)

  • interval_seconds (Integer) (defaults to: 5) —

    The number of seconds to wait between polling for updates. Defaults to 5.

  • timeout_seconds (Integer) (defaults to: 600) —

    The number of seconds to wait before timing out. Defaults to 600.

Returns:

Raises:

  • (Timeout::Error) —

    if the Staking Operation takes longer than the given timeout.



144
145
146
147
148
149
150
 
# File 'lib/coinbase/address/wallet_address.rb', line 144

def claim_stake(amount, asset_id, mode: :default, options: {}, interval_seconds: 5, timeout_seconds: 600)
  validate_can_perform_staking_action!(amount, asset_id, 'claimable_balance', mode, options)

  op = StakingOperation.create(amount, network, asset_id, id, wallet_id, 'claim_stake', mode, options)

  op.complete(@key, interval_seconds: interval_seconds, timeout_seconds: timeout_seconds)
end

#export ⇒ String

Exports the Address’s private key to a hex string.

Returns:

  • (String) —

    The Address’s private key as a hex String



160
161
162
163
164
 
# File 'lib/coinbase/address/wallet_address.rb', line 160

def export
  raise 'Cannot export key without private key loaded' if @key.nil?

  @key.private_hex
end

#key=(key) ⇒ Object

Sets the private key backing the Address. This key is used to sign transactions.

Parameters:

  • key (Eth::Key) —

    The key backing the Address



30
31
32
33
34
 
# File 'lib/coinbase/address/wallet_address.rb', line 30

def key=(key)
  raise 'Private key is already set' unless @key.nil?

  @key = key
end

#stake(amount, asset_id, mode: :default, options: {}, interval_seconds: 5, timeout_seconds: 600) ⇒ Coinbase::StakingOperation

Stakes the given amount of the given Asset. The stake operation may take a few minutes to complete in the case when infrastructure is spun up.

Parameters:

  • amount (Integer, Float, BigDecimal) —

    The amount of the Asset to stake.

  • asset_id (Symbol) —

    The ID of the Asset to stake. For Ether, :eth, :gwei, and :wei are supported.

  • mode (Symbol) (defaults to: :default) —

    The staking mode. Defaults to :default.

  • options (Hash) (defaults to: {}) —

    (Optional) Additional options for the stake operation. (see_more)

  • interval_seconds (Integer) (defaults to: 5) —

    The number of seconds to wait between polling for updates. Defaults to 5.

  • timeout_seconds (Integer) (defaults to: 600) —

    The number of seconds to wait before timing out. Defaults to 600.

Returns:

Raises:

  • (Timeout::Error) —

    if the Staking Operation takes longer than the given timeout.



108
109
110
111
112
113
114
 
# File 'lib/coinbase/address/wallet_address.rb', line 108

def stake(amount, asset_id, mode: :default, options: {}, interval_seconds: 5, timeout_seconds: 600)
  validate_can_perform_staking_action!(amount, asset_id, 'stakeable_balance', mode, options)

  op = StakingOperation.create(amount, network, asset_id, id, wallet_id, 'stake', mode, options)

  op.complete(@key, interval_seconds: interval_seconds, timeout_seconds: timeout_seconds)
end

#to_s ⇒ String

Returns a String representation of the WalletAddress.

Returns:

  • (String) —

    a String representation of the WalletAddress



184
185
186
 
# File 'lib/coinbase/address/wallet_address.rb', line 184

def to_s
  "Coinbase::Address{id: '#{id}', network_id: '#{network.id}', wallet_id: '#{wallet_id}'}"
end

#trade(amount, from_asset_id, to_asset_id) ⇒ Coinbase::Trade

Trades the given amount of the given Asset for another Asset. Only same-network Trades are supported.

Parameters:

  • amount (Integer, Float, BigDecimal) —

    The amount of the Asset to send.

  • from_asset_id (Symbol) —

    The ID of the Asset to trade from. For Ether, :eth, :gwei, and :wei are supported.

  • to_asset_id (Symbol) —

    The ID of the Asset to trade to. For Ether, :eth, :gwei, and :wei are supported.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/coinbase/address/wallet_address.rb', line 74

def trade(amount, from_asset_id, to_asset_id)
  ensure_can_sign!
  ensure_sufficient_balance!(amount, from_asset_id)

  trade = Trade.create(
    address_id: id,
    amount: amount,
    from_asset_id: from_asset_id,
    to_asset_id: to_asset_id,
    network: network,
    wallet_id: wallet_id
  )

  # If a server signer is managing keys, it will sign and broadcast the underlying trade transaction out of band.
  return trade if Coinbase.use_server_signer?

  trade.transactions.each do |tx|
    tx.sign(@key)
  end

  trade.broadcast!
  trade
end

#trades ⇒ Enumerable<Coinbase::Trade>

Enumerates the trades associated with the address. The result is an enumerator that lazily fetches from the server, and can be iterated over, converted to an array, etc…

Returns:

  • (Enumerable<Coinbase::Trade>) —

    Enumerator that returns the address’s trades



178
179
180
 
# File 'lib/coinbase/address/wallet_address.rb', line 178

def trades
  Trade.list(wallet_id: wallet_id, address_id: id)
end

#transfer(amount, asset_id, destination, gasless: false) ⇒ Coinbase::Transfer

Transfers the given amount of the given Asset to the specified address or wallet. Only same-network Transfers are supported. Whether the transfer should be gasless. Defaults to false.

Parameters:

  • amount (Integer, Float, BigDecimal) —

    The amount of the Asset to send.

  • asset_id (Symbol) —

    The ID of the Asset to send. For Ether, :eth, :gwei, and :wei are supported.

  • destination (Wallet | Address | String) —

    The destination of the transfer. If a Wallet, sends to the Wallet’s default address. If a String, interprets it as the address ID.

  • gasless (Boolean) (defaults to: false) —

    Whether gas fee for the transfer should be covered by Coinbase. Defaults to false. Check the API documentation for network and asset support.

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/coinbase/address/wallet_address.rb', line 46

def transfer(amount, asset_id, destination, gasless: false)
  ensure_can_sign!
  ensure_sufficient_balance!(amount, asset_id)

  transfer = Transfer.create(
    address_id: id,
    amount: amount,
    asset_id: asset_id,
    destination: destination,
    network: network,
    wallet_id: wallet_id,
    gasless: gasless
  )

  # If a server signer is managing keys, it will sign and broadcast the underlying transfer transaction out of band.
  return transfer if Coinbase.use_server_signer?

  transfer.sign(@key)
  transfer.broadcast!
  transfer
end

#transfers ⇒ Enumerable<Coinbase::Transfer>

Enumerates the transfers associated with the address. The result is an enumerator that lazily fetches from the server, and can be iterated over, converted to an array, etc…

Returns:



170
171
172
 
# File 'lib/coinbase/address/wallet_address.rb', line 170

def transfers
  Transfer.list(wallet_id: wallet_id, address_id: id)
end

#unstake(amount, asset_id, mode: :default, options: {}, interval_seconds: 5, timeout_seconds: 600) ⇒ Coinbase::StakingOperation

Unstakes the given amount of the given Asset

Parameters:

  • amount (Integer, Float, BigDecimal) —

    The amount of the Asset to unstake.

  • asset_id (Symbol) —

    The ID of the Asset to stake. For Ether, :eth, :gwei, and :wei are supported.

  • mode (Symbol) (defaults to: :default) —

    The staking mode. Defaults to :default.

  • options (Hash) (defaults to: {}) —

    (Optional) Additional options for the unstake operation. (see_more)

  • interval_seconds (Integer) (defaults to: 5) —

    The number of seconds to wait between polling for updates. Defaults to 5.

  • timeout_seconds (Integer) (defaults to: 600) —

    The number of seconds to wait before timing out. Defaults to 600.

Returns:

Raises:

  • (Timeout::Error) —

    if the Staking Operation takes longer than the given timeout.



126
127
128
129
130
131
132
 
# File 'lib/coinbase/address/wallet_address.rb', line 126

def unstake(amount, asset_id, mode: :default, options: {}, interval_seconds: 5, timeout_seconds: 600)
  validate_can_perform_staking_action!(amount, asset_id, 'unstakeable_balance', mode, options)

  op = StakingOperation.create(amount, network, asset_id, id, wallet_id, 'unstake', mode, options)

  op.complete(@key, interval_seconds: interval_seconds, timeout_seconds: timeout_seconds)
end

#wallet_id ⇒ String

Returns the Wallet ID of the Address.

Returns:

  • (String) —

    The Wallet ID



24
25
26
 
# File 'lib/coinbase/address/wallet_address.rb', line 24

def wallet_id
  @model.wallet_id
end