coinbase-sdk 0.0.14 → 0.1.0

data/lib/coinbase/transaction.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'constants'
-require 'bigdecimal'
 require 'eth'
 require 'json'
 
@@ -70,6 +68,12 @@ module Coinbase
       @model.from_address_id
     end
 
+    # Returns the to address for the Transaction.
+    # @return [String] The to address
+    def to_address_id
+      @model.to_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?
@@ -113,12 +117,18 @@ module Coinbase
       @raw = Eth::Tx::Eip1559.new(Eth::Tx.validate_eip1559_params(params))
     end
 
+    # Returns the signature of the Transaction.
+    # @return [String] The hex-encode signature
+    def signature
+      raw.hex
+    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
+      signature
     end
 
     # Returns whether the Transaction has been signed.

data/lib/coinbase/transfer.rb

@@ -3,7 +3,6 @@
 require_relative 'constants'
 require 'bigdecimal'
 require 'eth'
-require 'json'
 
 module Coinbase
   # A representation of a Transfer, which moves an amount of an Asset from
@@ -21,12 +20,13 @@ module Coinbase
       #   If the destination is a Wallet, it uses the default Address of the Wallet.
       #   If the destination is an Address, it uses the Address's ID.
       #   If the destination is a String, it uses it as the Address ID.
-      # @param network_id [Symbol] The Network ID of the Asset
+      # @param network [Coinbase::Network, Symbol] The Network or Network ID of the Asset
       # @param wallet_id [String] The Wallet ID of the sending Wallet
       # @return [Transfer] The new pending Transfer object
       # @raise [Coinbase::ApiError] If the Transfer fails
-      def create(address_id:, amount:, asset_id:, destination:, network_id:, wallet_id:)
-        asset = Asset.fetch(network_id, asset_id)
+      def create(address_id:, amount:, asset_id:, destination:, network:, wallet_id:, gasless: false)
+        network = Coinbase::Network.from_id(network)
+        asset = network.get_asset(asset_id)
 
         model = Coinbase.call_api do
           transfers_api.create_transfer(
@@ -35,8 +35,9 @@ module Coinbase
             {
               amount: asset.to_atomic_amount(amount).to_i.to_s,
               asset_id: asset.primary_denomination.to_s,
-              destination: Coinbase::Destination.new(destination, network_id: network_id).address_id,
-              network_id: Coinbase.normalize_network(network_id)
+              destination: Coinbase::Destination.new(destination, network: network).address_id,
+              network_id: network.normalized_id,
+              gasless: gasless
             }
           )
         end
@@ -82,10 +83,10 @@ module Coinbase
       @model.transfer_id
     end
 
-    # Returns the Network ID of the Transfer.
-    # @return [Symbol] The Network ID
-    def network_id
-      Coinbase.to_sym(@model.network_id)
+    # Returns the Network of the Transfer.
+    # @return [Symbol] The Network
+    def network
+      @network ||= Coinbase::Network.from_id(@model.network_id)
     end
 
     # Returns the Wallet ID of the Transfer.
@@ -122,40 +123,52 @@ module Coinbase
       BigDecimal(@model.amount) / BigDecimal(10).power(@model.asset.decimals)
     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
-      transaction.transaction_link
-    end
+    # Signs the Transfer with the given key. This is required before broadcasting the Transfer.
+    # @param key [Eth::Key] The key to sign the Transfer with
+    # @raise [RuntimeError] If the key is not an Eth::Key
+    # @return [Transfer] The Transfer object
+    def sign(key)
+      raise unless key.is_a?(Eth::Key)
 
-    # Returns the Unsigned Payload of the Transfer.
-    # @return [String] The Unsigned Payload
-    def unsigned_payload
-      transaction.unsigned_payload
-    end
+      unless sponsored_send.nil?
+        sponsored_send.sign(key)
+
+        return
+      end
 
-    # Returns the Signed Payload of the Transfer.
-    # @return [String] The Signed Payload
-    def signed_payload
-      transaction.signed_payload
+      transaction.sign(key)
+
+      self
     end
 
     # Returns the Transfer transaction.
     # @return [Coinbase::Transaction] The Transfer transaction
     def transaction
-      @transaction ||= Coinbase::Transaction.new(@model.transaction)
+      @transaction ||= @model.transaction.nil? ? nil : Coinbase::Transaction.new(@model.transaction)
     end
 
-    # Returns the Transaction Hash of the Transfer.
-    # @return [String] The Transaction Hash
-    def transaction_hash
-      transaction.transaction_hash
+    # Returns the SponsoredSend of the Transfer, if the transfer is gasless.
+    # @return [Coinbase::SponsoredSend] The SponsoredSend object
+    def sponsored_send
+      @sponsored_send ||= @model.sponsored_send.nil? ? nil : Coinbase::SponsoredSend.new(@model.sponsored_send)
     end
 
     # Returns the status of the Transfer.
     # @return [Symbol] The status
     def status
-      transaction.status
+      send_tx_delegate.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
+      send_tx_delegate.transaction_link
+    end
+
+    # Returns the Transaction Hash of the Transfer.
+    # @return [String] The Transaction Hash
+    def transaction_hash
+      send_tx_delegate.transaction_hash
     end
 
     # Broadcasts the Transfer to the Network.
@@ -163,18 +176,19 @@ module Coinbase
     # @raise [RuntimeError] If the Transfer is not signed
     # @return [Transfer] The Transfer object
     def broadcast!
-      raise TransactionNotSignedError unless transaction.signed?
+      raise TransactionNotSignedError unless send_tx_delegate.signed?
 
       @model = Coinbase.call_api do
         transfers_api.broadcast_transfer(
           wallet_id,
           from_address_id,
           id,
-          { signed_payload: transaction.raw.hex }
+          { signed_payload: send_tx_delegate.signature }
         )
       end
 
-      update_transaction(@model)
+      update_transaction(@model) unless @model.transaction.nil?
+      update_sponsored_send(@model) unless @model.sponsored_send.nil?
 
       self
     end
@@ -186,7 +200,8 @@ module Coinbase
         transfers_api.get_transfer(wallet_id, from_address_id, id)
       end
 
-      update_transaction(@model)
+      update_transaction(@model) unless @model.transaction.nil?
+      update_sponsored_send(@model) unless @model.sponsored_send.nil?
 
       self
     end
@@ -202,7 +217,7 @@ module Coinbase
       loop do
         reload
 
-        return self if transaction.terminal_state?
+        return self if terminal_state?
 
         raise Timeout::Error, 'Transfer timed out' if Time.now - start_time > timeout_seconds
 
@@ -215,7 +230,7 @@ module Coinbase
     # Returns a String representation of the Transfer.
     # @return [String] a String representation of the Transfer
     def to_s
-      "Coinbase::Transfer{transfer_id: '#{id}', network_id: '#{network_id}', " \
+      "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_link: '#{transaction_link}', " \
         "status: '#{status}'}"
@@ -229,6 +244,16 @@ module Coinbase
 
     private
 
+    def terminal_state?
+      send_tx_delegate.terminal_state?
+    end
+
+    def send_tx_delegate
+      return sponsored_send unless sponsored_send.nil?
+
+      transaction
+    end
+
     def transfers_api
       @transfers_api ||= Coinbase::Client::TransfersApi.new(Coinbase.configuration.api_client)
     end
@@ -236,5 +261,9 @@ module Coinbase
     def update_transaction(model)
       @transaction = Coinbase::Transaction.new(model.transaction)
     end
+
+    def update_sponsored_send(model)
+      @sponsored_send = Coinbase::SponsoredSend.new(model.sponsored_send)
+    end
   end
 end

data/lib/coinbase/validator.rb

@@ -10,27 +10,31 @@ module Coinbase
     end
 
     # Returns a list of Validators for the provided network and asset.
-    # @param network_id [Symbol] The network ID
+    # @param network [Coinbase::Nework, Symbol] The Network or Network ID
     # @param asset_id [Symbol] The asset ID
     # @param status [Symbol] The status of the validator. Defaults to nil.
     # @return [Enumerable<Coinbase::Validator>] The validators
-    def self.list(network_id, asset_id, status: nil)
-      Coinbase::Pagination.enumerate(
-        ->(page) { list_page(network_id, asset_id, status, page) }
-      ) do |validator|
+    def self.list(network, asset_id, status: nil)
+      network = Coinbase::Network.from_id(network)
+
+      Coinbase::Pagination.enumerate(lambda { |page|
+        list_page(network, asset_id, status, page)
+      }) do |validator|
         new(validator)
       end
     end
 
     # Returns a Validator for the provided network, asset, and validator.
-    # @param network_id [Symbol] The network ID
+    # @param network [Coinbase::Network, Symbol] The Network or Network ID
     # @param asset_id [Symbol] The asset ID
     # @param validator_id [String] The validator ID
     # @return [Coinbase::Validator] The validator
-    def self.fetch(network_id, asset_id, validator_id)
+    def self.fetch(network, asset_id, validator_id)
+      network = Coinbase::Network.from_id(network)
+
       validator = Coinbase.call_api do
         validators_api.get_validator(
-          network_id,
+          network.normalized_id,
           asset_id,
           validator_id
         )
@@ -62,10 +66,10 @@ module Coinbase
       to_s
     end
 
-    def self.list_page(network_id, asset_id, status, page)
+    def self.list_page(network, asset_id, status, page)
       Coinbase.call_api do
         validators_api.list_validators(
-          network_id,
+          network.normalized_id,
           asset_id,
           {
             status: status,
@@ -75,8 +79,12 @@ module Coinbase
       end
     end
 
+    private_class_method :list_page
+
     def self.validators_api
       Coinbase::Client::ValidatorsApi.new(Coinbase.configuration.api_client)
     end
+
+    private_class_method :validators_api
   end
 end

data/lib/coinbase/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Coinbase
+  VERSION = '0.1.0'
+end

data/lib/coinbase/wallet/data.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Coinbase
+  class Wallet
+    # The data required to recreate a Wallet.
+    class Data
+      attr_reader :wallet_id, :seed
+
+      # Returns a new Data object.
+      # @param wallet_id [String] The ID of the Wallet
+      # @param seed [String] The seed of the Wallet
+      def initialize(wallet_id:, seed:)
+        @wallet_id = wallet_id
+        @seed = seed
+      end
+
+      # Converts the Data object to a Hash.
+      # @return [Hash] The Hash representation of the Data object
+      def to_hash
+        { wallet_id: wallet_id, seed: seed }
+      end
+
+      # Creates a Data object from the given Hash.
+      # @param data [Hash] The Hash to create the Data object from
+      # @return [Data] The new Data object
+      def self.from_hash(data)
+        Data.new(wallet_id: data['wallet_id'], seed: data['seed'])
+      end
+    end
+  end
+end