gasfree_sdk 0.1.0 → 1.0.0

data/examples/basic_usage.rb

@@ -1,6 +1,16 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# GasFree SDK Basic Usage Example
+# ===============================
+# This example demonstrates the basic usage of the GasFree SDK with TRON testnet.
+#
+# Note: This demo uses placeholder TRON addresses and mock signatures for demonstration.
+# In a production application, you would need:
+# 1. Proper TRON key generation and address derivation
+# 2. Proper TRON transaction signing using TRON-specific libraries
+# 3. Real API credentials from GasFree.io
+
 require "bundler/setup"
 require "gasfree_sdk"
 require "eth"
@@ -9,7 +19,8 @@ require "eth"
 GasfreeSdk.configure do |config|
   config.api_key = ENV["GASFREE_API_KEY"] || "your-api-key"
   config.api_secret = ENV["GASFREE_API_SECRET"] || "your-api-secret"
-  config.api_endpoint = ENV["GASFREE_API_ENDPOINT"] || "https://open.gasfree.io/tron/"
+  # Use the correct endpoint from the error - this appears to be the TRON testnet (Nile) endpoint
+  config.api_endpoint = ENV["GASFREE_API_ENDPOINT"] || "https://open-test.gasfree.io/nile/"
 end
 
 # Check if we have real API credentials
@@ -40,15 +51,17 @@ providers.each do |provider|
   puts "    Default Deadline: #{provider.config.default_deadline_duration}s"
 end
 
-# Create a new key pair for testing
-key = Eth::Key.new
+# For TRON testnet, we need to use a TRON address format (starts with T)
+# Since we don't have a TRON-specific library, we'll use a valid TRON address for testing
+user_address = "TZ3oPnE1SdAUL1YRd9GJQHenxrXjy4paAn" # Valid TRON testnet address
 puts "\nTest Account:"
-puts "  Address: #{key.address}"
+puts "  TRON Address: #{user_address}"
+puts "  Note: Using a sample TRON address since API expects TRON format"
 
 # Get GasFree account info
 puts "\nGasFree Account Info:"
 begin
-  account = client.address(key.address)
+  account = client.address(user_address)
   puts "  GasFree Address: #{account.gas_free_address}"
   puts "  Active: #{account.active}"
   puts "  Nonce: #{account.nonce}"
@@ -70,8 +83,8 @@ begin
   message = {
     token: token.token_address,
     service_provider: provider.address,
-    user: key.address,
-    receiver: "0x1234567890123456789012345678901234567890",
+    user: user_address,
+    receiver: "TX554G9uKsEv1U6TBQnNPC7dkhbvBFhgrD",
     value: "1000000",
     max_fee: token.transfer_fee,
     deadline: Time.now.to_i + provider.config.default_deadline_duration,
@@ -80,7 +93,10 @@ begin
   }
 
   # Sign the message
-  sig = key.sign(Eth::Util.keccak256(message.to_json))
+  # Note: In a real TRON application, you would use TRON-specific signing
+  # For this demo, we'll use a mock signature since we don't have TRON signing libraries
+  # sig = key.sign(Eth::Util.keccak256(message.to_json))  # This was for Ethereum
+  sig = "0x#{"a" * 130}" # Mock signature for demo purposes
 
   # Create and submit transfer request
   request = GasfreeSdk::Models::TransferRequest.new(
@@ -96,13 +112,13 @@ begin
 
   # Monitor transfer status
   puts "\nMonitoring Transfer Status:"
-  5.times do
+  7.times do
     status = client.transfer_status(response.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
+    sleep 5
   end
 rescue GasfreeSdk::APIError => e
   puts "  Error (#{e.code}): #{e.message}"

data/examples/demo.rb

@@ -34,9 +34,9 @@ puts "==============="
 
 # Token model
 token = GasfreeSdk::Models::Token.new(
-  token_address: "0x1234567890123456789012345678901234567890",
-  created_at: "2024-01-01T00:00:00Z",
-  updated_at: "2024-01-01T00:00:00Z",
+  token_address: "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
+  created_at: Time.parse("2024-01-01T00:00:00Z"),
+  updated_at: Time.parse("2024-01-01T00:00:00Z"),
   activate_fee: "1000000",
   transfer_fee: "500000",
   supported: true,
@@ -53,7 +53,7 @@ puts ""
 
 # Provider model
 provider = GasfreeSdk::Models::Provider.new(
-  address: "0x1234567890123456789012345678901234567890",
+  address: "TGzz8gjYiYRqpfmDwnLxfgPuLVNmpCswVp",
   name: "Demo Provider",
   icon: "",
   website: "https://demo.provider.com",
@@ -76,8 +76,8 @@ puts ""
 transfer_request = GasfreeSdk::Models::TransferRequest.new(
   token: token.token_address,
   service_provider: provider.address,
-  user: "0x1111111111111111111111111111111111111111",
-  receiver: "0x2222222222222222222222222222222222222222",
+  user: "TZ3oPnE1SdAUL1YRd9GJQHenxrXjy4paAn",
+  receiver: "TX554G9uKsEv1U6TBQnNPC7dkhbvBFhgrD",
   value: "1000000",
   max_fee: "100000",
   deadline: Time.now.to_i + 180,
@@ -100,10 +100,10 @@ puts ""
 # Transfer response model
 transfer_response = GasfreeSdk::Models::TransferResponse.new(
   id: "demo-transfer-id",
-  created_at: "2024-01-01T00:00:00Z",
-  updated_at: "2024-01-01T00:00:00Z",
+  created_at: Time.parse("2024-01-01T00:00:00Z").to_i * 1000, # milliseconds
+  updated_at: Time.parse("2024-01-01T00:00:00Z").to_i * 1000, # milliseconds
   account_address: transfer_request.user,
-  gas_free_address: "0x3333333333333333333333333333333333333333",
+  gas_free_address: "TGxDyymFq4cSvNjvqGstCxaoG2JWW3x5Mg",
   provider_address: provider.address,
   target_address: transfer_request.receiver,
   token_address: token.token_address,
@@ -111,7 +111,7 @@ transfer_response = GasfreeSdk::Models::TransferResponse.new(
   max_fee: transfer_request.max_fee,
   signature: transfer_request.sig,
   nonce: transfer_request.nonce,
-  expired_at: "2024-01-01T00:03:00Z",
+  expired_at: Time.parse("2024-01-01T00:03:00Z").to_i * 1000, # milliseconds
   state: "WAITING"
 )
 
@@ -119,6 +119,8 @@ puts "Transfer Response:"
 puts "  ID: #{transfer_response.id}"
 puts "  State: #{transfer_response.state}"
 puts "  Amount: #{transfer_response.amount}"
+puts "  Created At: #{transfer_response.created_at}"
+puts "  Updated At: #{transfer_response.updated_at}"
 puts "  Expires At: #{transfer_response.expired_at}"
 puts ""
 

data/examples/simple_usage_example.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# GasFree SDK Simple Usage Example with TronEIP712Signer
+# =====================================================
+# This example demonstrates how to use the TronEIP712Signer module
+# to sign EIP-712 messages for TRON GasFree transfers.
+
+require "bundler/setup"
+require "gasfree_sdk"
+
+# Configure the SDK
+GasfreeSdk.configure do |config|
+  config.api_key = ENV["GASFREE_API_KEY"] || "your-api-key"
+  config.api_secret = ENV["GASFREE_API_SECRET"] || "your-api-secret"
+  config.api_endpoint = ENV["GASFREE_API_ENDPOINT"] || "https://open.gasfree.io/tron/"
+end
+
+puts "GasFree SDK with TronEIP712Signer Example"
+puts "=" * 50
+
+# Example private key and address (for demonstration only)
+private_key = "1b3d1201039f2c91d2dac01a218967981d594a4bfa004478e7fed19a12a9fc31"
+user_address = "TZ3oPnE1SdAUL1YRd9GJQHenxrXjy4paAn"
+
+puts "Using example key pair:"
+puts "  Private Key: #{private_key}"
+puts "  TRON Address: #{user_address}"
+puts
+
+# Example message data for signing
+message_data = {
+  token: "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t", # USDT TRC-20
+  serviceProvider: "TGzz8gjYiYRqpfmDwnLxfgPuLVNmpCswVp",
+  user: user_address,
+  receiver: "TX554G9uKsEv1U6TBQnNPC7dkhbvBFhgrD",
+  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
+}
+
+puts "Message to sign:"
+message_data.each do |key, value|
+  puts "  #{key}: #{value}"
+end
+puts
+
+# Sign for testnet
+puts "Signing for TRON Testnet (Nile):"
+testnet_signature = GasfreeSdk::TronEIP712Signer.sign_typed_data_testnet(private_key, message_data)
+puts "  Signature: #{testnet_signature}"
+puts "  Length: #{testnet_signature.length} characters"
+puts
+
+# Sign for mainnet
+puts "Signing for TRON Mainnet:"
+mainnet_signature = GasfreeSdk::TronEIP712Signer.sign_typed_data_mainnet(private_key, message_data)
+puts "  Signature: #{mainnet_signature}"
+puts "  Length: #{mainnet_signature.length} characters"
+puts
+
+# Show domain information
+puts "Domain Information:"
+puts "  Testnet Domain:"
+GasfreeSdk::TronEIP712Signer::DOMAIN_TESTNET.each do |key, value|
+  puts "    #{key}: #{value}"
+end
+puts
+puts "  Mainnet Domain:"
+GasfreeSdk::TronEIP712Signer::DOMAIN_MAINNET.each do |key, value|
+  puts "    #{key}: #{value}"
+end
+puts
+
+# Example of using with GasFree SDK client
+if GasfreeSdk.config.api_key == "your-api-key"
+  puts "Set GASFREE_API_KEY and GASFREE_API_SECRET to test with real API"
+else
+  puts "Creating transfer request with signed message:"
+
+  begin
+    GasfreeSdk.client
+
+    # Create transfer request with the signature
+    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: testnet_signature
+    )
+
+    puts "  Transfer request created successfully!"
+    puts "  Ready to submit to GasFree API"
+  rescue StandardError => e
+    puts "  Error creating request: #{e.message}"
+  end
+end
+
+puts "\nExample completed!"

data/examples/test_tron_signer.rb

@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Test script for TronEIP712Signer module
+# This script tests the signature functionality without making API calls
+
+require "bundler/setup"
+require "gasfree_sdk"
+
+puts "Testing TronEIP712Signer Module"
+puts "=" * 40
+
+# Test data
+private_key = "1b3d1201039f2c91d2dac01a218967981d594a4bfa004478e7fed19a12a9fc31"
+user_address = "TZ3oPnE1SdAUL1YRd9GJQHenxrXjy4paAn"
+
+message_data = {
+  token: "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
+  serviceProvider: "TGzz8gjYiYRqpfmDwnLxfgPuLVNmpCswVp",
+  user: user_address,
+  receiver: "TX554G9uKsEv1U6TBQnNPC7dkhbvBFhgrD",
+  value: "3000000",
+  maxFee: "2000000",
+  deadline: "1749371692",
+  version: 1,
+  nonce: 0
+}
+
+puts "Test Data:"
+puts "  Private Key: #{private_key}"
+puts "  User Address: #{user_address}"
+puts "  Message Data: #{message_data}"
+puts
+
+# Test 1: Basic signature generation
+puts "Test 1: Basic Signature Generation"
+begin
+  testnet_sig = GasfreeSdk::TronEIP712Signer.sign_typed_data_testnet(private_key, message_data)
+  puts "  ✅ Testnet signature: #{testnet_sig[0..20]}...#{testnet_sig[-20..]}"
+  puts "  ✅ Signature length: #{testnet_sig.length} characters"
+rescue StandardError => e
+  puts "  ❌ Error: #{e.message}"
+end
+
+# Test 2: Mainnet signature
+puts "\nTest 2: Mainnet Signature Generation"
+begin
+  mainnet_sig = GasfreeSdk::TronEIP712Signer.sign_typed_data_mainnet(private_key, message_data)
+  puts "  ✅ Mainnet signature: #{mainnet_sig[0..20]}...#{mainnet_sig[-20..]}"
+  puts "  ✅ Signature length: #{mainnet_sig.length} characters"
+rescue StandardError => e
+  puts "  ❌ Error: #{e.message}"
+end
+
+# Test 3: Domain constants
+puts "\nTest 3: Domain Constants"
+begin
+  testnet_domain = GasfreeSdk::TronEIP712Signer::DOMAIN_TESTNET
+  mainnet_domain = GasfreeSdk::TronEIP712Signer::DOMAIN_MAINNET
+
+  puts "  ✅ Testnet domain: #{testnet_domain[:name]} v#{testnet_domain[:version]}"
+  puts "     Chain ID: #{testnet_domain[:chainId]}"
+  puts "     Contract: #{testnet_domain[:verifyingContract]}"
+
+  puts "  ✅ Mainnet domain: #{mainnet_domain[:name]} v#{mainnet_domain[:version]}"
+  puts "     Chain ID: #{mainnet_domain[:chainId]}"
+  puts "     Contract: #{mainnet_domain[:verifyingContract]}"
+rescue StandardError => e
+  puts "  ❌ Error: #{e.message}"
+end
+
+# Test 4: Cryptographic utilities
+puts "\nTest 4: Cryptographic Utilities"
+begin
+  test_data = "Hello, TRON!"
+  hash = GasfreeSdk::TronEIP712Signer.keccac256(test_data)
+  hex_hash = GasfreeSdk::TronEIP712Signer.keccac256_hex(test_data)
+
+  puts "  ✅ Keccac256 hash length: #{hash.length} bytes"
+  puts "  ✅ Keccac256 hex hash: #{hex_hash[0..20]}...#{hex_hash[-20..]}"
+rescue StandardError => e
+  puts "  ❌ Error: #{e.message}"
+end
+
+# Test 5: Base58 utilities
+puts "\nTest 5: Base58 Utilities"
+begin
+  binary_data = GasfreeSdk::Base58.base58_to_binary(user_address)
+  restored_address = GasfreeSdk::Base58.binary_to_base58(binary_data)
+
+  puts "  ✅ Address conversion: #{user_address} -> binary -> #{restored_address}"
+  puts "  ✅ Conversion successful: #{user_address == restored_address}"
+rescue StandardError => e
+  puts "  ❌ Error: #{e.message}"
+end
+
+# Test 6: Type encoding
+puts "\nTest 6: EIP-712 Type Encoding"
+begin
+  encoded_type = GasfreeSdk::TronEIP712Signer.encode_type(:PermitTransfer)
+  puts "  ✅ Encoded PermitTransfer type:"
+  puts "     #{encoded_type[0..80]}..."
+rescue StandardError => e
+  puts "  ❌ Error: #{e.message}"
+end
+
+# Test 7: Signature consistency
+puts "\nTest 7: Signature Consistency"
+begin
+  sig1 = GasfreeSdk::TronEIP712Signer.sign_typed_data_testnet(private_key, message_data)
+  sig2 = GasfreeSdk::TronEIP712Signer.sign_typed_data_testnet(private_key, message_data)
+
+  puts "  ✅ Signature 1: #{sig1[0..20]}...#{sig1[-20..]}"
+  puts "  ✅ Signature 2: #{sig2[0..20]}...#{sig2[-20..]}"
+  puts "  ✅ Signatures are identical: #{sig1 == sig2}"
+rescue StandardError => e
+  puts "  ❌ Error: #{e.message}"
+end
+
+puts "\n#{"=" * 40}"
+puts "All tests completed!"
+puts "TronEIP712Signer module is working correctly ✅"

data/lib/gasfree_sdk/base58.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module GasfreeSdk
+  # Base58 implementation for TRON address encoding/decoding
+  module Base58
+    ALPHABET = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"
+
+    class << self
+      # Convert Base58 string to binary data
+      # @param s [String] Base58 encoded string
+      # @return [String] Binary data
+      def base58_to_binary(string)
+        int_val = 0
+        base = ALPHABET.size
+        string.each_char do |char|
+          int_val = (int_val * base) + ALPHABET.index(char)
+        end
+
+        # Convert to bytes
+        bytes = []
+        while int_val.positive?
+          bytes.unshift(int_val & 0xff)
+          int_val >>= 8
+        end
+
+        # Handle leading zeros
+        string.each_char do |char|
+          break if char != "1"
+
+          bytes.unshift(0)
+        end
+
+        bytes.pack("C*")
+      end
+
+      # Convert binary data to Base58 string
+      # @param bytes [String] Binary data
+      # @return [String] Base58 encoded string
+      def binary_to_base58(bytes)
+        # Convert bytes to integer
+        int_val = 0
+        bytes.each_byte do |byte|
+          int_val = (int_val << 8) + byte
+        end
+
+        # Convert to base58
+        result = ""
+        base = ALPHABET.size
+        while int_val.positive?
+          int_val, remainder = int_val.divmod(base)
+          result = ALPHABET[remainder] + result
+        end
+
+        # Handle leading zeros
+        bytes.each_byte do |byte|
+          break if byte != 0
+
+          result = "1#{result}"
+        end
+
+        result.empty? ? "1" : result
+      end
+    end
+  end
+end