diff --git a/.gitignore b/.gitignore
index fd13bce5..283c9376 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
Gemfile.lock
-coinbase_cloud_api_key.json
\ No newline at end of file
+coinbase_cloud_api_key.json
+.yardoc
\ No newline at end of file
diff --git a/Gemfile b/Gemfile
index 6803203d..0952a5b9 100644
--- a/Gemfile
+++ b/Gemfile
@@ -10,3 +10,4 @@ gem 'pry'
gem 'rake'
gem 'rspec'
gem 'rubocop', '~> 1.63.1' # Pin to a specific version of RuboCop to ensure consistent linting.
+gem 'yard', '~> 0.9.36' # Pin to a specific version of YARD to ensure consistent documentation generation.
diff --git a/README.md b/README.md
index e1ad6109..a8f82c16 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,11 @@ By calling Coinbase's Platform APIs, the SDK allows you to provision crypto wall
send crypto into/out of those wallets, track wallet balances, and trade crypto from
one asset into another.
+The SDK currently supports Developer-managed Wallets using Ethereum on Base Sepolia.
+
+**IMPORTANT: The Coinbase SDK is currently under development, and may make backwards-incompatible changes.**
+**Do not use the Coinbase SDK to manage mainnet funds.**
+
## Documentation
> TODO
@@ -135,4 +140,12 @@ it, run:
```bash
bundle exec bin/repl
+```
+
+### Generating Documentation
+
+To generate documentation from the Ruby comments, run:
+
+```bash
+bundle exec yardoc --output-dir ./docs
```
\ No newline at end of file
diff --git a/docs/Coinbase.html b/docs/Coinbase.html
new file mode 100644
index 00000000..670d8718
--- /dev/null
+++ b/docs/Coinbase.html
@@ -0,0 +1,484 @@
+
+
+
+
+
+
+ Module: Coinbase
+
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A representation of a blockchain Address, which is a user-controlled account on a Network. Addresses are used to send and receive Assets, and should be created using Wallet#create_address. Addresses require a Eth::Key to sign transaction data.
The amount of the Asset to send. Integers are interpreted as the smallest denomination of the Asset (e.g. Wei for Ether). Floats and BigDecimals are interpreted as the Asset itself (e.g. Ether).
# File 'lib/coinbase/address.rb', line 55
+
+deftransfer(amount,asset_id,destination)
+ # TODO: Handle multiple currencies.
+raiseArgumentError,"Unsupported asset: #{asset_id}"ifasset_id!=:eth
+
+ ifdestination.is_a?(Wallet)
+ raiseArgumentError,'Transfer must be on the same Network'ifdestination.network_id!=@network_id
+
+ destination=destination.default_address.address_id
+ elsifdestination.is_a?(Address)
+ raiseArgumentError,'Transfer must be on the same Network'ifdestination.network_id!=@network_id
+
+ destination=destination.address_id
+ end
+
+ current_balance=get_balance(:eth)
+ ifcurrent_balance<amount
+ raiseArgumentError,"Insufficient funds: #{amount} requested, but only #{current_balance} available"
+ end
+
+ transfer=Coinbase::Transfer.new(@network_id,@wallet_id,@address_id,amount,asset_id,destination,
+ client:@client)
+
+ transaction=transfer.transaction
+ transaction.sign(@key)
+ @client.eth_sendRawTransaction("0x#{transaction.hex}")
+
+ transfer
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/Coinbase/Network.html b/docs/Coinbase/Network.html
new file mode 100644
index 00000000..b08979c0
--- /dev/null
+++ b/docs/Coinbase/Network.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+ Class: Coinbase::Network
+
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A representation of a Transfer, which moves an amount of an Asset from a user-controlled Wallet to another address. The fee is assumed to be paid in the native Asset of the Network. Currently only ETH transfers are supported. Transfers should be created through Wallet#transfer or Address#transfer.
The amount of the Asset to send. Integers are interpreted as the smallest denomination of the Asset (e.g. Wei for Ether). Floats and BigDecimals are interpreted as the Asset itself (e.g. Ether).
+
+
+
+
+
+
+ asset_id
+
+
+ (Symbol)
+
+
+
+ —
+
+
The ID of the Asset being transferred. Currently only ETH is supported.
# File 'lib/coinbase/transfer.rb', line 80
+
+defstatus
+ begin
+ # Create the transaction, and attempt to get the hash to see if it has been signed.
+transaction.hash
+ rescueEth::Signature::SignatureError
+ # If the transaction has not been signed, it is still pending.
+returnStatus::PENDING
+ end
+
+ onchain_transaction=@client.eth_getTransactionByHash(transaction_hash)
+
+ ifonchain_transaction.nil?
+ # If the transaction has not been broadcast, it is still pending.
+Status::PENDING
+ elsifonchain_transaction['blockHash'].nil?
+ # If the transaction has been broadcast but hasn't been included in a block, it is
+# broadcast.
+Status::BROADCAST
+ else
+ transaction_receipt=@client.eth_getTransactionReceipt(transaction_hash)
+
+ iftransaction_receipt['status'].to_i(16)==1
+ Status::COMPLETE
+ else
+ Status::FAILED
+ end
+ end
+end
+
+
+
+
+
+
+
+
+ #transaction ⇒ Eth::Tx::Eip1559
+
+
+
+
+
+
+
+
+
Returns the underlying Transfer transaction, creating it if it has not been yet.
Waits until the Transfer is completed or failed by polling the Network at the given interval. Raises a Timeout::Error if the Transfer takes longer than the given timeout.
Transfers the given amount of the given Asset to the given address. Only same-Network Transfers are supported. Currently only the default_address is used to source the Transfer.
The amount of the Asset to send. Integers are interpreted as the smallest denomination of the Asset (e.g. Wei for Ether). Floats and BigDecimals are interpreted as the Asset itself (e.g. Ether).
# File 'lib/coinbase/wallet.rb', line 92
+
+deftransfer(amount,asset_id,destination)
+ ifdestination.is_a?(Wallet)
+ raiseArgumentError,'Transfer must be on the same Network'ifdestination.network_id!=@network_id
+
+ destination=destination.default_address.address_id
+ elsifdestination.is_a?(Address)
+ raiseArgumentError,'Transfer must be on the same Network'ifdestination.network_id!=@network_id
+
+ destination=destination.address_id
+ end
+
+ default_address.transfer(amount,asset_id,destination)
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_index.html b/docs/_index.html
new file mode 100644
index 00000000..d6d6909d
--- /dev/null
+++ b/docs/_index.html
@@ -0,0 +1,182 @@
+
+
+
+
+
+
+ Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
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 Developer-managed Wallets using Ethereum on Base Sepolia.
+
+
IMPORTANT: The Coinbase SDK is currently under development, and may make backwards-incompatible changes.Do not use the Coinbase SDK to manage mainnet funds.
+
+
Documentation
+
+
+
TODO
+
+
+
Installation
+
+
+
Note: The gem is not published yet, the instructions below are for the future.
+
+
+
To use the package, run:
+
+
geminstallcoinbase-sdk
+
+
+
Or if you are using bundler, add the coinbase-sdk gem to your Gemfile:
+
+
gem'coinbase-sdk'
+
+
+
Then, run:
+
+
bundleinstall
+
+
+
Requirements
+
+
Ruby 2.6+.
+
+
+
Usage
+
+
+
TODO
+
+
+
Sample Code Snippet
+
+
The following creates an in-memory self-custodial wallet. After the wallet is funded with ETH, it transfers some 100 Wei to a different wallet.
+
+
# Initialize the SDK.
+Coinbase.init
+
+# Wallets are self-custodial with in-memory key management on Base Sepolia.
+# This should NOT be used in mainnet with real funds.
+w1=Coinbase::Wallet.new
+
+# A wallet has a default address.
+a=w1.default_address
+a.to_s
+
+# At this point, fund the wallet out-of-band using a faucet.
+# Then, we can transfer 100 wei out of the wallet to another wallet.
+w2=Coinbase::Wallet.new
+
+# We can now use the transaction hash to check the status of the transaction.
+transaction_hash=w1.transfer(100,:eth,w2)
+
+
+
Development
+
+
Ruby Version
+
+
Developing in this repository requires Ruby >= 2.6.0. To install this on an M2 Mac, run the following command:
This SDK transitively depends on rbsecp256k1. Follow these instructions to ensure you have the necessary dependencies installed.
+
+
The SDK assumes the existence of a BASE_SEPOLIA_RPCURL environment variable defined in your .env file. By default, this is the publicly available endpoint, which is rate-limited. To provision your own endpoint, go to the CDP Portal. Then copy and paste your Base Sepolia RPC URL in the .env file:
+
+
BASE_SEPOLIA_RPC_URL=YOUR-URL
+
+
+
Linting
+
+
To autocorrect all lint errors, run:
+
+
bundleexecrubocop-A
+
+
+
To detect all lint errors, run:
+
+
bundleexecrakelint
+
+
+
Testing
+
+
To run all tests, run:
+
+
bundleexecraketest
+
+
+
To run a specific test, run (for example):
+
+
bundleexecrspecspec/coinbase/wallet_spec.rb
+
+
+
REPL
+
+
The repository is equipped with a REPL to allow developers to play with the SDK. To start it, run:
+
+
bundleexecbin/repl
+
+
+
Generating Documentation
+
+
To generate documentation from the Ruby comments, run:
+
+
bundle exec yardoc --output-dir ./docs
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/file_list.html b/docs/file_list.html
new file mode 100644
index 00000000..2b6df404
--- /dev/null
+++ b/docs/file_list.html
@@ -0,0 +1,56 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ File List
+
+
+
+
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 Developer-managed Wallets using Ethereum on Base Sepolia.
+
+
IMPORTANT: The Coinbase SDK is currently under development, and may make backwards-incompatible changes.Do not use the Coinbase SDK to manage mainnet funds.
+
+
Documentation
+
+
+
TODO
+
+
+
Installation
+
+
+
Note: The gem is not published yet, the instructions below are for the future.
+
+
+
To use the package, run:
+
+
geminstallcoinbase-sdk
+
+
+
Or if you are using bundler, add the coinbase-sdk gem to your Gemfile:
+
+
gem'coinbase-sdk'
+
+
+
Then, run:
+
+
bundleinstall
+
+
+
Requirements
+
+
Ruby 2.6+.
+
+
+
Usage
+
+
+
TODO
+
+
+
Sample Code Snippet
+
+
The following creates an in-memory self-custodial wallet. After the wallet is funded with ETH, it transfers some 100 Wei to a different wallet.
+
+
# Initialize the SDK.
+Coinbase.init
+
+# Wallets are self-custodial with in-memory key management on Base Sepolia.
+# This should NOT be used in mainnet with real funds.
+w1=Coinbase::Wallet.new
+
+# A wallet has a default address.
+a=w1.default_address
+a.to_s
+
+# At this point, fund the wallet out-of-band using a faucet.
+# Then, we can transfer 100 wei out of the wallet to another wallet.
+w2=Coinbase::Wallet.new
+
+# We can now use the transaction hash to check the status of the transaction.
+transaction_hash=w1.transfer(100,:eth,w2)
+
+
+
Development
+
+
Ruby Version
+
+
Developing in this repository requires Ruby >= 2.6.0. To install this on an M2 Mac, run the following command:
This SDK transitively depends on rbsecp256k1. Follow these instructions to ensure you have the necessary dependencies installed.
+
+
The SDK assumes the existence of a BASE_SEPOLIA_RPCURL environment variable defined in your .env file. By default, this is the publicly available endpoint, which is rate-limited. To provision your own endpoint, go to the CDP Portal. Then copy and paste your Base Sepolia RPC URL in the .env file:
+
+
BASE_SEPOLIA_RPC_URL=YOUR-URL
+
+
+
Linting
+
+
To autocorrect all lint errors, run:
+
+
bundleexecrubocop-A
+
+
+
To detect all lint errors, run:
+
+
bundleexecrakelint
+
+
+
Testing
+
+
To run all tests, run:
+
+
bundleexecraketest
+
+
+
To run a specific test, run (for example):
+
+
bundleexecrspecspec/coinbase/wallet_spec.rb
+
+
+
REPL
+
+
The repository is equipped with a REPL to allow developers to play with the SDK. To start it, run:
+
+
bundleexecbin/repl
+
+
+
Generating Documentation
+
+
To generate documentation from the Ruby comments, run: