near 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 147f21ee313f56cb2e1327e8817df79796dd56fe90eff771e9057e6d7248c4f5
-  data.tar.gz: bf81f3240cb7e18c519d85696bf472b1bf2c8e56c3049aa942fe2aaae37e38f6
+  metadata.gz: aa0995c2a2fec35657f6ce459546a2f3a83b69d306965a301da46a99fb64afc3
+  data.tar.gz: 56826739970ee57d1485fd533404523408fc8072f1db2b7cd64f18864e6c99ce
 SHA512:
-  metadata.gz: 4cfef8be7777c9dd2f2f839284581a44a0f2479f256f09e759628c21509a6d3bc9b95ad07c7e0e13a2e8c22aa5238bd826a224cdac9c6e649388bd060971569d
-  data.tar.gz: 4c5e69608fe79e7a1e0f7a9046477ea9c590d61d1ee6bf12b530054775fc26464d68ddd29c6c9655f05459faf2752a4c7119e5a29afb17a2500ba115618d0b3d
+  metadata.gz: dfa74fb61db51e15c37af7c9b95c2b0d5ae15595f59bdce9b1198ed866eec9a2c7bc739b2149e0217593ee340af72af78e674fd7891b2b825f487f66bf979985
+  data.tar.gz: dfce931afa3709136c6f1f5bf42d9d1bdbf180af3e1d172d179c702b6614678cfae746829f3a3fb698c59d26c2bec17e5aa37169deb05f89e55312dbac86dab9

data/CHANGES.md

@@ -5,30 +5,35 @@ 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).
 
-## 0.3.0 - 2025-02-02
+## 0.3.2 - 2025-05-12
+### Changed
+- Enhance `call_function` and `deploy_contract`
+### Added
+- Define `NEAR::Transaction::MAX_SIZE`
+### Fixed
+- Fix detection of printable strings
+
+## 0.3.1 - 2025-02-05
 
+## 0.3.0 - 2025-02-02
 ### Added
 - Implement block data accessors
 - Implement transaction data accessors
 - Implement action parsing
-
 ### Changed
 - Adopt Faraday as the HTTP client
 - Improve HTTP error handling and retries
 
 ## 0.2.0 - 2025-01-29
-
 ### Added
 - `Network#fetch(block)`
 - `NEAR.testnet`, `NEAR.mainnet`
-
 ### Changed
 - Use the NEAR_CLI environmnet variable, if set
 - Use a temporary file for `call_function`
 - Enhance `call_function()`
 - Enhance `create_account_with_funding()`
 - Enhance `delete_account()`
-
 ### Fixed
 - Fix the formatting of balances
 

data/README.md

@@ -1,17 +1,18 @@
 # NEAR.rb: NEAR for Ruby
 
 [![License](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
-[![Compatibility](https://img.shields.io/badge/ruby-3.0%2B-blue)](https://rubygems.org/gems/near)
+[![Compatibility](https://img.shields.io/badge/ruby-3.0%2B-blue)](https://rubyreferences.github.io/rubychanges/3.0.html)
 [![Package](https://img.shields.io/gem/v/near)](https://rubygems.org/gems/near)
 [![Documentation](https://img.shields.io/badge/rubydoc-latest-blue)](https://rubydoc.info/gems/near)
 
 **NEAR.rb** is a [Ruby] client library for the [NEAR Protocol].
-It provides a [neardata.xyz] API client as well as wraps the
-[NEAR command-line interface] (CLI) in a usable Ruby interface.
+It provides a [neardata.xyz] API client for block data as well as wraps the
+[NEAR Command-Line Interface] (CLI) in a high-productivity Ruby interface.
 
 ## ✨ Features
 
 - Fetches block data from the [neardata.xyz] API.
+- Supports parsing of block, chunk, transaction, and action data.
 - Wraps the complete CLI features in an idiomatic Ruby interface.
 - Provides comprehensive account management operations.
 - Supports token operations for NEAR and other assets.
@@ -25,7 +26,7 @@ It provides a [neardata.xyz] API client as well as wraps the
 
 ## 🛠️ Prerequisites
 
-- [NEAR CLI] 0.19+
+- [NEAR CLI] 0.18+
 - [Ruby] 3.0+
 
 ## ⬇️ Installation
@@ -84,8 +85,6 @@ end
 
 ### Tracking chain transactions
 
-See [`examples/monitor_all_transactions.rb`](examples/monitor_all_transactions.rb).
-
 ```ruby
 NEAR.testnet.fetch_blocks do |block|
   puts block.inspect
@@ -96,9 +95,12 @@ NEAR.testnet.fetch_blocks do |block|
 end
 ```
 
-### Tracking chain actions
+For a more elaborated example, see
+[`examples/monitor_all_transactions.rb`](examples/monitor_all_transactions.rb):
 
-See [`examples/monitor_all_actions.rb`](examples/monitor_all_actions.rb).
+[![monitor_all_transactions.rb](examples/monitor_all_transactions.gif)](examples/monitor_all_transactions.gif)
+
+### Tracking chain actions
 
 ```ruby
 NEAR.testnet.fetch_blocks do |block|
@@ -110,9 +112,12 @@ NEAR.testnet.fetch_blocks do |block|
 end
 ```
 
-### Tracking contract interactions
+For a more elaborated example, see
+[`examples/monitor_all_actions.rb`](examples/monitor_all_actions.rb):
 
-See [`examples/index_evm_transactions.rb`](examples/index_evm_transactions.rb).
+[![monitor_all_actions.rb](examples/monitor_all_actions.gif)](examples/monitor_all_actions.gif)
+
+### Tracking contract interactions
 
 ```ruby
 NEAR.testnet.fetch_blocks do |block|
@@ -124,6 +129,11 @@ NEAR.testnet.fetch_blocks do |block|
 end
 ```
 
+For a more elaborated example, see
+[`examples/index_evm_transactions.rb`](examples/index_evm_transactions.rb):
+
+[![index_evm_transactions.rb](examples/index_evm_transactions.gif)](examples/index_evm_transactions.gif)
+
 ### Instantiating the CLI wrapper
 
 ```ruby
@@ -177,7 +187,7 @@ result = testnet.import_account_with_private_key(
 # Create an account funded from a faucet (testnet only):
 result = testnet.create_account_with_faucet(
   'mynewaccount.testnet',
-  'ed25519:HVPgAsZkZ7cwLZDqK313XJsDyqAvgBxrATcD7VacA8KE'
+  public_key: 'ed25519:HVPgAsZkZ7cwLZDqK313XJsDyqAvgBxrATcD7VacA8KE'
 )
 
 # Create an account funded by another account:
@@ -197,8 +207,8 @@ result = testnet.create_implicit_account('/path/to/credentials/folder')
 ```ruby
 # Delete an existing account:
 result = testnet.delete_account(
-  'todelete.testnet',     # account to delete
-  'beneficiary.testnet'   # account receiving remaining balance
+  'my-obsolete-account.testnet',                # account to delete
+  beneficiary: 'v2.faucet.nonofficial.testnet'  # account receiving remaining balance
 )
 ```
 
@@ -303,12 +313,13 @@ https://rubydoc.info/gems/near
 git clone https://github.com/dryruby/near.rb.git
 ```
 
-- - -
+---
 
-[![Share on Twitter](https://img.shields.io/badge/share%20on-twitter-03A9F4?logo=twitter)](https://x.com/share?url=https://github.com/dryruby/near.rb&text=NEAR.rb)
+[![Share on X](https://img.shields.io/badge/share%20on-x-03A9F4?logo=x)](https://x.com/intent/post?url=https://github.com/dryruby/near.rb&text=NEAR.rb)
 [![Share on Reddit](https://img.shields.io/badge/share%20on-reddit-red?logo=reddit)](https://reddit.com/submit?url=https://github.com/dryruby/near.rb&title=NEAR.rb)
-[![Share on Hacker News](https://img.shields.io/badge/share%20on-hacker%20news-orange?logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/dryruby/near.rb&t=NEAR.rb)
-[![Share on Facebook](https://img.shields.io/badge/share%20on-facebook-1976D2?logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/dryruby/near.rb)
+[![Share on Hacker News](https://img.shields.io/badge/share%20on-hn-orange?logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/dryruby/near.rb&t=NEAR.rb)
+[![Share on Facebook](https://img.shields.io/badge/share%20on-fb-1976D2?logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/dryruby/near.rb)
+[![Share on LinkedIn](https://img.shields.io/badge/share%20on-linkedin-3949AB?logo=linkedin)](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/dryruby/near.rb)
 
 [NEAR CLI]: https://github.com/near/near-cli-rs
 [NEAR Protocol]: https://near.org

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.2

data/lib/near/account.rb

@@ -5,10 +5,20 @@
 #
 # @see https://nomicon.io/DataStructures/Account
 class NEAR::Account
+  ##
+  # @param [String, #to_s] id
+  # @return [NEAR::Account]
   def self.parse(id)
     self.new(id.to_s)
   end
 
+  ##
+  # @return [NEAR::Account]
+  def self.temp
+    timestamp = (Time.now.to_f * 1_000).to_i
+    self.new("temp-#{timestamp}.testnet")
+  end
+
   ##
   # @param [String, #to_s] id
   def initialize(id)

data/lib/near/cli/account.rb

@@ -70,15 +70,20 @@ module NEAR::CLI::Account
   ##
   # Creates a new account sponsored by the faucet service.
   #
-  # @param [String] new_account_id
-  # @param [String] public_key
+  # @param [NEAR::Account, #to_s] new_account
+  # @param [String, nil] public_key
   # @return [String]
-  def create_account_with_faucet(new_account_id, public_key)
+  def create_account_with_faucet(new_account, public_key: nil)
     stdout, stderr = execute(
       'account',
       'create-account',
-      'sponsor-by-faucet-service', new_account_id,
-      'use-manually-provided-public-key', public_key,
+      'sponsor-by-faucet-service', new_account.to_s,
+      *case public_key
+        when nil then ['autogenerate-new-keypair', 'save-to-keychain']
+        when String then ['use-manually-provided-public-key', public_key]
+        when Array then public_key
+        else raise ArgumentError
+      end,
       'network-config', @network,
       'create'
     )
@@ -88,16 +93,22 @@ module NEAR::CLI::Account
   ##
   # Creates a new account funded by another account.
   #
-  # @param [NEAR::Account] new_account
-  # @param [NEAR::Account] signer Account that signs & funds the transaction
-  # @param [NEAR::Balance] deposit Amount of NEAR to attach
+  # @param [NEAR::Account, #to_s] new_account
+  # @param [NEAR::Account, #to_s] signer Account that signs & funds the transaction
+  # @param [String, nil] public_key
+  # @param [NEAR::Balance, #to_s] deposit Amount of NEAR to attach
   # @return [String]
-  def create_account_with_funding(new_account, signer:, deposit: nil)
+  def create_account_with_funding(new_account, signer:, public_key: nil, deposit: nil)
     stdout, stderr = execute(
       'account',
       'create-account',
       'fund-myself', new_account.to_s, (deposit ? deposit.to_s : '0') + ' NEAR',
-      'autogenerate-new-keypair', 'save-to-keychain',
+      *case public_key
+        when nil then ['autogenerate-new-keypair', 'save-to-keychain']
+        when String then ['use-manually-provided-public-key', public_key]
+        when Array then public_key
+        else raise ArgumentError
+      end,
       'sign-as', signer.to_s,
       'network-config', @network,
       'sign-with-keychain',

data/lib/near/cli/contract.rb

@@ -36,12 +36,12 @@ module NEAR::CLI::Contract
   # @param [NEAR::Balance] deposit Amount of NEAR to attach
   # @param [NEAR::Gas, #to_s] gas Amount of gas to attach
   # @return [String] Transaction result
-  def call_function(contract, method_name, args = {}, signer:, deposit: nil, gas: '100.0 Tgas')
+  def call_function(contract, method_name, args = {}, signer: nil, deposit: nil, gas: '100.0 Tgas')
     args = case args
       when Hash, Array then ['json-args', args.to_json]
-      when String then case
-        when args.ascii_only? then ['text-args', args]
-        else ['base64-args', Base64.strict_encode64(args)]
+      when String then case args
+        when /[^[:print:]]/ then ['base64-args', Base64.strict_encode64(args)]
+        else ['text-args', args]
       end
       when Pathname then ['file-args', args.to_s]
       else raise ArgumentError, "Invalid argument type: #{args.inspect}"
@@ -53,7 +53,7 @@ module NEAR::CLI::Contract
       *args,
       'prepaid-gas', gas.to_s,
       'attached-deposit', (deposit ? deposit.to_s : '0') + ' NEAR',
-      'sign-as', signer.to_s,
+      'sign-as', (signer || contract).to_s,
       'network-config', @network,
       'sign-with-keychain',
       'send'
@@ -65,34 +65,34 @@ module NEAR::CLI::Contract
   ##
   # Deploys a new contract.
   #
-  # @param [String] contract_id Account to deploy the contract to
+  # @param [NEAR::Account, #to_s] contract Account to deploy the contract to
   # @param [String] wasm_path Path to the .wasm file
-  # @param [String] signer_id Account that signs the transaction
   # @param [String, nil] init_method Method to call after deployment
   # @param [Hash] init_args Arguments for the init method
   # @param [String] init_deposit Deposit for the init method
   # @param [String] init_gas Gas for the init method
   # @return [String] Transaction result
-  def deploy_contract(contract_id, wasm_path, signer_id:, init_method: nil, init_args: {},
+  def deploy_contract(contract, wasm_path, init_method: nil, init_args: {},
                      init_deposit: '0 NEAR', init_gas: '30 TGas')
     args = [
       'contract',
       'deploy',
-      contract_id,
+      contract.to_s,
       'use-file', wasm_path
     ]
 
-    if init_method
-      args += [
+    args += if init_method
+      [
         'with-init-call', init_method,
         'json-args', init_args.to_json,
         'prepaid-gas', init_gas,
         'attached-deposit', init_deposit
       ]
+    else
+      ['without-init-call']
     end
 
     args += [
-      'sign-as', signer_id,
       'network-config', @network,
       'sign-with-keychain',
       'send'

data/lib/near/transaction.rb

@@ -3,6 +3,12 @@
 ##
 # Represents a NEAR transaction.
 class NEAR::Transaction
+  ##
+  # The maximum byte size of a NEAR transaction.
+  #
+  # @see https://github.com/near/nearcore/blob/3a584c2/core/parameters/res/runtime_configs/parameters.snap#L187
+  MAX_SIZE = 1_572_864
+
   ##
   # @param [Hash] json
   # @return [NEAR::Transaction]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: near
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Arto Bendiken
 bindir: bin
 cert_chain: []
-date: 2025-02-02 00:00:00.000000000 Z
+date: 2025-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -85,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: 'NEAR.rb: NEAR for Ruby'
 test_files: []