gasfree_sdk 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a368c1b6e6f12801569a0874cdef79af724a074f4a31a51843a3f569ca411d
-  data.tar.gz: eab16b631f5d5b4f3a84caa263cd4bfbcdc153f299da52c8d765f6da6ad4da3f
+  metadata.gz: c8aeb4c75e0cd23ef92ce14e8bb3eff5a603b3548adb107e2972ca405f6c5d1f
+  data.tar.gz: 5ae0d2003914b2213836d436f0f4e3d33a7863e2575ff7b6055a00ba6b8f3c33
 SHA512:
-  metadata.gz: 1405d5c293cac1560e6c4ee8313be4214e3d51c2ff5e7f80c5d2b83c47b6556bbf188ffedb339c8f21c1914c2a8457e564ae26004d7b1f5623a55062fde086be
-  data.tar.gz: 064c36e078a3ef3de405c09a8d3783e1000bd86dc29064f9735de547aaad6b71658641f30a74224b37b223bc30e292dda0543a98e4d9e6186d696373c1bb2710
+  metadata.gz: 0c62cbe4781d62f6b4a448f9e7e9dc56bd2fc5ebd5db255f4629fac1b090e6ef47e13a087adc0c3abe678912e1ced805e8e4482c32649e158c2cf7465c0f78ee
+  data.tar.gz: 17051e90d09f6fdcba77eece0baae5a7e62867a3d208552001e2a40641b459e43e521becd62cd766c26df19e2cc10c20f365e85c46c35df1a1233c114d782a2f

data/.rubocop.yml

@@ -1,49 +1,74 @@
 AllCops:
   TargetRubyVersion: 3.3
+  NewCops: enable
   SuggestExtensions: false
   Exclude:
     - 'vendor/**/*'
     - 'bin/**/*'
+    - 'examples/**/*'
 
 require:
   - rubocop-rake
   - rubocop-rspec
 
+# Disable problematic cops that cause errors
+Capybara/RSpec/PredicateMatcher:
+  Enabled: false
+
+# Layout rules
 Layout/LineLength:
   Max: 120
   Exclude:
     - 'gasfree_sdk.gemspec'
     - 'examples/**/*'
 
+# Metrics rules
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
     - 'examples/**/*'
 
 Metrics/MethodLength:
-  Max: 15
+  Max: 17
   Exclude:
     - 'spec/**/*'
 
+Metrics/ClassLength:
+  Max: 200
+
 Metrics/CyclomaticComplexity:
   Max: 10
   Exclude:
     - 'spec/**/*'
 
+# Documentation rules
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'examples/**/*'
     - 'lib/gasfree_sdk/errors.rb'
 
+# RSpec rules
 RSpec/ExampleLength:
-  Max: 30
+  Max: 50
 
 RSpec/MultipleExpectations:
-  Max: 5
+  Max: 15
 
+# String literal rules
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+# Disable some overly strict cops for this project
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# Gemspec rules - be more lenient for development gems
+Gemspec/RequireMFA:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,60 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2025-05-26
+All notable changes to this project will be documented in this file.
 
-- Initial release
+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).
+
+## [1.0.0] - 2025-06-08
+
+### Added
+- **TronEIP712Signer Module**: Complete EIP-712 signature implementation for TRON GasFree transfers
+  - Full EIP-712 structured data signing according to TIP-712 specifications
+  - Support for both TRON Mainnet and Testnet (Nile) networks
+  - Built-in Keccak256 cryptographic hashing implementation
+  - Base58 encoding/decoding utilities for TRON addresses
+  - Flexible data key handling (camelCase, snake_case conversion)
+  - Pre-configured domain constants for GasFree contracts
+  - Comprehensive test coverage with RSpec
+
+- **Core GasFree SDK functionality**
+  - API client for GasFree.io with support for different endpoints (mainnet, testnet, custom)
+  - Support for tokens, providers, and transfer operations
+  - Comprehensive error handling and validation
+  - Ethereum and TRON address support
+  - RSpec test suite with comprehensive coverage
+  - Dry-rb validation and type checking
+
+### Features
+- `GasfreeSdk::TronEIP712Signer.sign_typed_data_testnet()` - Sign for TRON Testnet
+- `GasfreeSdk::TronEIP712Signer.sign_typed_data_mainnet()` - Sign for TRON Mainnet  
+- `GasfreeSdk::TronEIP712Signer.sign_typed_data()` - Generic signing with custom domains
+- `GasfreeSdk::Crypto::Keccak256` - Pure Ruby Keccak256 implementation
+- `GasfreeSdk::Base58` - TRON address encoding/decoding utilities
+- Token, Provider, and Transfer management APIs
+- Service Providers API with proper data mapping from camelCase to snake_case
+- Improved URL path handling for API requests
+
+### Dependencies
+- Added `rbsecp256k1` (~> 6.0) for secp256k1 cryptographic operations
+
+### Examples
+- `examples/simple_usage_example.rb` - Basic TronEIP712Signer usage demonstration
+- `examples/test_tron_signer.rb` - Comprehensive module testing script
+- Updated `examples/test_with_real_data_prod.rb` to use the new module
+
+### Documentation
+- Updated README.md with comprehensive TronEIP712Signer documentation
+- Added usage examples and API reference
+- Documented all cryptographic operations and utilities
+- Improved documentation for Service Providers with detailed configuration constraints
+
+### Fixed
+- Fixed Service Providers API data mapping from camelCase to snake_case
+- Added proper transformation for provider configuration fields (maxPendingTransfer -> max_pending_transfer, etc.)
+- Updated tests to use correct API response format for providers
+
+### Enhanced
+- Comprehensive test coverage for provider field mapping
+- RSpec testing framework integration
+- Improved error handling and validation throughout the SDK

data/LICENSE.txt

@@ -1,21 +1,119 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 madmatvey
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+GNU LESSER GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2025 Eugene Leontev (madmatvey)
+Project: gasfree_sdk (https://github.com/madmatvey/gasfree_sdk)
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public License,
+supplemented by the additional permissions listed below.
+
+0. Additional Definitions.
+
+As used herein, "this License" refers to version 3 of the GNU Lesser General Public License,
+and the "GNU GPL" refers to version 3 of the GNU General Public License.
+
+"The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided by the Library,
+but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an Application with the Library.
+The particular version of the Library with which the Combined Work was made is also called the "Linked Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work,
+excluding any source code for portions of the Combined Work that are based on the Application,
+and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application,
+including any data and utility programs needed for reproducing the Combined Work from the Application,
+but excluding the System Libraries of the Combined Work.
+
+1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
+
+2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked),
+then you may convey a copy of the modified version:
+
+a) under this License, provided that you make a good faith effort to ensure that,
+in the event an Application does not supply the function or data,
+the facility still operates, and performs whatever part of its purpose remains meaningful, or
+
+b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
+
+3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a header file that is part of the Library.
+You may convey such object code under terms of your choice, provided that,
+if the incorporated material is not limited to numerical parameters, data structure layouts and accessors,
+or small macros, inline functions and templates (ten or fewer lines in length),
+you do both of the following:
+
+a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
+
+b) Accompany the object code with a copy of the GNU GPL and this license document.
+
+4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken together,
+effectively do not restrict modification of the portions of the Library contained in the Combined Work
+and reverse engineering for debugging such modifications,
+if you also do each of the following:
+
+a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
+
+b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
+
+c) For a Combined Work that displays copyright notices during execution,
+include the copyright notice for the Library among these notices,
+as well as a reference directing the user to the copies of the GNU GPL and this license document.
+
+d) Do one of the following:
+
+   0) Convey the Minimal Corresponding Source under the terms of this License,
+   and the Corresponding Application Code in a form suitable for,
+   and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work,
+   in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
+
+   1) Use a suitable shared library mechanism for linking with the Library.
+   A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system,
+   and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
+
+e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL,
+and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version.
+(If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code.
+If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
+
+5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities not covered by this License,
+and distribute such a combined library,
+provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted,
+and provided that you do these two things:
+
+a) Accompany the combined library with a copy of the same work based on the Library,
+uncombined with any other library facilities, conveyed under the terms of this License.
+
+b) Give prominent notice with the combined library that part of it is a work based on the Library,
+and explaining where to find the accompanying uncombined form of the same work.
+
+6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number.
+If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it,
+you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation.
+If the Library as you received it does not specify a version number of the GNU Lesser General Public License,
+you may choose any version ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply,
+that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

data/README.md

@@ -1,18 +1,19 @@
-# GasfreeSdk
+# GasFree SDK
 
-Ruby SDK for interacting with the GasFree.io API, enabling gasless transfers of TRC-20/ERC-20 tokens.
+Ruby SDK for GasFree.io - TRC-20 gasless transfer solution.
 
-## Features
+## 💬 Support & Consulting
 
-- Supports gasless transfers of TRC-20/ERC-20 tokens
-- Handles address generation and transaction signing
-- Provides a clean, Ruby-like interface to the GasFree API
-- Built with dry-rb for robust type checking and validation
-- Comprehensive RSpec test coverage
-- Thread-safe configuration
+If you encounter any issues, feel free to open a discussion or report a bug via the [GitHub Issues](https://github.com/madmatvey/gasfree_sdk/issues) page.
+
+You can also [hire me as an external consultant](https://madmatvey.github.io/about/#cv) if you need help integrating or customizing the gem for your project.
+
+If you find this gem useful and want to support further development, you're welcome to [donate here](https://madmatvey.github.io/about/#donate-me).
 
 ## Installation
 
+This gem is published on [RubyGems.org](https://rubygems.org/gems/gasfree_sdk).
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -21,30 +22,25 @@ gem 'gasfree_sdk'
 
 And then execute:
 
-```bash
-bundle install
-```
+    $ bundle install
 
 Or install it yourself as:
 
-```bash
-gem install gasfree_sdk
-```
+    $ gem install gasfree_sdk
 
 ## Configuration
 
-Configure the SDK with your API credentials:
-
 ```ruby
+require 'gasfree_sdk'
+
 GasfreeSdk.configure do |config|
   config.api_key = "your-api-key"
   config.api_secret = "your-api-secret"
-  config.api_endpoint = "https://open.gasfree.io/tron/" # Optional, defaults to mainnet
-  config.default_chain_id = 1 # Optional, defaults to Ethereum mainnet
+  config.api_endpoint = "https://open.gasfree.io/tron/"  # TRON endpoint
 end
 ```
 
-## Usage
+## Basic Usage
 
 ### Initialize Client
 
@@ -57,10 +53,9 @@ client = GasfreeSdk.client
 ```ruby
 tokens = client.tokens
 tokens.each do |token|
-  puts "Token: #{token.symbol}"
-  puts "Address: #{token.token_address}"
-  puts "Activation Fee: #{token.activate_fee}"
-  puts "Transfer Fee: #{token.transfer_fee}"
+  puts "#{token.symbol} (#{token.token_address})"
+  puts "  Activation Fee: #{token.activate_fee}"
+  puts "  Transfer Fee: #{token.transfer_fee}"
 end
 ```
 
@@ -69,76 +64,236 @@ end
 ```ruby
 providers = client.providers
 providers.each do |provider|
-  puts "Provider: #{provider.name}"
-  puts "Address: #{provider.address}"
-  puts "Max Pending Transfers: #{provider.config.max_pending_transfer}"
+  puts "#{provider.name} (#{provider.address})"
+  puts "  Max Pending Transfers: #{provider.config.max_pending_transfer}"
+  puts "  Default Deadline: #{provider.config.default_deadline_duration}s"
 end
 ```
 
-### Get GasFree Account Info
+### Check Account Information
 
 ```ruby
-account = client.address("0x1234...")
+account = client.address("TYourTronAddress")
 puts "GasFree Address: #{account.gas_free_address}"
 puts "Active: #{account.active}"
 puts "Nonce: #{account.nonce}"
 
 account.assets.each do |asset|
-  puts "Token: #{asset.token_symbol}"
-  puts "Frozen Amount: #{asset.frozen}"
+  puts "#{asset.token_symbol}: #{asset.frozen} frozen"
 end
 ```
 
-### Submit GasFree Transfer
+## TRON EIP-712 Signature Module
+
+The SDK includes a comprehensive EIP-712 signature implementation specifically designed for TRON GasFree transfers. This module handles the complex cryptographic operations required for signing structured data according to the EIP-712 standard as implemented by TRON (TIP-712).
+
+### Features
+
+- **Complete EIP-712 Implementation**: Full support for EIP-712 structured data signing
+- **TRON-Specific Adaptations**: Handles TRON address encoding and TIP-712 specifications
+- **Dual Network Support**: Separate configurations for TRON Mainnet and Testnet (Nile)
+- **Flexible Key Handling**: Support for multiple data key formats (camelCase, snake_case)
+- **Built-in Cryptography**: Includes Keccak256 hashing and Base58 encoding for TRON addresses
+
+### Basic Signature Usage
 
 ```ruby
-request = GasfreeSdk::Models::TransferRequest.new(
-  token: "0x1234...", # Token address
-  service_provider: "0x5678...", # Provider address
-  user: "0x9abc...", # User's EOA address
-  receiver: "0xdef0...", # Recipient address
-  value: "1000000", # Amount in smallest unit
-  max_fee: "100000", # Maximum fee in smallest unit
-  deadline: Time.now.to_i + 180, # 3 minutes from now
+# Example message data
+message_data = {
+  token: "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t", # USDT TRC-20
+  serviceProvider: "TGzz8gjYiYRqpfmDwnLxfgPuLVNmpCswVp",
+  user: "TYRhsi1fkke2tjdVW9XGYLjf8TgbbutEgY",
+  receiver: "TW1dWXfta5ygVN298JBN2UPhaSAUzo2owZ",
+  value: "3000000", # 3 USDT (6 decimals)
+  maxFee: "2000000", # 2 USDT max fee
+  deadline: (Time.now.to_i + 300).to_s, # 5 minutes from now
   version: 1,
-  nonce: 0,
-  sig: "0x..." # User's signature
+  nonce: 0
+}
+
+private_key = "your_private_key_hex"
+
+# Sign for TRON Testnet (Nile)
+testnet_signature = GasfreeSdk::TronEIP712Signer.sign_typed_data_testnet(private_key, message_data)
+
+# Sign for TRON Mainnet
+mainnet_signature = GasfreeSdk::TronEIP712Signer.sign_typed_data_mainnet(private_key, message_data)
+
+# Generic signing with custom domain
+signature = GasfreeSdk::TronEIP712Signer.sign_typed_data(
+  private_key, 
+  message_data, 
+  domain: GasfreeSdk::TronEIP712Signer::DOMAIN_TESTNET
 )
+```
+
+### Advanced Usage
+
+#### Custom Domain Configuration
+
+```ruby
+custom_domain = {
+  name: "GasFreeController",
+  version: "V1.0.0",
+  chainId: 728_126_428,
+  verifyingContract: "THQGuFzL87ZqhxkgqYEryRAd7gqFqL5rdc"
+}
+
+signature = GasfreeSdk::TronEIP712Signer.sign_typed_data(
+  private_key,
+  message_data,
+  domain: custom_domain,
+  use_ethereum_v: true
+)
+```
+
+#### Individual Cryptographic Operations
+
+```ruby
+# Keccak256 hashing
+hash = GasfreeSdk::TronEIP712Signer.keccac256("data to hash")
+hex_hash = GasfreeSdk::TronEIP712Signer.keccac256_hex("data to hash")
+
+# EIP-712 type encoding
+encoded_type = GasfreeSdk::TronEIP712Signer.encode_type(:PermitTransfer)
 
+# Structured data hashing
+message_hash = GasfreeSdk::TronEIP712Signer.hash_struct(:PermitTransfer, message_data)
+domain_hash = GasfreeSdk::TronEIP712Signer.hash_domain
+```
+
+#### TRON Address Utilities
+
+```ruby
+# Base58 encoding/decoding for TRON addresses
+binary_data = GasfreeSdk::Base58.base58_to_binary("TYRhsi1fkke2tjdVW9XGYLjf8TgbbutEgY")
+base58_string = GasfreeSdk::Base58.binary_to_base58(binary_data)
+```
+
+### Domain Constants
+
+The module provides pre-configured domain constants for both networks:
+
+```ruby
+# TRON Testnet (Nile)
+GasfreeSdk::TronEIP712Signer::DOMAIN_TESTNET
+# => {
+#   name: "GasFreeController",
+#   version: "V1.0.0", 
+#   chainId: 728_126_428,
+#   verifyingContract: "THQGuFzL87ZqhxkgqYEryRAd7gqFqL5rdc"
+# }
+
+# TRON Mainnet
+GasfreeSdk::TronEIP712Signer::DOMAIN_MAINNET
+# => {
+#   name: "GasFreeController",
+#   version: "V1.0.0",
+#   chainId: 3_448_148_188,
+#   verifyingContract: "TFFAMQLZybALaLb4uxHA9RBE7pxhUAjF3U"
+# }
+```
+
+### Submit Transfer with Signature
+
+```ruby
+# Create and submit a transfer request
+token = client.tokens.first
+provider = client.providers.first
+
+message_data = {
+  token: token.token_address,
+  serviceProvider: provider.address,
+  user: "TYourTronAddress",
+  receiver: "TReceiverAddress",
+  value: "1000000", # 1 USDT
+  maxFee: "500000",  # 0.5 USDT max fee
+  deadline: (Time.now.to_i + provider.config.default_deadline_duration).to_s,
+  version: 1,
+  nonce: account.nonce
+}
+
+# Sign the message
+signature = GasfreeSdk::TronEIP712Signer.sign_typed_data_testnet(private_key, message_data)
+
+# Create transfer request
+request = GasfreeSdk::Models::TransferRequest.new(
+  token: message_data[:token],
+  service_provider: message_data[:serviceProvider],
+  user: message_data[:user],
+  receiver: message_data[:receiver],
+  value: message_data[:value],
+  max_fee: message_data[:maxFee],
+  deadline: message_data[:deadline].to_i,
+  version: message_data[:version],
+  nonce: message_data[:nonce],
+  sig: signature
+)
+
+# Submit the transfer
 response = client.submit_transfer(request)
 puts "Transfer ID: #{response.id}"
 puts "State: #{response.state}"
 ```
 
-### Check Transfer Status
+### Monitor Transfer Status
 
 ```ruby
-status = client.transfer_status("transfer-id")
-puts "State: #{status.state}"
-puts "Transaction Hash: #{status.txn_hash}" if status.txn_hash
+transfer_id = response.id
+
+loop do
+  status = client.transfer_status(transfer_id)
+  puts "State: #{status.state}"
+  puts "Transaction Hash: #{status.txn_hash}" if status.txn_hash
+  
+  break if %w[SUCCEED FAILED].include?(status.state)
+  sleep 2
+end
 ```
 
 ## Error Handling
 
-The SDK provides detailed error classes for different types of errors:
-
 ```ruby
 begin
-  client.submit_transfer(request)
-rescue GasfreeSdk::InsufficientBalanceError => e
-  puts "Insufficient balance: #{e.message}"
-rescue GasfreeSdk::DeadlineExceededError => e
-  puts "Deadline exceeded: #{e.message}"
+  response = client.submit_transfer(request)
 rescue GasfreeSdk::APIError => e
-  puts "API error (#{e.code}): #{e.message}"
+  puts "API Error (#{e.code}): #{e.message}"
+  
+  case e.message
+  when /insufficient balance/
+    puts "Solution: Get test tokens or transfer tokens to GasFree address"
+  when /max fee exceeded/
+    puts "Solution: Increase maxFee parameter"
+  when /Invalid signature/
+    puts "Solution: Check private key and address correspondence"
+  end
+rescue StandardError => e
+  puts "Error: #{e.message}"
 end
 ```
 
+## Examples
+
+See the `examples/` directory for complete working examples:
+
+- `examples/simple_usage_example.rb` - Basic TronEIP712Signer usage
+
+## Dependencies
+
+- `dry-configurable` - Configuration management
+- `dry-struct` - Data structures
+- `dry-types` - Type system
+- `dry-validation` - Data validation
+- `faraday` - HTTP client
+- `faraday-retry` - HTTP retry logic
+- `eth` - Ethereum utilities
+- `rbsecp256k1` - Cryptographic operations for EIP-712 signatures
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`.
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
@@ -146,4 +301,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/madmat
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [LGPL v3.0](https://www.gnu.org/licenses/lgpl-3.0.html) © 2025 Eugene Leontev (https://github.com/madmatvey)