Method: Coinbase::Address#faucet

Defined in:

lib/coinbase/address.rb

#faucet(asset_id: nil) ⇒ Coinbase::FaucetTransaction

Requests funds for the address from the faucet and returns the faucet transaction. This is only supported on testnet networks.

Parameters:

• asset_id (Symbol) (defaults to: nil) —

  The ID of the Asset to transfer to the wallet.

Returns:

• (Coinbase::FaucetTransaction) —

  The successful faucet transaction

Raises:

• (Coinbase::FaucetLimitReachedError) —

  If the faucet limit has been reached for the address or user.

• (Coinbase::Client::ApiError) —

  If an unexpected error occurs while requesting faucet funds.

# File 'lib/coinbase/address.rb', line 112

def faucet(asset_id: nil)
  Coinbase.call_api do
    Coinbase::FaucetTransaction.new(
      addresses_api.request_external_faucet_funds(
        network.normalized_id,
        id,
        {
          asset_id: asset_id,
          skip_wait: true
        }.compact
      )
    )
  end
end