Merge pull request #127 from coinbase/v0.0.14

V0.0.14

CAPABILITIES.md

@@ -0,0 +1,35 @@
+# Capabilities
+
+The Coinbase SDK has different capabilities for different wallet types and networks. This page summarizes
+those capabilities for the Ruby SDK:
+
+## Developer Wallets
+
+| Concept       | Base-Sepolia | Base-Mainnet | Ethereum-Holesky | Ethereum-Mainnet |
+| ------------- | :----------: | :----------: | :--------------: | :--------------: |
+| Addresses     |      ✅      |      ✅      |        ✅        |        ✅        |
+| Send          |      ✅      |      ✅      |        ✅        |        ❌        |
+| Trade         |      ❌      |      ✅      |        ❌        |        ❌        |
+| Faucet        |      ✅      |      ❌      |        ✅        |        ❌        |
+| Server-Signer |      ✅      |      ✅      |        ❌        |        ❌        |
+| Stake [^1]    |      ❌      |      ❌      |        ✅        |        ✅        |
+
+[^1]: Currently only available for Shared ETH Staking.
+
+## End-User Wallets
+
+| Concept            | Base-Sepolia | Base-Mainnet | Ethereum-Holesky | Ethereum-Mainnet |
+| ------------------ | :----------: | :----------: | :--------------: | :--------------: |
+| External Addresses |      ✅      |      ✅      |        ✅        |        ✅        |
+| Stake [^2]         |      ❌      |      ❌      |        ✅        |        ✅        |
+
+[^2]: Dedicated ETH Staking is currently only available on Testnet (Ethereum-Holesky).
+
+## Testnet vs. Mainnet
+
+The Coinbase SDK supports both testnets and mainnets.
+
+- Testnets are for building and testing applications. Funds are not real, and you can get test currencies from a faucet.
+- Mainnet is where the funds, contracts and applications are real.
+
+Wallets, assets, etc, cannot be moved from testnet to mainnet (or vice versa).

CHANGELOG.md

@@ -5,7 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [0.0.14] - 2024-08-05
+
+### Added
+
+- Support for Shared ETH Staking for Wallet Addresses
+
+### Changed
+
+- `unsigned_payload`, `signed_payload`, `status`, and `transaction_hash` in-line fields on `Transfer` are deprecated in
+  favor of those on `Transaction`
 
 ## [0.0.13] - 2024-07-30
 
@@ -49,10 +58,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Ability to trade assets from wallet and addresses
-  - Note: Only supported on `base-mainnet`, not on `base-sepolia`.
+    - Note: Only supported on `base-mainnet`, not on `base-sepolia`.
 - `base-mainnet` network support
-  - Note: Faucet functionality is not supported.
-  - Note: Server signer functionality is not yet supported.
+    - Note: Faucet functionality is not supported.
+    - Note: Server signer functionality is not yet supported.
 - ServerSigner object
 - Ability to get default Server-Signer
 

coinbase.gemspec

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 Gem::Specification.new do |spec|
-  spec.name          = 'coinbase-sdk'
-  spec.version       = '0.0.13'
-  spec.authors       = ['Yuga Cohler']
-  spec.files         = Dir['lib/**/*.rb']
-  spec.summary       = 'Coinbase Ruby SDK'
+  spec.name = 'coinbase-sdk'
+  spec.version = '0.0.14'
+  spec.authors = ['Yuga Cohler']
+  spec.files = Dir['lib/**/*.rb']
+  spec.summary = 'Coinbase Ruby SDK'
 
-  spec.description   = 'Coinbase Ruby SDK for accessing Coinbase Platform APIs'
-  spec.email         = '[email protected]'
-  spec.homepage      = 'https://github.com/coinbase/coinbase-sdk-ruby'
-  spec.license       = 'Apache-2.0'
+  spec.description = 'Coinbase Ruby SDK for accessing Coinbase Platform APIs'
+  spec.email = '[email protected]'
+  spec.homepage = 'https://github.com/coinbase/coinbase-sdk-ruby'
+  spec.license = 'Apache-2.0'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['rubygems_mfa_required'] = 'true'
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'eth'
   spec.add_runtime_dependency 'faraday'
   spec.add_runtime_dependency 'faraday-multipart'
+  spec.add_runtime_dependency 'faraday-retry'
   spec.add_runtime_dependency 'jwt'
   spec.add_runtime_dependency 'marcel'
   spec.add_runtime_dependency 'money-tree'

docs/Coinbase.html

@@ -493,16 +493,16 @@ <h3 class="signature first" id="call_api-class_method">
       <pre class="lines">
 
 
-126
 127
 128
 129
 130
 131
-132</pre>
+132
+133</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 126</span>
+      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 127</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span>
   <span class='kw'>yield</span>
@@ -818,12 +818,12 @@ <h3 class="signature " id="configured?-class_method">
       <pre class="lines">
 
 
-142
 143
-144</pre>
+144
+145</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 142</span>
+      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 143</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configured?'>configured?</span>
   <span class='op'>!</span><span class='const'><span class='object_link'><a href="" title="Coinbase (module)">Coinbase</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configuration'><span class='object_link'><a href="#configuration-class_method" title="Coinbase.configuration (method)">configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_key_name'><span class='object_link'><a href="Coinbase/Configuration.html#api_key_name-instance_method" title="Coinbase::Configuration#api_key_name (method)">api_key_name</a></span></span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='const'><span class='object_link'><a href="" title="Coinbase (module)">Coinbase</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configuration'><span class='object_link'><a href="#configuration-class_method" title="Coinbase.configuration (method)">configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_key_private_key'><span class='object_link'><a href="Coinbase/Configuration.html#api_key_private_key-instance_method" title="Coinbase::Configuration#api_key_private_key (method)">api_key_private_key</a></span></span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
@@ -877,12 +877,12 @@ <h3 class="signature " id="default_user-class_method">
       <pre class="lines">
 
 
-98
 99
-100</pre>
+100
+101</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 98</span>
+      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 99</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_user'>default_user</span>
   <span class='ivar'>@default_user</span> <span class='op'>||=</span> <span class='id identifier rubyid_load_default_user'>load_default_user</span>
@@ -936,14 +936,14 @@ <h3 class="signature " id="load_default_user-class_method">
       <pre class="lines">
 
 
-118
 119
 120
 121
-122</pre>
+122
+123</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 118</span>
+      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 119</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_default_user'>load_default_user</span>
   <span class='id identifier rubyid_users_api'>users_api</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Coinbase (module)">Coinbase</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Coinbase/Client.html" title="Coinbase::Client (module)">Client</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Coinbase/Client/UsersApi.html" title="Coinbase::Client::UsersApi (class)">UsersApi</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Coinbase/Client/UsersApi.html#initialize-instance_method" title="Coinbase::Client::UsersApi#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_api_client'>api_client</span><span class='rparen'>)</span>
@@ -1019,12 +1019,12 @@ <h3 class="signature " id="normalize_network-class_method">
       <pre class="lines">
 
 
-112
 113
-114</pre>
+114
+115</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 112</span>
+      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 113</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_normalize_network'>normalize_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_sym'>network_sym</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_network_sym'>network_sym</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>_</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
@@ -1098,12 +1098,12 @@ <h3 class="signature " id="to_sym-class_method">
       <pre class="lines">
 
 
-105
 106
-107</pre>
+107
+108</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 105</span>
+      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 106</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
@@ -1157,12 +1157,12 @@ <h3 class="signature " id="use_server_signer?-class_method">
       <pre class="lines">
 
 
-136
 137
-138</pre>
+138
+139</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 136</span>
+      <pre class="code"><span class="info file"># File 'lib/coinbase.rb', line 137</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_use_server_signer?'>use_server_signer?</span>
   <span class='const'><span class='object_link'><a href="" title="Coinbase (module)">Coinbase</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configuration'><span class='object_link'><a href="#configuration-class_method" title="Coinbase.configuration (method)">configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_use_server_signer'><span class='object_link'><a href="Coinbase/Configuration.html#use_server_signer-instance_method" title="Coinbase::Configuration#use_server_signer (method)">use_server_signer</a></span></span>