Coinbase Ruby SDK
-The Coinbase Ruby SDK enables the simple integration of crypto into your app. By calling Coinbase’s Platform APIs, the SDK allows you to provision crypto wallets, send crypto into/out of those wallets, track wallet balances, and trade crypto from one asset into another.
+The Coinbase Ruby SDK enables the simple integration of crypto into your app. By calling Coinbase's Platform APIs, the SDK allows you to provision crypto wallets, send crypto into/out of those wallets, track wallet balances, and trade crypto from one asset into another.
The SDK currently supports Customer-custodied Wallets on the Base Sepolia test network.
@@ -122,7 +122,7 @@Usage
Initialization
-To start, create a CDP API Key. Then, initialize the Platform SDK by passing your API Key name and API Key’s private key via the configure method:
To start, create a CDP API Key. Then, initialize the Platform SDK by passing your API Key name and API Key's private key via the configure method:
api_key_name = 'Copy your API Key name here.'
api_key_private_key = 'Copy your API Key\'s private key here.'
@@ -133,6 +133,11 @@ Initialization
end
Another way to initialize the SDK is by sourcing the API key from the json file that contains your API key, downloaded from CDP portal.
+ +Coinbase.configure_from_json('~/Downloads/coinbase_cloud_api_key.json')
+This will allow you to authenticate with the Platform APIs and get access to the default_user.
u = Coinbase.default_user
@@ -153,7 +158,14 @@ Wallets, Addresses, and Tra
a.to_s
Wallets do not have funds on them to start. In order to fund the Address, you will need to send funds to the Wallet you generated above. If you don’t have testnet funds, get funds from a faucet.
+Wallets do not have funds on them to start. In order to fund the Address, you will need to send funds to the Wallet you generated above. If you don't have testnet funds, get funds from a faucet.
+ +For development purposes, we provide a faucet method to fund your address with ETH on Base Sepolia testnet. We allow one faucet claim per address in a 24 hour window.
# Create a faucet request that returns you a Faucet transaction that can be used to track the tx hash.
+faucet_tx = a.faucet
+faucet_tx.transaction_hash
+# Create a new Wallet to transfer funds to.
# Then, we can transfer 0.00001 ETH out of the Wallet to another Wallet.
@@ -178,14 +190,11 @@ Re-Instantiating Wallets
store(data)
For convenience during testing, we provide a save_wallet method that stores the Wallet data in your local file system. This is an insecure method of storing wallet seeds and should only be used for development purposes.
+For convenience during testing, we provide a save_wallet method that stores the Wallet data in your local file system. This is an insecure method of storing wallet seeds and should only be used for development purposes. ruby u.save_wallet(w3)
u.save_wallet(w3)
-To encrypt the saved data, set encrypt to true.
+To encrypt the saved data, set encrypt to true. Note that your CDP API key also serves as the encryption key for the data persisted locally. To re-instantiate wallets with encrypted data, ensure that your SDK is configured with the same API key when invoking save_wallet and load_wallets.
u.save_wallet(w3, true)
+u.save_wallet(w3, encrypt: true)
The below code demonstrates how to re-instantiate a Wallet from the data export.
@@ -195,13 +204,7 @@ Re-Instantiating Wallets
w4 = u.import_wallet(data)
To import wallets that were persisted to your local file system using save_wallet, use the below code.
# The Wallet can be re-instantiated using the exported data.
-# w5 will be equivalent to w3.
-wallets = u.load_wallets
-w5 = wallets[w3.wallet_id]
-To import wallets that were persisted to your local file system using save_wallet, use the below code. ruby # The Wallet can be re-instantiated using the exported data. # w5 will be equivalent to w3. wallets = u.load_wallets w5 = wallets[w3.wallet_id]
Development
diff --git a/docs/index.html b/docs/index.html index 33c13439..21e1615f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -60,7 +60,7 @@Coinbase Ruby SDK
-The Coinbase Ruby SDK enables the simple integration of crypto into your app. By calling Coinbase’s Platform APIs, the SDK allows you to provision crypto wallets, send crypto into/out of those wallets, track wallet balances, and trade crypto from one asset into another.
+The Coinbase Ruby SDK enables the simple integration of crypto into your app. By calling Coinbase's Platform APIs, the SDK allows you to provision crypto wallets, send crypto into/out of those wallets, track wallet balances, and trade crypto from one asset into another.
The SDK currently supports Customer-custodied Wallets on the Base Sepolia test network.
@@ -122,7 +122,7 @@Usage
Initialization
-To start, create a CDP API Key. Then, initialize the Platform SDK by passing your API Key name and API Key’s private key via the configure method:
To start, create a CDP API Key. Then, initialize the Platform SDK by passing your API Key name and API Key's private key via the configure method:
api_key_name = 'Copy your API Key name here.'
api_key_private_key = 'Copy your API Key\'s private key here.'
@@ -133,6 +133,11 @@ Initialization
end
Another way to initialize the SDK is by sourcing the API key from the json file that contains your API key, downloaded from CDP portal.
+ +Coinbase.configure_from_json('~/Downloads/coinbase_cloud_api_key.json')
+This will allow you to authenticate with the Platform APIs and get access to the default_user.
u = Coinbase.default_user
@@ -153,7 +158,14 @@ Wallets, Addresses, and Tra
a.to_s
Wallets do not have funds on them to start. In order to fund the Address, you will need to send funds to the Wallet you generated above. If you don’t have testnet funds, get funds from a faucet.
+Wallets do not have funds on them to start. In order to fund the Address, you will need to send funds to the Wallet you generated above. If you don't have testnet funds, get funds from a faucet.
+ +For development purposes, we provide a faucet method to fund your address with ETH on Base Sepolia testnet. We allow one faucet claim per address in a 24 hour window.
# Create a faucet request that returns you a Faucet transaction that can be used to track the tx hash.
+faucet_tx = a.faucet
+faucet_tx.transaction_hash
+# Create a new Wallet to transfer funds to.
# Then, we can transfer 0.00001 ETH out of the Wallet to another Wallet.
@@ -178,14 +190,11 @@ Re-Instantiating Wallets
store(data)
For convenience during testing, we provide a save_wallet method that stores the Wallet data in your local file system. This is an insecure method of storing wallet seeds and should only be used for development purposes.
+For convenience during testing, we provide a save_wallet method that stores the Wallet data in your local file system. This is an insecure method of storing wallet seeds and should only be used for development purposes. ruby u.save_wallet(w3)
u.save_wallet(w3)
-To encrypt the saved data, set encrypt to true.
+To encrypt the saved data, set encrypt to true. Note that your CDP API key also serves as the encryption key for the data persisted locally. To re-instantiate wallets with encrypted data, ensure that your SDK is configured with the same API key when invoking save_wallet and load_wallets.
u.save_wallet(w3, true)
+u.save_wallet(w3, encrypt: true)
The below code demonstrates how to re-instantiate a Wallet from the data export.
@@ -195,13 +204,7 @@ Re-Instantiating Wallets
w4 = u.import_wallet(data)
To import wallets that were persisted to your local file system using save_wallet, use the below code.
# The Wallet can be re-instantiated using the exported data.
-# w5 will be equivalent to w3.
-wallets = u.load_wallets
-w5 = wallets[w3.wallet_id]
-To import wallets that were persisted to your local file system using save_wallet, use the below code. ruby # The Wallet can be re-instantiated using the exported data. # w5 will be equivalent to w3. wallets = u.load_wallets w5 = wallets[w3.wallet_id]
Development
diff --git a/docs/method_list.html b/docs/method_list.html index 016d111c..3dbc1527 100644 --- a/docs/method_list.html +++ b/docs/method_list.html @@ -46,192 +46,192 @@Method List
- _deserialize
- Coinbase::Client::TransferList
+ #[]
+ Coinbase::BalanceMap
- _deserialize
- Coinbase::Client::AddressBalanceList
+ #[]=
+ Coinbase::BalanceMap
- _deserialize
- Coinbase::Client::Wallet
+ _deserialize
+ Coinbase::Client::AddressBalanceList
- _deserialize
- Coinbase::Client::Address
+ _deserialize
+ Coinbase::Client::AddressList
- _deserialize
- Coinbase::Client::BroadcastTransferRequest
+ _deserialize
+ Coinbase::Client::Balance
- _deserialize
- Coinbase::Client::Asset
+ _deserialize
+ Coinbase::Client::Wallet
- _deserialize
- Coinbase::Client::Balance
+ _deserialize
+ Coinbase::Client::BroadcastTransferRequest
- _deserialize
- Coinbase::Client::CreateTransferRequest
+ _deserialize
+ Coinbase::Client::Address
Method List
- _deserialize
- Coinbase::Client::Transfer
+ _deserialize
+ Coinbase::Client::CreateTransferRequest
- _deserialize
- Coinbase::Client::WalletList
+ _deserialize
+ Coinbase::Client::Asset
- _deserialize
- Coinbase::Client::AddressList
+ _deserialize
+ Coinbase::Client::TransferList
- _deserialize
- Coinbase::Client::CreateAddressRequest
+ _deserialize
+ Coinbase::Client::FaucetTransaction
- _deserialize
- Coinbase::Client::Error
+ _deserialize
+ Coinbase::Client::CreateAddressRequest
- _deserialize
- Coinbase::Client::CreateWalletRequest
+ _deserialize
+ Coinbase::Client::WalletList
- _deserialize
- Coinbase::Client::FaucetTransaction
+ _deserialize
+ Coinbase::Client::Error
- #_to_hash
- Coinbase::Client::TransferList
+ _deserialize
+ Coinbase::Client::Transfer
- #_to_hash
- Coinbase::Client::Address
+ _deserialize
+ Coinbase::Client::CreateWalletRequest
Method List
Method List
- acceptable_attributes
- Coinbase::Client::CreateWalletRequest
+ #_to_hash
+ Coinbase::Client::AddressBalanceList
- acceptable_attributes
- Coinbase::Client::BroadcastTransferRequest
+ #_to_hash
+ Coinbase::Client::CreateWalletRequest
- acceptable_attributes
- Coinbase::Client::CreateTransferRequest
+ acceptable_attributes
+ Coinbase::Client::Asset
- acceptable_attributes
- Coinbase::Client::CreateAddressRequest
+ acceptable_attributes
+ Coinbase::Client::User
- acceptable_attributes
- Coinbase::Client::AddressBalanceList
+ acceptable_attributes
+ Coinbase::Client::Transfer
Method List
- acceptable_attributes
- Coinbase::Client::TransferList
+ acceptable_attributes
+ Coinbase::Client::Balance
- acceptable_attributes
- Coinbase::Client::AddressList
+ acceptable_attributes
+ Coinbase::Client::CreateTransferRequest
- acceptable_attributes
- Coinbase::Client::WalletList
+ acceptable_attributes
+ Coinbase::Client::Error
- acceptable_attributes
- Coinbase::Client::User
+ acceptable_attributes
+ Coinbase::Client::CreateWalletRequest
- acceptable_attributes
- Coinbase::Client::Transfer
+ acceptable_attributes
+ Coinbase::Client::CreateAddressRequest
- acceptable_attributes
- Coinbase::Client::Asset
+ acceptable_attributes
+ Coinbase::Client::WalletList
- acceptable_attributes
- Coinbase::Client::Balance
+ acceptable_attributes
+ Coinbase::Client::AddressBalanceList
- acceptable_attributes
- Coinbase::Client::Error
+ acceptable_attributes
+ Coinbase::Client::BroadcastTransferRequest
Method List
+ acceptable_attributes
+ Coinbase::Client::AddressList
+
+
acceptable_attributes
Coinbase::Client::Wallet
@@ -556,6 +564,14 @@ -
+
+
+
-
Method List
+
+ acceptable_attributes
+ Coinbase::Client::TransferList
+
+
#access_token
@@ -590,16 +606,16 @@ -
-
@@ -630,56 +646,56 @@ -
-
-
-
-
-
-
@@ -766,40 +782,40 @@ -
-
-
-
-
@@ -814,128 +830,128 @@ -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -1046,80 +1062,80 @@ -
-
-
-
-
-
-
-
-
-
@@ -1134,32 +1150,32 @@ -
-
-
-
@@ -1254,16 +1270,16 @@ -
-
@@ -1286,16 +1302,16 @@ -
-
@@ -1438,8 +1454,8 @@ -
@@ -1454,8 +1470,8 @@ -
@@ -1518,16 +1534,16 @@ -
-
@@ -1566,16 +1582,16 @@ -
-
@@ -1614,112 +1630,112 @@ -
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -1734,8 +1750,8 @@ -
@@ -1798,16 +1814,16 @@ -
-
@@ -1846,16 +1862,16 @@ -
-
@@ -1932,6 +1948,22 @@ -
+
+
+
+ -
+
+
+
-
Method List
- #address_id
- Coinbase::Address
+ #address_id
+ Coinbase::Client::Transfer
- #address_id
- Coinbase::Client::Transfer
+ #address_id
+ Coinbase::Address
Method List
- #api_client
- Coinbase::Client::WalletsApi
+ #api_client
+ Coinbase::Client::UsersApi
- #api_client
- Coinbase::Client::UsersApi
+ #api_client
+ Coinbase::Configuration
- #api_client
- Coinbase::Configuration
+ #api_client
+ Coinbase::Client::AddressesApi
- #api_client
- Coinbase::Client::AddressesApi
+ #api_client
+ Coinbase::Client::WalletsApi
Method List
Method List
- attribute_map
- Coinbase::Client::FaucetTransaction
+ attribute_map
+ Coinbase::Client::TransferList
- attribute_map
- Coinbase::Client::CreateAddressRequest
+ attribute_map
+ Coinbase::Client::CreateWalletRequest
- attribute_map
- Coinbase::Client::TransferList
+ attribute_map
+ Coinbase::Client::AddressBalanceList
- attribute_map
- Coinbase::Client::AddressList
+ attribute_map
+ Coinbase::Client::WalletList
- attribute_map
- Coinbase::Client::WalletList
+ attribute_map
+ Coinbase::Client::CreateAddressRequest
- attribute_map
- Coinbase::Client::User
+ attribute_map
+ Coinbase::Client::Error
- attribute_map
- Coinbase::Client::Transfer
+ attribute_map
+ Coinbase::Client::CreateTransferRequest
- attribute_map
- Coinbase::Client::CreateTransferRequest
+ attribute_map
+ Coinbase::Client::FaucetTransaction
- attribute_map
- Coinbase::Client::BroadcastTransferRequest
+ attribute_map
+ Coinbase::Client::Transfer
- attribute_map
- Coinbase::Client::Asset
+ attribute_map
+ Coinbase::Client::AddressList
- attribute_map
- Coinbase::Client::Balance
+ attribute_map
+ Coinbase::Client::User
- attribute_map
- Coinbase::Client::Error
+ attribute_map
+ Coinbase::Client::Wallet
- attribute_map
- Coinbase::Client::Address
+ attribute_map
+ Coinbase::Client::BroadcastTransferRequest
- attribute_map
- Coinbase::Client::Wallet
+ attribute_map
+ Coinbase::Client::Balance
- attribute_map
- Coinbase::Client::CreateWalletRequest
+ attribute_map
+ Coinbase::Client::Address
- attribute_map
- Coinbase::Client::AddressBalanceList
+ attribute_map
+ Coinbase::Client::Asset
Method List
- build_from_hash
- Coinbase::Client::Transfer
+ build_from_hash
+ Coinbase::Client::CreateAddressRequest
- build_from_hash
- Coinbase::Client::AddressBalanceList
+ build_from_hash
+ Coinbase::Client::FaucetTransaction
- build_from_hash
- Coinbase::Client::User
+ build_from_hash
+ Coinbase::Client::AddressBalanceList
- build_from_hash
- Coinbase::Client::Wallet
+ build_from_hash
+ Coinbase::Client::Address
- build_from_hash
- Coinbase::Client::CreateTransferRequest
+ build_from_hash
+ Coinbase::Client::Wallet
- build_from_hash
- Coinbase::Client::Error
+ build_from_hash
+ Coinbase::Client::Balance
- build_from_hash
- Coinbase::Client::CreateAddressRequest
+ build_from_hash
+ Coinbase::Client::CreateTransferRequest
- build_from_hash
- Coinbase::Client::AddressList
+ build_from_hash
+ Coinbase::Client::TransferList
- build_from_hash
- Coinbase::Client::Balance
+ build_from_hash
+ Coinbase::Client::CreateWalletRequest
- build_from_hash
- Coinbase::Client::TransferList
+ build_from_hash
+ Coinbase::Client::Asset
Method List
- build_from_hash
- Coinbase::Client::FaucetTransaction
+ build_from_hash
+ Coinbase::Client::User
- build_from_hash
- Coinbase::Client::Asset
+ build_from_hash
+ Coinbase::Client::AddressList
- build_from_hash
- Coinbase::Client::Address
+ build_from_hash
+ Coinbase::Client::Error
- build_from_hash
- Coinbase::Client::CreateWalletRequest
+ build_from_hash
+ Coinbase::Client::Transfer
Method List
Method List
- #configure
- Coinbase::Client::Configuration
+ configure
+ Coinbase
- configure
- Coinbase
+ #configure
+ Coinbase::Client::Configuration
Method List
Method List
Method List
- #default_address
- Coinbase::Wallet
+ #default_address
+ Coinbase::Client::Wallet
- #default_address
- Coinbase::Client::Wallet
+ #default_address
+ Coinbase::Wallet
Method List
- #destination
- Coinbase::Client::Transfer
+ #destination
+ Coinbase::Client::CreateTransferRequest
- #destination
- Coinbase::Client::CreateTransferRequest
+ #destination
+ Coinbase::Client::Transfer
Method List
Method List
Method List
- #get_address
- Coinbase::Wallet
+ #get_address
+ Coinbase::Client::AddressesApi
- #get_address
- Coinbase::Client::AddressesApi
+ #get_address
+ Coinbase::Wallet
Method List
- #get_balance
- Coinbase::Wallet
+ #get_balance
+ Coinbase::Address
- #get_balance
- Coinbase::Address
+ #get_balance
+ Coinbase::Wallet
Method List
+
+ #has_more
+ Coinbase::Client::TransferList
+
+
+ #has_more
+ Coinbase::Client::WalletList
+
+
#has_more
@@ -1942,48 +1974,48 @@ -
-
-
-
-
-
@@ -1998,24 +2030,40 @@ -
-
-
+
+
+
+ -
+
+
+
+ -
+
@@ -2030,400 +2078,416 @@ -
+
+
+
+ -
+
+
+
+ -
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -2510,16 +2574,16 @@ -
-
@@ -2534,96 +2598,96 @@ -
-
-
-
-
-
-
-
-
-
-
-
@@ -2742,40 +2806,40 @@ -
-
-
-
-
@@ -2830,16 +2894,16 @@ -
-
@@ -2862,16 +2926,16 @@ -
-
@@ -2886,136 +2950,136 @@ -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -3030,88 +3094,88 @@ -
-
-
-
-
-
-
-
-
-
-
@@ -3150,16 +3214,16 @@ -
-
@@ -3326,24 +3390,24 @@ -
-
-
@@ -3398,16 +3462,16 @@ -
-
@@ -3438,64 +3502,64 @@ -
-
-
-
-
-
-
-
@@ -3510,8 +3574,24 @@ -
+
+
+
+ -
+
+
+
+ -
+
@@ -3526,16 +3606,16 @@ -
-
@@ -3550,160 +3630,176 @@ -
-
-
+
+
+
+ -
+
+
+
+ -
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -3718,80 +3814,80 @@ -
-
-
-
-
-
-
-
-
-
@@ -3806,56 +3902,56 @@ -
-
-
-
-
-
-
@@ -3870,32 +3966,32 @@ -
-
-
-
@@ -3910,24 +4006,24 @@ -
-
-
@@ -3942,16 +4038,16 @@ -
-
@@ -4030,120 +4126,120 @@ -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -4158,8 +4254,8 @@ -
@@ -4182,48 +4278,48 @@ -
-
-
-
-
-
diff --git a/lib/coinbase/address.rb b/lib/coinbase/address.rb
index d2028097..891dc351 100644
--- a/lib/coinbase/address.rb
+++ b/lib/coinbase/address.rb
@@ -133,10 +133,16 @@ def transfer(amount, asset_id, destination)
Coinbase::Transfer.new(transfer_model)
end
- # Returns the address as a string.
- # @return [String] The address
+ # Returns a String representation of the Address.
+ # @return [String] a String representation of the Address
def to_s
- address_id
+ "Coinbase::Address{address_id: '#{address_id}', network_id: '#{network_id}', wallet_id: '#{wallet_id}'}"
+ end
+
+ # Same as to_s.
+ # @return [String] a String representation of the Address
+ def inspect
+ to_s
end
# Requests funds for the address from the faucet and returns the faucet transaction.
diff --git a/lib/coinbase/errors.rb b/lib/coinbase/errors.rb
index 860189a2..9fc934c5 100644
--- a/lib/coinbase/errors.rb
+++ b/lib/coinbase/errors.rb
@@ -80,13 +80,16 @@ def self.from_error(err)
end
end
- # The string representation of the error.
+ # Returns a String representation of the APIError.
+ # @return [String] a String representation of the APIError
def to_s
- message = "API Error \n"
- message += "HTTP status code: #{http_code}\n" if http_code
- message += "API error code: #{api_code}\n" if api_code
- message += "API error message: #{api_message}\n" if api_message
- message
+ "APIError{http_code: #{@http_code}, api_code: #{@api_code}, api_message: #{@api_message}}"
+ end
+
+ # Same as to_s.
+ # @return [String] a String representation of the APIError
+ def inspect
+ to_s
end
end
diff --git a/lib/coinbase/faucet_transaction.rb b/lib/coinbase/faucet_transaction.rb
index cd8eb56f..15f1eb80 100644
--- a/lib/coinbase/faucet_transaction.rb
+++ b/lib/coinbase/faucet_transaction.rb
@@ -6,6 +6,8 @@ module Coinbase
# in the native Asset of the Network. Transfers should be created through Wallet#transfer or
# Address#transfer.
class FaucetTransaction
+ # Returns a new FaucetTransaction object. Do not use this method directly - instead, use Address#faucet.
+ # @param model [Coinbase::Client::FaucetTransaction] The underlying FaucetTransaction object
def initialize(model)
@model = model
end
@@ -17,5 +19,24 @@ def initialize(model)
def transaction_hash
model.transaction_hash
end
+
+ # Returns the link to the transaction on the blockchain explorer.
+ # @return [String] The link to the transaction on the blockchain explorer
+ def transaction_link
+ # TODO: Parameterize this by Network.
+ "https://sepolia.basescan.org/tx/#{transaction_hash}"
+ end
+
+ # Returns a String representation of the FaucetTransaction.
+ # @return [String] a String representation of the FaucetTransaction
+ def to_s
+ "Coinbase::FaucetTransaction{transaction_hash: '#{transaction_hash}', transaction_link: '#{transaction_link}'}"
+ end
+
+ # Same as to_s.
+ # @return [String] a String representation of the FaucetTransaction
+ def inspect
+ to_s
+ end
end
end
diff --git a/lib/coinbase/transfer.rb b/lib/coinbase/transfer.rb
index beb1bb96..69ae6158 100644
--- a/lib/coinbase/transfer.rb
+++ b/lib/coinbase/transfer.rb
@@ -77,6 +77,13 @@ def amount
BigDecimal(@model.amount) / BigDecimal(Coinbase::WEI_PER_ETHER.to_s)
end
+ # Returns the link to the transaction on the blockchain explorer.
+ # @return [String] The link to the transaction on the blockchain explorer
+ def transaction_link
+ # TODO: Parameterize this by Network.
+ "https://sepolia.basescan.org/tx/#{transaction_hash}"
+ end
+
# Returns the Unsigned Payload of the Transfer.
# @return [String] The Unsigned Payload
def unsigned_payload
@@ -163,5 +170,20 @@ def wait!(interval_seconds = 0.2, timeout_seconds = 10)
self
end
+
+ # Returns a String representation of the Transfer.
+ # @return [String] a String representation of the Transfer
+ def to_s
+ "Coinbase::Transfer{transfer_id: '#{transfer_id}', network_id: '#{network_id}', " +
+ "from_address_id: '#{from_address_id}', destination_address_id: '#{destination_address_id}', " +
+ "asset_id: '#{asset_id}', amount: '#{amount}', transaction_hash: '#{transaction_hash}', " +
+ "transaction_link: '#{transaction_link}', status: '#{status}'}"
+ end
+
+ # Same as to_s.
+ # @return [String] a String representation of the Transfer
+ def inspect
+ to_s
+ end
end
end
diff --git a/lib/coinbase/user.rb b/lib/coinbase/user.rb
index 895099a6..a519075c 100644
--- a/lib/coinbase/user.rb
+++ b/lib/coinbase/user.rb
@@ -70,10 +70,10 @@ def list_wallet_ids
# Coinbase.configuration.backup_file_path.
#
# @param wallet [Coinbase::Wallet] The wallet model to save.
- # @param encrypt [bool] Boolean representing whether the backup persisted to local file system should be encrypted
- # or not. Data is unencrypted by default.
+ # @param encrypt [bool] (Optional) Boolean representing whether the backup persisted to local file system should be
+ # encrypted or not. Data is unencrypted by default.
# @return [Coinbase::Wallet] the saved wallet.
- def save_wallet(wallet, encrypt = false)
+ def save_wallet(wallet, encrypt: false)
existing_seeds_in_store = existing_seeds
data = wallet.export
seed_to_store = data.seed
@@ -138,6 +138,18 @@ def load_wallets
wallets
end
+ # Returns a string representation of the User.
+ # @return [String] a string representation of the User
+ def to_s
+ "Coinbase::User{user_id: '#{user_id}'}"
+ end
+
+ # Same as to_s.
+ # @return [String] a string representation of the User
+ def inspect
+ to_s
+ end
+
private
def addresses_api
diff --git a/lib/coinbase/wallet.rb b/lib/coinbase/wallet.rb
index 4f1f0efa..76af2cae 100644
--- a/lib/coinbase/wallet.rb
+++ b/lib/coinbase/wallet.rb
@@ -161,6 +161,19 @@ def export
Data.new(wallet_id: wallet_id, seed: @master.seed_hex)
end
+ # Returns a String representation of the Wallet.
+ # @return [String] a String representation of the Wallet
+ def to_s
+ "Coinbase::Wallet{wallet_id: '#{wallet_id}', network_id: '#{network_id}', " +
+ "default_address: '#{default_address.address_id}'}"
+ end
+
+ # Same as to_s.
+ # @return [String] a String representation of the Wallet
+ def inspect
+ to_s
+ end
+
# The data required to recreate a Wallet.
class Data
attr_reader :wallet_id, :seed
diff --git a/spec/unit/coinbase/address_spec.rb b/spec/unit/coinbase/address_spec.rb
index 514dd897..532efc86 100644
--- a/spec/unit/coinbase/address_spec.rb
+++ b/spec/unit/coinbase/address_spec.rb
@@ -383,10 +383,4 @@
end
end
end
-
- describe '#to_s' do
- it 'returns the address as a string' do
- expect(address.to_s).to eq(address_id)
- end
- end
end
diff --git a/spec/unit/coinbase/user_spec.rb b/spec/unit/coinbase/user_spec.rb
index cc55344c..0ee9fc86 100644
--- a/spec/unit/coinbase/user_spec.rb
+++ b/spec/unit/coinbase/user_spec.rb
@@ -183,7 +183,7 @@
end
it 'saves the Wallet data when encryption is true' do
- saved_wallet = user.save_wallet(seed_wallet, true)
+ saved_wallet = user.save_wallet(seed_wallet, encrypt: true)
# Verify that the file has new wallet.
stored_seed_data = File.read(Coinbase.configuration.backup_file_path)
wallets = JSON.parse(stored_seed_data)
Method List
Method List
+ #hash
+ Coinbase::Client::BroadcastTransferRequest
+
+
+ #hash
+ Coinbase::Client::CreateAddressRequest
Method List
+ #hash
+ Coinbase::Client::Balance
+
+
+ #hash
+ Coinbase::Client::Transfer
- #hash
- Coinbase::Client::CreateAddressRequest
+ #http_code
+ Coinbase::APIError
- #hash
- Coinbase::Client::User
+ #import_wallet
+ Coinbase::User
- #hash
- Coinbase::Client::CreateTransferRequest
+ #initialize
+ Coinbase::Client::CreateWalletRequest
- #host
- Coinbase::Client::Configuration
+ #initialize
+ Coinbase::Configuration
- #http_code
- Coinbase::APIError
+ #initialize
+ Coinbase::User
- #id
- Coinbase::Client::User
+ #initialize
+ Coinbase::Asset
- #id
- Coinbase::Client::Wallet
+ #initialize
+ Coinbase::APIError
- #import_wallet
- Coinbase::User
+ #initialize
+ Coinbase::Wallet
- #initialize
- Coinbase::Client::AddressList
+ #initialize
+ Coinbase::Wallet::Data
- #initialize
- Coinbase::Transfer
+ #initialize
+ Coinbase::Address
- #initialize
- Coinbase::Client::CreateAddressRequest
+ #initialize
+ Coinbase::Network
- #initialize
- Coinbase::Client::ApiError
+ #initialize
+ Coinbase::Transfer
- #initialize
- Coinbase::Client::BroadcastTransferRequest
+ #initialize
+ Coinbase::BalanceMap
- #initialize
- Coinbase::BalanceMap
+ #initialize
+ Coinbase::Authenticator
- #initialize
- Coinbase::Client::CreateTransferRequest
+ #initialize
+ Coinbase::Client::ApiError
- #initialize
- Coinbase::Authenticator
+ #initialize
+ Coinbase::Client::ApiClient
- #initialize
- Coinbase::Client::UsersApi
+ #initialize
+ Coinbase::Client::User
- #initialize
- Coinbase::Client::Error
+ #initialize
+ Coinbase::FaucetTransaction
- #initialize
- Coinbase::Client::WalletList
+ #initialize
+ Coinbase::Client::Asset
- #initialize
- Coinbase::Client::CreateWalletRequest
+ #initialize
+ Coinbase::Client::Error
- #initialize
- Coinbase::Client::Address
+ #initialize
+ Coinbase::Client::UsersApi
- #initialize
- Coinbase::Client::TransferList
+ #initialize
+ Coinbase::Client::Configuration
- #initialize
- Coinbase::User
+ #initialize
+ Coinbase::Client::Wallet
- #initialize
- Coinbase::Client::ApiClient
+ #initialize
+ Coinbase::Client::Address
- #initialize
- Coinbase::Asset
+ #initialize
+ Coinbase::Client::Balance
- #initialize
- Coinbase::Client::AddressBalanceList
+ #initialize
+ Coinbase::Client::WalletsApi
- #initialize
- Coinbase::APIError
+ #initialize
+ Coinbase::Client::Transfer::EnumAttributeValidator
- #initialize
- Coinbase::Client::FaucetTransaction
+ #initialize
+ Coinbase::Client::Transfer
- #initialize
- Coinbase::Wallet
+ #initialize
+ Coinbase::Client::AddressesApi
- #initialize
- Coinbase::Client::Asset
+ #initialize
+ Coinbase::Client::TransfersApi
- #initialize
- Coinbase::Client::TransfersApi
+ #initialize
+ Coinbase::Client::WalletList
- #initialize
- Coinbase::Client::Balance
+ #initialize
+ Coinbase::Client::AddressList
- #initialize
- Coinbase::Client::WalletsApi
+ #initialize
+ Coinbase::Client::TransferList
- #initialize
- Coinbase::FaucetTransaction
+ #initialize
+ Coinbase::Client::FaucetTransaction
- #initialize
- Coinbase::Network
+ #initialize
+ Coinbase::Client::AddressBalanceList
- #initialize
- Coinbase::Client::Transfer
+ #initialize
+ Coinbase::Client::CreateAddressRequest
- #initialize
- Coinbase::Wallet::Data
+ #initialize
+ Coinbase::Client::CreateTransferRequest
- #initialize
- Coinbase::Client::Transfer::EnumAttributeValidator
+ #initialize
+ Coinbase::Client::BroadcastTransferRequest
- #initialize
- Coinbase::Address
+ #inject_format
+ Coinbase::Client::Configuration
- #initialize
- Coinbase::Client::AddressesApi
+ #inspect
+ Coinbase::Transfer
- #initialize
- Coinbase::Client::Configuration
+ #inspect
+ Coinbase::User
- #initialize
- Coinbase::Client::User
+ #inspect
+ Coinbase::Wallet
- #initialize
- Coinbase::Client::Wallet
+ #inspect
+ Coinbase::BalanceMap
- #initialize
- Coinbase::Configuration
+ #inspect
+ Coinbase::APIError
- #inject_format
- Coinbase::Client::Configuration
+ #inspect
+ Coinbase::FaucetTransaction
Method List
- #list_invalid_properties
- Coinbase::Client::Wallet
+ #list_invalid_properties
+ Coinbase::Client::CreateAddressRequest
- #list_invalid_properties
- Coinbase::Client::CreateTransferRequest
+ #list_invalid_properties
+ Coinbase::Client::WalletList
Method List
- #list_invalid_properties
- Coinbase::Client::Asset
+ #list_invalid_properties
+ Coinbase::Client::Balance
- #list_invalid_properties
- Coinbase::Client::Balance
+ #list_invalid_properties
+ Coinbase::Client::Wallet
- #list_invalid_properties
- Coinbase::Client::CreateAddressRequest
+ #list_invalid_properties
+ Coinbase::Client::AddressList
- #list_invalid_properties
- Coinbase::Client::BroadcastTransferRequest
+ #list_invalid_properties
+ Coinbase::Client::User
- #list_invalid_properties
- Coinbase::Client::CreateWalletRequest
+ #list_invalid_properties
+ Coinbase::Client::AddressBalanceList
- #list_invalid_properties
- Coinbase::Client::User
+ #list_invalid_properties
+ Coinbase::Client::Asset
- #list_invalid_properties
- Coinbase::Client::Transfer
+ #list_invalid_properties
+ Coinbase::Client::BroadcastTransferRequest
- #list_invalid_properties
- Coinbase::Client::AddressBalanceList
+ #list_invalid_properties
+ Coinbase::Client::Transfer
- #list_invalid_properties
- Coinbase::Client::WalletList
+ #list_invalid_properties
+ Coinbase::Client::TransferList
- #list_invalid_properties
- Coinbase::Client::FaucetTransaction
+ #list_invalid_properties
+ Coinbase::Client::CreateTransferRequest
- #list_invalid_properties
- Coinbase::Client::AddressList
+ #list_invalid_properties
+ Coinbase::Client::FaucetTransaction
- #list_invalid_properties
- Coinbase::Client::TransferList
+ #list_invalid_properties
+ Coinbase::Client::CreateWalletRequest
Method List
- #network_id
- Coinbase::Asset
+ #network_id
+ Coinbase::Address
- #network_id
- Coinbase::Address
+ #network_id
+ Coinbase::Transfer
- #network_id
- Coinbase::Wallet
+ #network_id
+ Coinbase::Client::Asset
- #network_id
- Coinbase::Client::Asset
+ #network_id
+ Coinbase::Wallet
- #network_id
- Coinbase::Transfer
+ #network_id
+ Coinbase::Asset
Method List
- #next_page
- Coinbase::Client::WalletList
+ #next_page
+ Coinbase::Client::TransferList
- #next_page
- Coinbase::Client::TransferList
+ #next_page
+ Coinbase::Client::WalletList
Method List
- openapi_nullable
- Coinbase::Client::User
+ openapi_nullable
+ Coinbase::Client::Wallet
- openapi_nullable
- Coinbase::Client::CreateWalletRequest
+ openapi_nullable
+ Coinbase::Client::Balance
Method List
- openapi_nullable
- Coinbase::Client::Asset
+ openapi_nullable
+ Coinbase::Client::WalletList
- openapi_nullable
- Coinbase::Client::Balance
+ openapi_nullable
+ Coinbase::Client::CreateWalletRequest
- openapi_nullable
- Coinbase::Client::AddressBalanceList
+ openapi_nullable
+ Coinbase::Client::FaucetTransaction
- openapi_nullable
- Coinbase::Client::Address
+ openapi_nullable
+ Coinbase::Client::CreateTransferRequest
- openapi_nullable
- Coinbase::Client::WalletList
+ openapi_nullable
+ Coinbase::Client::BroadcastTransferRequest
- openapi_nullable
- Coinbase::Client::Error
+ openapi_nullable
+ Coinbase::Client::TransferList
- openapi_nullable
- Coinbase::Client::TransferList
+ openapi_nullable
+ Coinbase::Client::Asset
- openapi_nullable
- Coinbase::Client::CreateTransferRequest
+ openapi_nullable
+ Coinbase::Client::Error
- openapi_nullable
- Coinbase::Client::Wallet
+ openapi_nullable
+ Coinbase::Client::Transfer
- openapi_nullable
- Coinbase::Client::AddressList
+ openapi_nullable
+ Coinbase::Client::User
- openapi_nullable
- Coinbase::Client::FaucetTransaction
+ openapi_nullable
+ Coinbase::Client::AddressBalanceList
- openapi_nullable
- Coinbase::Client::BroadcastTransferRequest
+ openapi_nullable
+ Coinbase::Client::Address
- openapi_nullable
- Coinbase::Client::Transfer
+ openapi_nullable
+ Coinbase::Client::AddressList
- openapi_types
- Coinbase::Client::Error
+ openapi_types
+ Coinbase::Client::Asset
- openapi_types
- Coinbase::Client::Balance
+ openapi_types
+ Coinbase::Client::BroadcastTransferRequest
- openapi_types
- Coinbase::Client::CreateTransferRequest
+ openapi_types
+ Coinbase::Client::Wallet
- openapi_types
- Coinbase::Client::CreateWalletRequest
+ openapi_types
+ Coinbase::Client::Balance
Method List
- openapi_types
- Coinbase::Client::Wallet
+ openapi_types
+ Coinbase::Client::CreateTransferRequest
- openapi_types
- Coinbase::Client::Asset
+ openapi_types
+ Coinbase::Client::WalletList
- openapi_types
- Coinbase::Client::AddressList
+ openapi_types
+ Coinbase::Client::Error
- openapi_types
- Coinbase::Client::TransferList
+ openapi_types
+ Coinbase::Client::Address
- openapi_types
- Coinbase::Client::FaucetTransaction
+ openapi_types
+ Coinbase::Client::CreateAddressRequest
- openapi_types
- Coinbase::Client::CreateAddressRequest
+ openapi_types
+ Coinbase::Client::AddressList
- openapi_types
- Coinbase::Client::BroadcastTransferRequest
+ openapi_types
+ Coinbase::Client::CreateWalletRequest
- openapi_types
- Coinbase::Client::User
+ openapi_types
+ Coinbase::Client::TransferList
- openapi_types
- Coinbase::Client::WalletList
+ openapi_types
+ Coinbase::Client::User
- openapi_types
- Coinbase::Client::Address
+ openapi_types
+ Coinbase::Client::AddressBalanceList
- openapi_types
- Coinbase::Client::AddressBalanceList
+ openapi_types
+ Coinbase::Client::FaucetTransaction
Method List
- #public_key
- Coinbase::Client::CreateAddressRequest
+ #public_key
+ Coinbase::Client::Address
- #public_key
- Coinbase::Client::Address
+ #public_key
+ Coinbase::Client::CreateAddressRequest
Method List
- #signed_payload
- Coinbase::Client::BroadcastTransferRequest
+ #signed_payload
+ Coinbase::Client::Transfer
- #signed_payload
- Coinbase::Client::Transfer
+ #signed_payload
+ Coinbase::Transfer
- #signed_payload
- Coinbase::Transfer
+ #signed_payload
+ Coinbase::Client::BroadcastTransferRequest
Method List
Method List
Method List
+ #to_body
+ Coinbase::Client::CreateWalletRequest
+
+
+ #to_body
+ Coinbase::Client::BroadcastTransferRequest
Method List
Method List
+ #to_hash
+ Coinbase::Client::FaucetTransaction
+
+
+ #to_hash
+ Coinbase::Client::Address
Method List
Method List
Method List
- #total_count
- Coinbase::Client::WalletList
+ #total_count
+ Coinbase::Client::AddressList
- #total_count
- Coinbase::Client::TransferList
+ #total_count
+ Coinbase::Client::AddressBalanceList
- #total_count
- Coinbase::Client::AddressList
+ #total_count
+ Coinbase::Client::TransferList
- #total_count
- Coinbase::Client::AddressBalanceList
+ #total_count
+ Coinbase::Client::WalletList
Method List
- #transaction_hash
- Coinbase::FaucetTransaction
+ #transaction_hash
+ Coinbase::Transfer
- #transaction_hash
- Coinbase::Transfer
+ #transaction_hash
+ Coinbase::Client::Transfer
- #transaction_hash
- Coinbase::Client::Transfer
+ #transaction_hash
+ Coinbase::FaucetTransaction
Method List
Method List
Method List
Method List
- #wallet_id
- Coinbase::Transfer
+ #wallet_id
+ Coinbase::Wallet
- #wallet_id
- Coinbase::Wallet
+ #wallet_id
+ Coinbase::Address
- #wallet_id
- Coinbase::Client::Address
+ #wallet_id
+ Coinbase::Client::Transfer
- #wallet_id
- Coinbase::Client::Transfer
+ #wallet_id
+ Coinbase::Wallet::Data
- #wallet_id
- Coinbase::Wallet::Data
+ #wallet_id
+ Coinbase::Client::Address
- #wallet_id
- Coinbase::Address
+ #wallet_id
+ Coinbase::Transfer