coinbase-sdk 0.0.6 → 0.0.7

data/lib/coinbase/transaction.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative 'constants'
+require 'bigdecimal'
+require 'eth'
+require 'json'
+
+module Coinbase
+  # A representation of an onchain Transaction.
+  # Transactions should be constructed via higher level abstractions like Trade or Transfer.
+  class Transaction
+    # A representation of a Transaction status.
+    module Status
+      # The Transaction is awaiting being broadcast to the Network.
+      # At this point, transaction hashes may not yet be assigned.
+      PENDING = 'pending'
+
+      # The Transaction has been broadcast to the Network.
+      # At this point, at least the transaction hash should be assigned.
+      BROADCAST = 'broadcast'
+
+      # The Transaction is complete and has confirmed on the Network.
+      COMPLETE = 'complete'
+
+      # The Transaction has failed for some reason.
+      FAILED = 'failed'
+
+      # The states that are considered terminal on-chain.
+      TERMINAL_STATES = [COMPLETE, FAILED].freeze
+    end
+
+    # Returns a new Transaction object. Do not use this method directly.
+    # @param model [Coinbase::Client::Transaction] The underlying Transaction object
+    def initialize(model)
+      raise unless model.is_a?(Coinbase::Client::Transaction)
+
+      @model = model
+    end
+
+    # Returns the Unsigned Payload of the Transaction.
+    # @return [String] The Unsigned Payload
+    def unsigned_payload
+      @model.unsigned_payload
+    end
+
+    # Returns the Signed Payload of the Transaction.
+    # @return [String] The Signed Payload
+    def signed_payload
+      @model.signed_payload
+    end
+
+    # Returns the Transaction Hash of the Transaction.
+    # @return [String] The Transaction Hash
+    def transaction_hash
+      @model.transaction_hash
+    end
+
+    # Returns the status of the Transaction.
+    # @return [Symbol] The status
+    def status
+      @model.status
+    end
+
+    # Returns the from address for the Transaction.
+    # @return [String] The from address
+    def from_address_id
+      @model.from_address_id
+    end
+
+    # Returns whether the Transaction is in a terminal state.
+    # @return [Boolean] Whether the Transaction is in a terminal state
+    def terminal_state?
+      Status::TERMINAL_STATES.include?(status)
+    end
+
+    # Returns the link to the transaction on the blockchain explorer.
+    # @return [String] The link to the transaction on the blockchain explorer
+    def transaction_link
+      @model.transaction_link
+    end
+
+    # Returns the underlying raw transaction.
+    # @return [Eth::Tx::Eip1559] The raw transaction
+    def raw
+      return @raw unless @raw.nil?
+
+      raw_payload = [unsigned_payload].pack('H*')
+      parsed_payload = JSON.parse(raw_payload)
+
+      params = {
+        chain_id: parsed_payload['chainId'].to_i(16),
+        nonce: parsed_payload['nonce'].to_i(16),
+        priority_fee: parsed_payload['maxPriorityFeePerGas'].to_i(16),
+        max_gas_fee: parsed_payload['maxFeePerGas'].to_i(16),
+        gas_limit: parsed_payload['gas'].to_i(16), # TODO: Handle multiple currencies.
+        from: Eth::Address.new(from_address_id),
+        to: Eth::Address.new(parsed_payload['to']),
+        value: parsed_payload['value'].to_i(16),
+        data: parsed_payload['input'] || ''
+      }
+
+      @raw = Eth::Tx::Eip1559.new(Eth::Tx.validate_eip1559_params(params))
+    end
+
+    # Signs the Transaction with the provided key and returns the hex signing payload.
+    # @return [String] The hex-encoded signed payload
+    def sign(key)
+      raw.sign(key)
+
+      raw.hex
+    end
+
+    # Returns a String representation of the Transaction.
+    # @return [String] a String representation of the Transaction
+    def to_s
+      "Coinbase::Transaction{transaction_hash: '#{transaction_hash}', status: '#{status}'}"
+    end
+
+    # Same as to_s.
+    # @return [String] a String representation of the Transaction
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/coinbase/transfer.rb

@@ -11,27 +11,12 @@ module Coinbase
   # in the native Asset of the Network. Transfers should be created through Wallet#transfer or
   # Address#transfer.
   class Transfer
-    # A representation of a Transfer status.
-    module Status
-      # The Transfer is awaiting being broadcast to the Network. At this point, transaction
-      # hashes may not yet be assigned.
-      PENDING = :pending
-
-      # The Transfer has been broadcast to the Network. At this point, at least the transaction hash
-      # should be assigned.
-      BROADCAST = :broadcast
-
-      # The Transfer is complete, and has confirmed on the Network.
-      COMPLETE = :complete
-
-      # The Transfer has failed for some reason.
-      FAILED = :failed
-    end
-
     # Returns a new Transfer object. Do not use this method directly. Instead, use Wallet#transfer or
     # Address#transfer.
     # @param model [Coinbase::Client::Transfer] The underlying Transfer object
     def initialize(model)
+      raise unless model.is_a?(Coinbase::Client::Transfer)
+
       @model = model
     end
 
@@ -65,6 +50,10 @@ module Coinbase
       @model.destination
     end
 
+    def asset
+      @asset ||= Coinbase::Asset.from_model(@model.asset)
+    end
+
     # Returns the Asset ID of the Transfer.
     # @return [Symbol] The Asset ID
     def asset_id
@@ -74,12 +63,7 @@ module Coinbase
     # Returns the amount of the asset for the Transfer.
     # @return [BigDecimal] The amount of the asset
     def amount
-      case asset_id
-      when :eth
-        BigDecimal(@model.amount) / BigDecimal(Coinbase::WEI_PER_ETHER.to_s)
-      else
-        BigDecimal(@model.amount)
-      end
+      BigDecimal(@model.amount) / BigDecimal(10).power(@model.asset.decimals)
     end
 
     # Returns the link to the transaction on the blockchain explorer.
@@ -101,40 +85,22 @@ module Coinbase
       @model.signed_payload
     end
 
+    # Returns the Transfer transaction.
+    # @return [Coinbase::Transaction] The Transfer transaction
+    def transaction
+      @transaction ||= Coinbase::Transaction.new(@model.transaction)
+    end
+
     # Returns the Transaction Hash of the Transfer.
     # @return [String] The Transaction Hash
     def transaction_hash
       @model.transaction_hash
     end
 
-    # Returns the underlying Transfer transaction, creating it if it has not been yet.
-    # @return [Eth::Tx::Eip1559] The Transfer transaction
-    def transaction
-      return @transaction unless @transaction.nil?
-
-      raw_payload = [unsigned_payload].pack('H*')
-      parsed_payload = JSON.parse(raw_payload)
-
-      params = {
-        chain_id: parsed_payload['chainId'].to_i(16),
-        nonce: parsed_payload['nonce'].to_i(16),
-        priority_fee: parsed_payload['maxPriorityFeePerGas'].to_i(16),
-        max_gas_fee: parsed_payload['maxFeePerGas'].to_i(16),
-        gas_limit: parsed_payload['gas'].to_i(16), # TODO: Handle multiple currencies.
-        from: Eth::Address.new(from_address_id),
-        to: Eth::Address.new(parsed_payload['to']),
-        value: parsed_payload['value'].to_i(16),
-        data: parsed_payload['input'] || ''
-      }
-
-      @transaction = Eth::Tx::Eip1559.new(Eth::Tx.validate_eip1559_params(params))
-      @transaction
-    end
-
     # Returns the status of the Transfer.
     # @return [Symbol] The status
     def status
-      @model.status
+      transaction.status
     end
 
     # Reload reloads the Transfer model with the latest version from the server side.
@@ -144,6 +110,9 @@ module Coinbase
         transfers_api.get_transfer(wallet_id, from_address_id, id)
       end
 
+      # Update memoized transaction.
+      @transaction = Coinbase::Transaction.new(@model.transaction)
+
       self
     end
 
@@ -158,7 +127,7 @@ module Coinbase
       loop do
         reload
 
-        return self if terminal_state?
+        return self if transaction.terminal_state?
 
         raise Timeout::Error, 'Transfer timed out' if Time.now - start_time > timeout_seconds
 
@@ -173,8 +142,8 @@ module Coinbase
     def to_s
       "Coinbase::Transfer{transfer_id: '#{id}', network_id: '#{network_id}', " \
         "from_address_id: '#{from_address_id}', destination_address_id: '#{destination_address_id}', " \
-        "asset_id: '#{asset_id}', amount: '#{amount}', transaction_hash: '#{transaction_hash}', " \
-        "transaction_link: '#{transaction_link}', status: '#{status}'}"
+        "asset_id: '#{asset_id}', amount: '#{amount}', transaction_link: '#{transaction_link}', " \
+        "status: '#{status}'}"
     end
 
     # Same as to_s.
@@ -183,12 +152,10 @@ module Coinbase
       to_s
     end
 
+    private
+
     def transfers_api
       @transfers_api ||= Coinbase::Client::TransfersApi.new(Coinbase.configuration.api_client)
     end
-
-    def terminal_state?
-      status == Status::COMPLETE.to_s || status == Status::FAILED.to_s
-    end
   end
 end

data/lib/coinbase/wallet.rb

@@ -240,11 +240,22 @@ module Coinbase
     # @param asset_id [Symbol] The ID of the Asset to send
     # @param destination [Wallet | Address | String] The destination of the transfer. If a Wallet, sends to the Wallet's
     #  default address. If a String, interprets it as the address ID.
-    # @return [Transfer] The hash of the Transfer transaction.
+    # @return [Coinbase::Transfer] The Transfer object.
     def transfer(amount, asset_id, destination)
       default_address.transfer(amount, asset_id, destination)
     end
 
+    # Trades the given amount of the given Asset for another Asset.
+    # Currently only the default_address is used to source the Trade
+    # @param amount [Integer, Float, BigDecimal] The amount of the Asset to send.
+    # @param from_asset_id [Symbol] The ID of the Asset to trade from. For Ether, :eth, :gwei, and :wei are supported.
+    # @param to_asset_id [Symbol] The ID of the Asset to trade to. For Ether, :eth, :gwei, and :wei are supported.
+    #  default address. If a String, interprets it as the address ID.
+    # @return [Coinbase::Trade] The Trade object.
+    def trade(amount, from_asset_id, to_asset_id)
+      default_address.trade(amount, from_asset_id, to_asset_id)
+    end
+
     # Exports the Wallet's data to a Data object.
     # @return [Data] The Wallet data
     def export

data/lib/coinbase.rb

@@ -11,9 +11,12 @@ require_relative 'coinbase/errors'
 require_relative 'coinbase/faucet_transaction'
 require_relative 'coinbase/middleware'
 require_relative 'coinbase/network'
+require_relative 'coinbase/trade'
 require_relative 'coinbase/transfer'
+require_relative 'coinbase/transaction'
 require_relative 'coinbase/user'
 require_relative 'coinbase/wallet'
+require_relative 'coinbase/server_signer'
 require 'json'
 
 # The Coinbase SDK.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinbase-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Yuga Cohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-03 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -249,6 +249,7 @@ files:
 - lib/coinbase/client.rb
 - lib/coinbase/client/api/addresses_api.rb
 - lib/coinbase/client/api/server_signers_api.rb
+- lib/coinbase/client/api/stake_api.rb
 - lib/coinbase/client/api/trades_api.rb
 - lib/coinbase/client/api/transfers_api.rb
 - lib/coinbase/client/api/users_api.rb
@@ -263,6 +264,7 @@ files:
 - lib/coinbase/client/models/balance.rb
 - lib/coinbase/client/models/broadcast_trade_request.rb
 - lib/coinbase/client/models/broadcast_transfer_request.rb
+- lib/coinbase/client/models/build_staking_operation_request.rb
 - lib/coinbase/client/models/create_address_request.rb
 - lib/coinbase/client/models/create_server_signer_request.rb
 - lib/coinbase/client/models/create_trade_request.rb
@@ -271,14 +273,18 @@ files:
 - lib/coinbase/client/models/create_wallet_request_wallet.rb
 - lib/coinbase/client/models/error.rb
 - lib/coinbase/client/models/faucet_transaction.rb
+- lib/coinbase/client/models/feature.rb
+- lib/coinbase/client/models/request_faucet_funds200_response.rb
 - lib/coinbase/client/models/seed_creation_event.rb
 - lib/coinbase/client/models/seed_creation_event_result.rb
 - lib/coinbase/client/models/server_signer.rb
 - lib/coinbase/client/models/server_signer_event.rb
 - lib/coinbase/client/models/server_signer_event_event.rb
 - lib/coinbase/client/models/server_signer_event_list.rb
+- lib/coinbase/client/models/server_signer_list.rb
 - lib/coinbase/client/models/signature_creation_event.rb
 - lib/coinbase/client/models/signature_creation_event_result.rb
+- lib/coinbase/client/models/staking_operation.rb
 - lib/coinbase/client/models/trade.rb
 - lib/coinbase/client/models/trade_list.rb
 - lib/coinbase/client/models/transaction.rb
@@ -294,6 +300,9 @@ files:
 - lib/coinbase/faucet_transaction.rb
 - lib/coinbase/middleware.rb
 - lib/coinbase/network.rb
+- lib/coinbase/server_signer.rb
+- lib/coinbase/trade.rb
+- lib/coinbase/transaction.rb
 - lib/coinbase/transfer.rb
 - lib/coinbase/user.rb
 - lib/coinbase/wallet.rb