coinbase-sdk 0.0.6 → 0.0.7

data/lib/coinbase/client/models/trade.rb

@@ -40,6 +40,8 @@ module Coinbase::Client
 
     attr_accessor :transaction
 
+    attr_accessor :approve_transaction
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -51,7 +53,8 @@ module Coinbase::Client
         :'from_asset' => :'from_asset',
         :'to_amount' => :'to_amount',
         :'to_asset' => :'to_asset',
-        :'transaction' => :'transaction'
+        :'transaction' => :'transaction',
+        :'approve_transaction' => :'approve_transaction'
       }
     end
 
@@ -71,7 +74,8 @@ module Coinbase::Client
         :'from_asset' => :'Asset',
         :'to_amount' => :'String',
         :'to_asset' => :'Asset',
-        :'transaction' => :'Transaction'
+        :'transaction' => :'Transaction',
+        :'approve_transaction' => :'Transaction'
       }
     end
 
@@ -149,6 +153,10 @@ module Coinbase::Client
       else
         self.transaction = nil
       end
+
+      if attributes.key?(:'approve_transaction')
+        self.approve_transaction = attributes[:'approve_transaction']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -224,7 +232,8 @@ module Coinbase::Client
           from_asset == o.from_asset &&
           to_amount == o.to_amount &&
           to_asset == o.to_asset &&
-          transaction == o.transaction
+          transaction == o.transaction &&
+          approve_transaction == o.approve_transaction
     end
 
     # @see the `==` method
@@ -236,7 +245,7 @@ module Coinbase::Client
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [network_id, wallet_id, address_id, trade_id, from_amount, from_asset, to_amount, to_asset, transaction].hash
+      [network_id, wallet_id, address_id, trade_id, from_amount, from_asset, to_amount, to_asset, transaction, approve_transaction].hash
     end
 
     # Builds the object from hash

data/lib/coinbase/client/models/transaction.rb

@@ -16,6 +16,12 @@ require 'time'
 module Coinbase::Client
   # An onchain transaction.
   class Transaction
+    # The ID of the blockchain network
+    attr_accessor :network_id
+
+    # The onchain address of the sender
+    attr_accessor :from_address_id
+
     # The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.
     attr_accessor :unsigned_payload
 
@@ -25,6 +31,9 @@ module Coinbase::Client
     # The hash of the transaction
     attr_accessor :transaction_hash
 
+    # The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.
+    attr_accessor :transaction_link
+
     # The status of the transaction
     attr_accessor :status
 
@@ -53,9 +62,12 @@ module Coinbase::Client
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'network_id' => :'network_id',
+        :'from_address_id' => :'from_address_id',
         :'unsigned_payload' => :'unsigned_payload',
         :'signed_payload' => :'signed_payload',
         :'transaction_hash' => :'transaction_hash',
+        :'transaction_link' => :'transaction_link',
         :'status' => :'status'
       }
     end
@@ -68,9 +80,12 @@ module Coinbase::Client
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'network_id' => :'String',
+        :'from_address_id' => :'String',
         :'unsigned_payload' => :'String',
         :'signed_payload' => :'String',
         :'transaction_hash' => :'String',
+        :'transaction_link' => :'String',
         :'status' => :'String'
       }
     end
@@ -96,6 +111,18 @@ module Coinbase::Client
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'network_id')
+        self.network_id = attributes[:'network_id']
+      else
+        self.network_id = nil
+      end
+
+      if attributes.key?(:'from_address_id')
+        self.from_address_id = attributes[:'from_address_id']
+      else
+        self.from_address_id = nil
+      end
+
       if attributes.key?(:'unsigned_payload')
         self.unsigned_payload = attributes[:'unsigned_payload']
       else
@@ -110,6 +137,10 @@ module Coinbase::Client
         self.transaction_hash = attributes[:'transaction_hash']
       end
 
+      if attributes.key?(:'transaction_link')
+        self.transaction_link = attributes[:'transaction_link']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       else
@@ -122,6 +153,14 @@ module Coinbase::Client
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @network_id.nil?
+        invalid_properties.push('invalid value for "network_id", network_id cannot be nil.')
+      end
+
+      if @from_address_id.nil?
+        invalid_properties.push('invalid value for "from_address_id", from_address_id cannot be nil.')
+      end
+
       if @unsigned_payload.nil?
         invalid_properties.push('invalid value for "unsigned_payload", unsigned_payload cannot be nil.')
       end
@@ -137,6 +176,8 @@ module Coinbase::Client
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @network_id.nil?
+      return false if @from_address_id.nil?
       return false if @unsigned_payload.nil?
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["pending", "broadcast", "complete", "failed"])
@@ -159,9 +200,12 @@ module Coinbase::Client
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          network_id == o.network_id &&
+          from_address_id == o.from_address_id &&
           unsigned_payload == o.unsigned_payload &&
           signed_payload == o.signed_payload &&
           transaction_hash == o.transaction_hash &&
+          transaction_link == o.transaction_link &&
           status == o.status
     end
 
@@ -174,7 +218,7 @@ module Coinbase::Client
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [unsigned_payload, signed_payload, transaction_hash, status].hash
+      [network_id, from_address_id, unsigned_payload, signed_payload, transaction_hash, transaction_link, status].hash
     end
 
     # Builds the object from hash

data/lib/coinbase/client/models/transfer.rb

@@ -34,9 +34,13 @@ module Coinbase::Client
     # The ID of the asset being transferred
     attr_accessor :asset_id
 
+    attr_accessor :asset
+
     # The ID of the transfer
     attr_accessor :transfer_id
 
+    attr_accessor :transaction
+
     # The unsigned payload of the transfer. This is the payload that needs to be signed by the sender.
     attr_accessor :unsigned_payload
 
@@ -80,7 +84,9 @@ module Coinbase::Client
         :'destination' => :'destination',
         :'amount' => :'amount',
         :'asset_id' => :'asset_id',
+        :'asset' => :'asset',
         :'transfer_id' => :'transfer_id',
+        :'transaction' => :'transaction',
         :'unsigned_payload' => :'unsigned_payload',
         :'signed_payload' => :'signed_payload',
         :'transaction_hash' => :'transaction_hash',
@@ -102,7 +108,9 @@ module Coinbase::Client
         :'destination' => :'String',
         :'amount' => :'String',
         :'asset_id' => :'String',
+        :'asset' => :'Asset',
         :'transfer_id' => :'String',
+        :'transaction' => :'Transaction',
         :'unsigned_payload' => :'String',
         :'signed_payload' => :'String',
         :'transaction_hash' => :'String',
@@ -167,12 +175,24 @@ module Coinbase::Client
         self.asset_id = nil
       end
 
+      if attributes.key?(:'asset')
+        self.asset = attributes[:'asset']
+      else
+        self.asset = nil
+      end
+
       if attributes.key?(:'transfer_id')
         self.transfer_id = attributes[:'transfer_id']
       else
         self.transfer_id = nil
       end
 
+      if attributes.key?(:'transaction')
+        self.transaction = attributes[:'transaction']
+      else
+        self.transaction = nil
+      end
+
       if attributes.key?(:'unsigned_payload')
         self.unsigned_payload = attributes[:'unsigned_payload']
       else
@@ -223,10 +243,18 @@ module Coinbase::Client
         invalid_properties.push('invalid value for "asset_id", asset_id cannot be nil.')
       end
 
+      if @asset.nil?
+        invalid_properties.push('invalid value for "asset", asset cannot be nil.')
+      end
+
       if @transfer_id.nil?
         invalid_properties.push('invalid value for "transfer_id", transfer_id cannot be nil.')
       end
 
+      if @transaction.nil?
+        invalid_properties.push('invalid value for "transaction", transaction cannot be nil.')
+      end
+
       if @unsigned_payload.nil?
         invalid_properties.push('invalid value for "unsigned_payload", unsigned_payload cannot be nil.')
       end
@@ -248,7 +276,9 @@ module Coinbase::Client
       return false if @destination.nil?
       return false if @amount.nil?
       return false if @asset_id.nil?
+      return false if @asset.nil?
       return false if @transfer_id.nil?
+      return false if @transaction.nil?
       return false if @unsigned_payload.nil?
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["pending", "broadcast", "complete", "failed"])
@@ -277,7 +307,9 @@ module Coinbase::Client
           destination == o.destination &&
           amount == o.amount &&
           asset_id == o.asset_id &&
+          asset == o.asset &&
           transfer_id == o.transfer_id &&
+          transaction == o.transaction &&
           unsigned_payload == o.unsigned_payload &&
           signed_payload == o.signed_payload &&
           transaction_hash == o.transaction_hash &&
@@ -293,7 +325,7 @@ module Coinbase::Client
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [network_id, wallet_id, address_id, destination, amount, asset_id, transfer_id, unsigned_payload, signed_payload, transaction_hash, status].hash
+      [network_id, wallet_id, address_id, destination, amount, asset_id, asset, transfer_id, transaction, unsigned_payload, signed_payload, transaction_hash, status].hash
     end
 
     # Builds the object from hash

data/lib/coinbase/client/models/wallet.rb

@@ -23,6 +23,9 @@ module Coinbase::Client
 
     attr_accessor :default_address
 
+    # The features enabled for the wallet
+    attr_accessor :enabled_features
+
     # The status of the Server-Signer for the wallet if present.
     attr_accessor :server_signer_status
 
@@ -54,6 +57,7 @@ module Coinbase::Client
         :'id' => :'id',
         :'network_id' => :'network_id',
         :'default_address' => :'default_address',
+        :'enabled_features' => :'enabled_features',
         :'server_signer_status' => :'server_signer_status'
       }
     end
@@ -69,6 +73,7 @@ module Coinbase::Client
         :'id' => :'String',
         :'network_id' => :'String',
         :'default_address' => :'Address',
+        :'enabled_features' => :'Array<Feature>',
         :'server_signer_status' => :'String'
       }
     end
@@ -110,6 +115,14 @@ module Coinbase::Client
         self.default_address = attributes[:'default_address']
       end
 
+      if attributes.key?(:'enabled_features')
+        if (value = attributes[:'enabled_features']).is_a?(Array)
+          self.enabled_features = value
+        end
+      else
+        self.enabled_features = nil
+      end
+
       if attributes.key?(:'server_signer_status')
         self.server_signer_status = attributes[:'server_signer_status']
       end
@@ -128,6 +141,10 @@ module Coinbase::Client
         invalid_properties.push('invalid value for "network_id", network_id cannot be nil.')
       end
 
+      if @enabled_features.nil?
+        invalid_properties.push('invalid value for "enabled_features", enabled_features cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -137,6 +154,7 @@ module Coinbase::Client
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
       return false if @network_id.nil?
+      return false if @enabled_features.nil?
       server_signer_status_validator = EnumAttributeValidator.new('String', ["pending_seed_creation", "active_seed"])
       return false unless server_signer_status_validator.valid?(@server_signer_status)
       true
@@ -160,6 +178,7 @@ module Coinbase::Client
           id == o.id &&
           network_id == o.network_id &&
           default_address == o.default_address &&
+          enabled_features == o.enabled_features &&
           server_signer_status == o.server_signer_status
     end
 
@@ -172,7 +191,7 @@ module Coinbase::Client
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, network_id, default_address, server_signer_status].hash
+      [id, network_id, default_address, enabled_features, server_signer_status].hash
     end
 
     # Builds the object from hash

data/lib/coinbase/client.rb

@@ -24,6 +24,7 @@ Coinbase::Client.autoload :Asset, 'coinbase/client/models/asset'
 Coinbase::Client.autoload :Balance, 'coinbase/client/models/balance'
 Coinbase::Client.autoload :BroadcastTradeRequest, 'coinbase/client/models/broadcast_trade_request'
 Coinbase::Client.autoload :BroadcastTransferRequest, 'coinbase/client/models/broadcast_transfer_request'
+Coinbase::Client.autoload :BuildStakingOperationRequest, 'coinbase/client/models/build_staking_operation_request'
 Coinbase::Client.autoload :CreateAddressRequest, 'coinbase/client/models/create_address_request'
 Coinbase::Client.autoload :CreateServerSignerRequest, 'coinbase/client/models/create_server_signer_request'
 Coinbase::Client.autoload :CreateTradeRequest, 'coinbase/client/models/create_trade_request'
@@ -32,14 +33,17 @@ Coinbase::Client.autoload :CreateWalletRequest, 'coinbase/client/models/create_w
 Coinbase::Client.autoload :CreateWalletRequestWallet, 'coinbase/client/models/create_wallet_request_wallet'
 Coinbase::Client.autoload :Error, 'coinbase/client/models/error'
 Coinbase::Client.autoload :FaucetTransaction, 'coinbase/client/models/faucet_transaction'
+Coinbase::Client.autoload :Feature, 'coinbase/client/models/feature'
 Coinbase::Client.autoload :SeedCreationEvent, 'coinbase/client/models/seed_creation_event'
 Coinbase::Client.autoload :SeedCreationEventResult, 'coinbase/client/models/seed_creation_event_result'
 Coinbase::Client.autoload :ServerSigner, 'coinbase/client/models/server_signer'
 Coinbase::Client.autoload :ServerSignerEvent, 'coinbase/client/models/server_signer_event'
 Coinbase::Client.autoload :ServerSignerEventEvent, 'coinbase/client/models/server_signer_event_event'
 Coinbase::Client.autoload :ServerSignerEventList, 'coinbase/client/models/server_signer_event_list'
+Coinbase::Client.autoload :ServerSignerList, 'coinbase/client/models/server_signer_list'
 Coinbase::Client.autoload :SignatureCreationEvent, 'coinbase/client/models/signature_creation_event'
 Coinbase::Client.autoload :SignatureCreationEventResult, 'coinbase/client/models/signature_creation_event_result'
+Coinbase::Client.autoload :StakingOperation, 'coinbase/client/models/staking_operation'
 Coinbase::Client.autoload :Trade, 'coinbase/client/models/trade'
 Coinbase::Client.autoload :TradeList, 'coinbase/client/models/trade_list'
 Coinbase::Client.autoload :Transaction, 'coinbase/client/models/transaction'
@@ -53,6 +57,7 @@ Coinbase::Client.autoload :WalletList, 'coinbase/client/models/wallet_list'
 # APIs
 Coinbase::Client.autoload :AddressesApi, 'coinbase/client/api/addresses_api'
 Coinbase::Client.autoload :ServerSignersApi, 'coinbase/client/api/server_signers_api'
+Coinbase::Client.autoload :StakeApi, 'coinbase/client/api/stake_api'
 Coinbase::Client.autoload :TradesApi, 'coinbase/client/api/trades_api'
 Coinbase::Client.autoload :TransfersApi, 'coinbase/client/api/transfers_api'
 Coinbase::Client.autoload :UsersApi, 'coinbase/client/api/users_api'

data/lib/coinbase/errors.rb

@@ -76,6 +76,8 @@ module Coinbase
         InvalidSignedPayloadError.new(err)
       when 'invalid_transfer_status'
         InvalidTransferStatusError.new(err)
+      when 'network_feature_unsupported'
+        NetworkFeatureUnsupportedError.new(err)
       else
         APIError.new(err)
       end
@@ -117,4 +119,5 @@ module Coinbase
   class FaucetLimitReachedError < APIError; end
   class InvalidSignedPayloadError < APIError; end
   class InvalidTransferStatusError < APIError; end
+  class NetworkFeatureUnsupportedError < APIError; end
 end

data/lib/coinbase/server_signer.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+
+module Coinbase
+  # A representation of a Server-Signer. Server-Signers are assigned to sign transactions for a Wallet.
+  class ServerSigner
+    # Returns a new Server-Signer object. Do not use this method directly. Instead, use ServerSigner.default.
+    def initialize(model)
+      @model = model
+    end
+
+    class << self
+      # Returns the default ServerSigner for the CDP Project.
+      # @return [Coinbase::ServerSigner] the default Server-Signer
+      def default
+        response = Coinbase.call_api do
+          server_signers_api.list_server_signers
+        end
+
+        raise 'No Server-Signer is associated with the project' if response.data.empty?
+
+        new(response.data.first)
+      end
+
+      private
+
+      def server_signers_api
+        Coinbase::Client::ServerSignersApi.new(Coinbase.configuration.api_client)
+      end
+    end
+
+    # Returns the Server-Signer ID.
+    # @return [String] the Server-Signer ID
+    def id
+      @model.server_signer_id
+    end
+
+    # Returns the IDs of the Wallet's the Server-Signer can sign for.
+    # @return [Array<String>] the wallet IDs
+    def wallets
+      @model.wallets
+    end
+
+    # Returns a string representation of the Server-Signer.
+    # @return [String] a string representation of the Server-Signer
+    def to_s
+      "Coinbase::ServerSigner{server_signer_id: '#{id}', wallets: [#{wallets.join(', ')}]}"
+    end
+
+    # Same as to_s.
+    # @return [String] a string representation of the Server-Signer
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/coinbase/trade.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require_relative 'constants'
+require 'bigdecimal'
+require 'eth'
+
+module Coinbase
+  # A representation of a Trade, which trades an amount of an Asset to another Asset on a Network.
+  # The fee is assumed to be paid in the native Asset of the Network.
+  # Trades should be created through Wallet#trade or # Address#trade.
+  class Trade
+    # Returns a new Trade object. Do not use this method directly. Instead, use Wallet#trade or
+    # Address#trade.
+    # @param model [Coinbase::Client::Trade] The underlying Trade object
+    def initialize(model)
+      raise unless model.is_a?(Coinbase::Client::Trade)
+
+      @model = model
+    end
+
+    # Returns the Trade ID.
+    # @return [String] The Trade ID
+    def id
+      @model.trade_id
+    end
+
+    # Returns the Network ID of the Trade.
+    # @return [Symbol] The Network ID
+    def network_id
+      Coinbase.to_sym(@model.network_id)
+    end
+
+    # Returns the Wallet ID of the Trade.
+    # @return [String] The Wallet ID
+    def wallet_id
+      @model.wallet_id
+    end
+
+    # Returns the Address ID of the Trade.
+    # @return [String] The Address ID
+    def address_id
+      @model.address_id
+    end
+
+    # Returns the From Asset ID of the Trade.
+    # @return [Symbol] The From Asset ID
+    def from_asset_id
+      @model.from_asset.asset_id.to_sym
+    end
+
+    # Returns the amount of the from asset for the Trade.
+    # @return [BigDecimal] The amount of the from asset
+    def from_amount
+      BigDecimal(@model.from_amount) / BigDecimal(10).power(@model.from_asset.decimals)
+    end
+
+    # Returns the To Asset ID of the Trade.
+    # @return [Symbol] The To Asset ID
+    def to_asset_id
+      @model.to_asset.asset_id.to_sym
+    end
+
+    # Returns the amount of the to asset for the Trade.
+    # @return [BigDecimal] The amount of the to asset
+    def to_amount
+      BigDecimal(@model.to_amount) / BigDecimal(10).power(@model.to_asset.decimals)
+    end
+
+    # Returns the Trade transaction.
+    # @return [Coinbase::Transaction] The Trade transaction
+    def transaction
+      @transaction ||= Coinbase::Transaction.new(@model.transaction)
+    end
+
+    def approve_transaction
+      @approve_transaction ||= @model.approve_transaction ? Coinbase::Transaction.new(@model.approve_transaction) : nil
+    end
+
+    # Returns the status of the Trade.
+    # @return [Symbol] The status
+    def status
+      transaction.status
+    end
+
+    # Waits until the Trade is completed or failed by polling the Network at the given interval. Raises a
+    # Timeout::Error if the Trade takes longer than the given timeout.
+    # @param interval_seconds [Integer] The interval at which to poll the Network, in seconds
+    # @param timeout_seconds [Integer] The maximum amount of time to wait for the Trade to complete, in seconds
+    # @return [Trade] The completed Trade object
+    def wait!(interval_seconds = 0.2, timeout_seconds = 10)
+      start_time = Time.now
+
+      loop do
+        reload
+
+        # Wait for the trade transaction to be in a terminal state.
+        # The approve transaction is optional and must last first, so we don't need to wait for it.
+        # We may want to handle a situation where the approve transaction fails and the
+        # trade transaction does not ever get broadcast.
+        break if transaction.terminal_state?
+
+        raise Timeout::Error, 'Trade timed out' if Time.now - start_time > timeout_seconds
+
+        self.sleep interval_seconds
+      end
+
+      self
+    end
+
+    # Reloads the Trade model with the latest version from the server side.
+    # @return [Trade] The most recent version of Trade from the server.
+    def reload
+      @model = Coinbase.call_api do
+        trades_api.get_trade(wallet_id, address_id, id)
+      end
+
+      # Update the memoized transaction.
+      @transaction = Coinbase::Transaction.new(@model.transaction)
+
+      # Update the memoized approve transaction if it exists.
+      @approve_transaction = @model.approve_transaction ? Coinbase::Transaction.new(@model.approve_transaction) : nil
+
+      self
+    end
+
+    # Returns a String representation of the Trade.
+    # @return [String] a String representation of the Trade
+    def to_s
+      "Coinbase::Trade{transfer_id: '#{id}', network_id: '#{network_id}', " \
+        "address_id: '#{address_id}', from_asset_id: '#{from_asset_id}', " \
+        "to_asset_id: '#{to_asset_id}', from_amount: '#{from_amount}', " \
+        "to_amount: '#{to_amount}' status: '#{status}'}"
+    end
+
+    # Same as to_s.
+    # @return [String] a String representation of the Trade
+    def inspect
+      to_s
+    end
+
+    private
+
+    def trades_api
+      @trades_api ||= Coinbase::Client::TradesApi.new(Coinbase.configuration.api_client)
+    end
+  end
+end