Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #19

Merged
merged 7 commits into from
Apr 30, 2024
Merged

Update README #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5b07057
Update README
yuga-cb Apr 30, 2024
fde3716
Remove network_id from create_transfer_request
yuga-cb Apr 30, 2024
2bad313
Revert network Id change
yuga-cb Apr 30, 2024
bd3e1fa
Merge branch 'v0.0.2' into yuga/readme
yuga-cb Apr 30, 2024
c10966b
Fix USDC balances client-side
yuga-cb Apr 30, 2024
7f82406
Merge branch 'v0.0.2' into yuga/readme
yuga-cb Apr 30, 2024
fe89ff3
Fix transfer
yuga-cb Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,15 @@ require 'coinbase'

### Initialization

To start, [create a CDP API Key](https://portal.cdp.coinbase.com/access/api). Then, initialize the Platform SDK by passing your API Key name and API Key private key via the `configure` method:
To start, [create a CDP API Key](https://portal.cdp.coinbase.com/access/api). Then, initialize the Platform SDK by passing your API Key name and API Key's private key via the `configure` method:

```ruby
api_key_name = 'Copy your API Key name here.'
api_key_private_key = 'Copy your API Key\'s private key here.'

Coinbase.configure do |config|
config.api_key_name = 'organizations/your-org-id/apiKeys/your-api-key-id'
config.api_key_private_key = '-----BEGIN EC PRIVATE KEY-----\nyour-api-key-private-key\n-----END EC PRIVATE KEY-----\n'
config.api_key_name = api_key_name
config.api_key_private_key = api_key_private_key
end
```

Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,7 +777,7 @@ <h3 class="signature " id="to_sym-class_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Address.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1018,7 +1018,7 @@ <h3 class="signature " id="wallet_id-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Asset.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,7 @@ <h3 class="signature " id="network_id-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Authenticator.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ <h3 class="signature " id="call-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:54 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/BalanceMap.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ <h3 class="signature " id="to_s-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:54 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ <h3 class="signature first" id="configure-class_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/Address.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2083,7 +2083,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:55 2024 by
Generated on Tue Apr 30 15:12:26 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/AddressBalanceList.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2087,7 +2087,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:56 2024 by
Generated on Tue Apr 30 15:12:28 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/AddressList.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2087,7 +2087,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:56 2024 by
Generated on Tue Apr 30 15:12:27 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/AddressesApi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2272,7 +2272,7 @@ <h3 class="signature " id="list_addresses_with_http_info-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:55 2024 by
Generated on Tue Apr 30 15:12:27 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/ApiClient.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2962,7 +2962,7 @@ <h3 class="signature " id="user_agent=-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:54 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/ApiError.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@ <h3 class="signature " id="to_s-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:54 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/Asset.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2066,7 +2066,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:54 2024 by
Generated on Tue Apr 30 15:12:26 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/Balance.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1898,7 +1898,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:55 2024 by
Generated on Tue Apr 30 15:12:26 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/Configuration.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3835,7 +3835,7 @@ <h3 class="signature " id="use-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:55 2024 by
Generated on Tue Apr 30 15:12:26 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/CreateAddressRequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1887,7 +1887,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:56 2024 by
Generated on Tue Apr 30 15:12:28 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/CreateTransferRequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2083,7 +2083,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:56 2024 by
Generated on Tue Apr 30 15:12:28 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/CreateWalletRequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1789,7 +1789,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:56 2024 by
Generated on Tue Apr 30 15:12:28 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/Error.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1918,7 +1918,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:54 2024 by
Generated on Tue Apr 30 15:12:26 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/Transfer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2598,7 +2598,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:55 2024 by
Generated on Tue Apr 30 15:12:27 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/Transfer/EnumAttributeValidator.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ <h3 class="signature first" id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:55 2024 by
Generated on Tue Apr 30 15:12:27 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/TransferList.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2087,7 +2087,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:56 2024 by
Generated on Tue Apr 30 15:12:27 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/TransfersApi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1550,7 +1550,7 @@ <h3 class="signature " id="list_transfers_with_http_info-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:56 2024 by
Generated on Tue Apr 30 15:12:27 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/User.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1873,7 +1873,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:54 2024 by
Generated on Tue Apr 30 15:12:26 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/UsersApi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ <h3 class="signature " id="get_current_user_with_http_info-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:54 2024 by
Generated on Tue Apr 30 15:12:26 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/Wallet.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1957,7 +1957,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:55 2024 by
Generated on Tue Apr 30 15:12:26 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/WalletList.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2098,7 +2098,7 @@ <h3 class="signature " id="valid?-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:56 2024 by
Generated on Tue Apr 30 15:12:27 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Client/WalletsApi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2002,7 +2002,7 @@ <h3 class="signature " id="list_wallets_with_http_info-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:55 2024 by
Generated on Tue Apr 30 15:12:27 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Configuration.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ <h3 class="signature first" id="api_client-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/InvalidConfiguration.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Middleware.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ <h3 class="signature first" id="config-class_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Network.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@ <h3 class="signature " id="list_assets-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:54 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Transfer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1386,7 +1386,7 @@ <h3 class="signature " id="wallet_id-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:54 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Transfer/Status.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ <h2>
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/User.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ <h3 class="signature " id="user_id-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Coinbase/Wallet.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1351,7 +1351,7 @@ <h3 class="signature " id="wallet_id-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Coinbase/Wallet/Data.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ <h3 class="signature first" id="from_hash-class_method">
<pre class="code"><span class="info file"># File 'lib/coinbase/wallet.rb', line 176</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_hash'>from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wallet_id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>seed]</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="" title="Coinbase::Wallet::Data (class)">Data</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Coinbase::Wallet::Data#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wallet_id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>seed</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
Expand Down Expand Up @@ -603,7 +603,7 @@ <h3 class="signature first" id="to_hash-instance_method">
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ <h2>Namespace Listing A-Z</h2>
</div>

<div id="footer">
Generated on Tue Apr 30 12:26:52 2024 by
Generated on Tue Apr 30 15:12:24 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
13 changes: 8 additions & 5 deletions docs/file.README.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,14 @@ <h2 id="label-Usage">Usage</h2>

<h3 id="label-Initialization">Initialization</h3>

<p>To start, <a href="https://portal.cdp.coinbase.com/access/api">create a CDP API Key</a>. Then, initialize the Platform SDK by passing your API Key name and API Key private key via the <code>configure</code> method:</p>
<p>To start, <a href="https://portal.cdp.coinbase.com/access/api">create a CDP API Key</a>. Then, initialize the Platform SDK by passing your API Key name and API Key&#39;s private key via the <code>configure</code> method:</p>

<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Coinbase.html" title="Coinbase (module)">Coinbase</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="Coinbase.html#configure-class_method" title="Coinbase.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_key_name'>api_key_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>organizations/your-org-id/apiKeys/your-api-key-id</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_key_private_key'>api_key_private_key</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-----BEGIN EC PRIVATE KEY-----\nyour-api-key-private-key\n-----END EC PRIVATE KEY-----\n</span><span class='tstring_end'>&#39;</span></span>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_api_key_name'>api_key_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Copy your API Key name here.</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_api_key_private_key'>api_key_private_key</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Copy your API Key\&#39;s private key here.</span><span class='tstring_end'>&#39;</span></span>

<span class='const'><span class='object_link'><a href="Coinbase.html" title="Coinbase (module)">Coinbase</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="Coinbase.html#configure-class_method" title="Coinbase.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_key_name'>api_key_name</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key_name'>api_key_name</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_key_private_key'>api_key_private_key</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key_private_key'>api_key_private_key</span>
<span class='kw'>end</span>
</code></pre>

Expand Down Expand Up @@ -250,7 +253,7 @@ <h3 id="label-Generating+Documentation">Generating Documentation</h3>
</div></div>

<div id="footer">
Generated on Tue Apr 30 12:26:53 2024 by
Generated on Tue Apr 30 15:12:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.0).
</div>
Expand Down
Loading
Loading