Skip to content

Commit

Permalink
Ready for publishing.
Browse files Browse the repository at this point in the history
  • Loading branch information
yuga-cb committed Apr 19, 2024
1 parent c3bc0ee commit c6b0d38
Show file tree
Hide file tree
Showing 17 changed files with 42 additions and 42 deletions.
2 changes: 1 addition & 1 deletion .rubocop.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
AllCops:
NewCops: disable
SuggestExtensions: false
TargetRubyVersion: 2.6
TargetRubyVersion: 2.7
# Tests can be long.
Metrics/BlockLength:
Enabled: false
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ format:
lint:
bundle exec rubocop

.PHONY: tests
tests:
.PHONY: test
test:
bundle exec rake test

.PHONY: repl
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ bundle install

### Requirements

- Ruby 2.6+.
- Ruby 2.7+.

## Usage

Expand Down Expand Up @@ -119,11 +119,11 @@ w1.transfer(0.00001, :eth, w2).wait!

### Ruby Version

Developing in this repository requires Ruby >= 2.6.0. To install this on an M2 Mac,
Developing in this repository requires Ruby >= 2.7.0. To install this on an M2 Mac,
run the [following command](https://github.com/rbenv/ruby-build/discussions/2034):

```bash
RUBY_CFLAGS=-DUSE_FFI_CLOSURE_ALLOC rbenv install 2.6.0
RUBY_CFLAGS=-DUSE_FFI_CLOSURE_ALLOC rbenv install 2.7.0
```

### Set-up
Expand Down Expand Up @@ -170,7 +170,7 @@ make lint
To run all tests, run:

```bash
make tests
make test
```

To run a specific test, run (for example):
Expand Down
8 changes: 4 additions & 4 deletions coinbase.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Gem::Specification.new do |spec|
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.6.0')
spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')

spec.metadata['rubygems_mfa_required'] = 'true'

spec.add_runtime_dependency 'bigdecimal'
spec.add_runtime_dependency 'dotenv'
spec.add_runtime_dependency 'dotenv', '2.8.1'
spec.add_runtime_dependency 'eth'
spec.add_runtime_dependency 'jimson'
spec.add_runtime_dependency 'money-tree'
Expand All @@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
spec.add_development_dependency 'rake'
spec.add_development_dependency 'rspec'
# Pin to a specific version of RuboCop to ensure consistent linting.
spec.add_development_dependency 'rubocop', '~> 1.63.1'
spec.add_development_dependency 'rubocop', '1.63.1'
# Pin to a specific version of YARD to ensure consistent documentation generation.
spec.add_development_dependency 'yard', '~> 0.9.36'
spec.add_development_dependency 'yard', '0.9.36'
end
2 changes: 1 addition & 1 deletion docs/Coinbase.html
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ <h3 class="signature first" id="init-class_method">
</div>

<div id="footer">
Generated on Fri Apr 19 09:00:19 2024 by
Generated on Fri Apr 19 10:24: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/Address.html
Original file line number Diff line number Diff line change
Expand Up @@ -1043,7 +1043,7 @@ <h3 class="signature " id="transfer-instance_method">
</div>

<div id="footer">
Generated on Fri Apr 19 09:00:20 2024 by
Generated on Fri Apr 19 10:24: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/Asset.html
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 Fri Apr 19 09:00:19 2024 by
Generated on Fri Apr 19 10:24: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/BalanceMap.html
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 Fri Apr 19 09:00:20 2024 by
Generated on Fri Apr 19 10:24: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/Network.html
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 Fri Apr 19 09:00:20 2024 by
Generated on Fri Apr 19 10:24: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/Transfer.html
Original file line number Diff line number Diff line change
Expand Up @@ -1293,7 +1293,7 @@ <h3 class="signature " id="wait!-instance_method">
</div>

<div id="footer">
Generated on Fri Apr 19 09:00:20 2024 by
Generated on Fri Apr 19 10:24: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/Transfer/Status.html
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ <h2>
</div>

<div id="footer">
Generated on Fri Apr 19 09:00:19 2024 by
Generated on Fri Apr 19 10:24: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/Wallet.html
Original file line number Diff line number Diff line change
Expand Up @@ -1408,7 +1408,7 @@ <h3 class="signature " id="transfer-instance_method">
</div>

<div id="footer">
Generated on Fri Apr 19 09:00:20 2024 by
Generated on Fri Apr 19 10:24: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/Wallet/WalletData.html
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ <h3 class="signature " id="seed-instance_method">
</div>

<div id="footer">
Generated on Fri Apr 19 09:00:20 2024 by
Generated on Fri Apr 19 10:24: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/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ <h2>Namespace Listing A-Z</h2>
</div>

<div id="footer">
Generated on Fri Apr 19 09:00:19 2024 by
Generated on Fri Apr 19 10:24: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
20 changes: 10 additions & 10 deletions docs/file.README.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h2 id="label-Installation">Installation</h2>

<h3 id="label-Requirements">Requirements</h3>
<ul><li>
<p>Ruby 2.6+.</p>
<p>Ruby 2.7+.</p>
</li></ul>

<h2 id="label-Usage">Usage</h2>
Expand Down Expand Up @@ -164,9 +164,9 @@ <h2 id="label-Development">Development</h2>

<h3 id="label-Ruby+Version">Ruby Version</h3>

<p>Developing in this repository requires Ruby &gt;= 2.6.0. To install this on an M2 Mac, run the <a href="https://github.com/rbenv/ruby-build/discussions/2034">following command</a>:</p>
<p>Developing in this repository requires Ruby &gt;= 2.7.0. To install this on an M2 Mac, run the <a href="https://github.com/rbenv/ruby-build/discussions/2034">following command</a>:</p>

<pre class="code ruby"><code class="ruby">RUBY_CFLAGS=-DUSE_FFI_CLOSURE_ALLOC rbenv install 2.6.0
<pre class="code ruby"><code class="ruby">RUBY_CFLAGS=-DUSE_FFI_CLOSURE_ALLOC rbenv install 2.7.0
</code></pre>

<h3 id="label-Set-up">Set-up</h3>
Expand All @@ -183,7 +183,7 @@ <h3 id="label-Set-up">Set-up</h3>

<p>This SDK transitively depends on <a href="https://github.com/etscrivner/rbsecp256k1">rbsecp256k1</a>. Follow <a href="https://github.com/etscrivner/rbsecp256k1?tab=readme-ov-file#requirements">these instructions</a> to ensure you have the necessary dependencies installed.</p>

<p>The SDK assumes the existence of a <code>BASE_SEPOLIA_RPCURL</code> 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 <a href="https://portal.cloud.coinbase.com/products/base">CDP Portal</a>. Then copy and paste your Base Sepolia RPC URL in the .env file:</p>
<p>The SDK assumes the existence of a <code>BASE_SEPOLIA_RPC_URL</code> 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 <a href="https://portal.cloud.coinbase.com/products/base">CDP Portal</a>. Then copy and paste your Base Sepolia RPC URL in the .env file:</p>

<pre class="code ruby"><code class="ruby"><span class='const'>BASE_SEPOLIA_RPC_URL</span><span class='op'>=</span><span class='const'>YOUR</span><span class='op'>-</span><span class='const'>URL</span>
</code></pre>
Expand All @@ -192,19 +192,19 @@ <h3 id="label-Linting">Linting</h3>

<p>To autocorrect all lint errors, run:</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='op'>-</span><span class='const'>A</span>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_make'>make</span> <span class='id identifier rubyid_format'>format</span>
</code></pre>

<p>To detect all lint errors, run:</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span> <span class='id identifier rubyid_lint'>lint</span>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_make'>make</span> <span class='id identifier rubyid_lint'>lint</span>
</code></pre>

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

<p>To run all tests, run:</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span> <span class='id identifier rubyid_test'>test</span>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_make'>make</span> <span class='id identifier rubyid_tests'>tests</span>
</code></pre>

<p>To run a specific test, run (for example):</p>
Expand All @@ -216,19 +216,19 @@ <h3 id="label-REPL">REPL</h3>

<p>The repository is equipped with a REPL to allow developers to play with the SDK. To start it, run:</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_bin'>bin</span><span class='op'>/</span><span class='id identifier rubyid_repl'>repl</span>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_make'>make</span> <span class='id identifier rubyid_repl'>repl</span>
</code></pre>

<h3 id="label-Generating+Documentation">Generating Documentation</h3>

<p>To generate documentation from the Ruby comments, run:</p>

<pre class="code ruby"><code class="ruby">bundle exec yardoc --output-dir ./docs
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_make'>make</span> <span class='id identifier rubyid_docs'>docs</span>
</code></pre>
</div></div>

<div id="footer">
Generated on Fri Apr 19 09:00:19 2024 by
Generated on Fri Apr 19 10:24: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
20 changes: 10 additions & 10 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h2 id="label-Installation">Installation</h2>

<h3 id="label-Requirements">Requirements</h3>
<ul><li>
<p>Ruby 2.6+.</p>
<p>Ruby 2.7+.</p>
</li></ul>

<h2 id="label-Usage">Usage</h2>
Expand Down Expand Up @@ -164,9 +164,9 @@ <h2 id="label-Development">Development</h2>

<h3 id="label-Ruby+Version">Ruby Version</h3>

<p>Developing in this repository requires Ruby &gt;= 2.6.0. To install this on an M2 Mac, run the <a href="https://github.com/rbenv/ruby-build/discussions/2034">following command</a>:</p>
<p>Developing in this repository requires Ruby &gt;= 2.7.0. To install this on an M2 Mac, run the <a href="https://github.com/rbenv/ruby-build/discussions/2034">following command</a>:</p>

<pre class="code ruby"><code class="ruby">RUBY_CFLAGS=-DUSE_FFI_CLOSURE_ALLOC rbenv install 2.6.0
<pre class="code ruby"><code class="ruby">RUBY_CFLAGS=-DUSE_FFI_CLOSURE_ALLOC rbenv install 2.7.0
</code></pre>

<h3 id="label-Set-up">Set-up</h3>
Expand All @@ -183,7 +183,7 @@ <h3 id="label-Set-up">Set-up</h3>

<p>This SDK transitively depends on <a href="https://github.com/etscrivner/rbsecp256k1">rbsecp256k1</a>. Follow <a href="https://github.com/etscrivner/rbsecp256k1?tab=readme-ov-file#requirements">these instructions</a> to ensure you have the necessary dependencies installed.</p>

<p>The SDK assumes the existence of a <code>BASE_SEPOLIA_RPCURL</code> 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 <a href="https://portal.cloud.coinbase.com/products/base">CDP Portal</a>. Then copy and paste your Base Sepolia RPC URL in the .env file:</p>
<p>The SDK assumes the existence of a <code>BASE_SEPOLIA_RPC_URL</code> 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 <a href="https://portal.cloud.coinbase.com/products/base">CDP Portal</a>. Then copy and paste your Base Sepolia RPC URL in the .env file:</p>

<pre class="code ruby"><code class="ruby"><span class='const'>BASE_SEPOLIA_RPC_URL</span><span class='op'>=</span><span class='const'>YOUR</span><span class='op'>-</span><span class='const'>URL</span>
</code></pre>
Expand All @@ -192,19 +192,19 @@ <h3 id="label-Linting">Linting</h3>

<p>To autocorrect all lint errors, run:</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='op'>-</span><span class='const'>A</span>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_make'>make</span> <span class='id identifier rubyid_format'>format</span>
</code></pre>

<p>To detect all lint errors, run:</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span> <span class='id identifier rubyid_lint'>lint</span>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_make'>make</span> <span class='id identifier rubyid_lint'>lint</span>
</code></pre>

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

<p>To run all tests, run:</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span> <span class='id identifier rubyid_test'>test</span>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_make'>make</span> <span class='id identifier rubyid_tests'>tests</span>
</code></pre>

<p>To run a specific test, run (for example):</p>
Expand All @@ -216,19 +216,19 @@ <h3 id="label-REPL">REPL</h3>

<p>The repository is equipped with a REPL to allow developers to play with the SDK. To start it, run:</p>

<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_bin'>bin</span><span class='op'>/</span><span class='id identifier rubyid_repl'>repl</span>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_make'>make</span> <span class='id identifier rubyid_repl'>repl</span>
</code></pre>

<h3 id="label-Generating+Documentation">Generating Documentation</h3>

<p>To generate documentation from the Ruby comments, run:</p>

<pre class="code ruby"><code class="ruby">bundle exec yardoc --output-dir ./docs
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_make'>make</span> <span class='id identifier rubyid_docs'>docs</span>
</code></pre>
</div></div>

<div id="footer">
Generated on Fri Apr 19 09:00:19 2024 by
Generated on Fri Apr 19 10:24: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/top-level-namespace.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h2>Defined Under Namespace</h2>
</div>

<div id="footer">
Generated on Fri Apr 19 09:00:19 2024 by
Generated on Fri Apr 19 10:24: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

0 comments on commit c6b0d38

Please sign in to comment.