coinbase-sdk 0.2.0 → 0.5.0

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

@@ -4,9 +4,9 @@
 #This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
 
 The version of the OpenAPI document: 0.0.1-alpha
-Contact: yuga.cohler@coinbase.com
+
 Generated by: https://openapi-generator.tech
-Generator version: 7.7.0
+Generator version: 7.8.0
 
 =end
 

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

@@ -4,9 +4,9 @@
 #This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
 
 The version of the OpenAPI document: 0.0.1-alpha
-Contact: yuga.cohler@coinbase.com
+
 Generated by: https://openapi-generator.tech
-Generator version: 7.7.0
+Generator version: 7.8.0
 
 =end
 

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

@@ -4,9 +4,9 @@
 #This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
 
 The version of the OpenAPI document: 0.0.1-alpha
-Contact: yuga.cohler@coinbase.com
+
 Generated by: https://openapi-generator.tech
-Generator version: 7.7.0
+Generator version: 7.8.0
 
 =end
 

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

@@ -4,9 +4,9 @@
 #This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
 
 The version of the OpenAPI document: 0.0.1-alpha
-Contact: yuga.cohler@coinbase.com
+
 Generated by: https://openapi-generator.tech
-Generator version: 7.7.0
+Generator version: 7.8.0
 
 =end
 
@@ -36,6 +36,9 @@ module Coinbase::Client
     # The date and time the webhook was last updated.
     attr_accessor :updated_at
 
+    # The header that will contain the signature of the webhook payload.
+    attr_accessor :signature_header
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -67,7 +70,8 @@ module Coinbase::Client
         :'event_filters' => :'event_filters',
         :'notification_uri' => :'notification_uri',
         :'created_at' => :'created_at',
-        :'updated_at' => :'updated_at'
+        :'updated_at' => :'updated_at',
+        :'signature_header' => :'signature_header'
       }
     end
 
@@ -85,7 +89,8 @@ module Coinbase::Client
         :'event_filters' => :'Array<WebhookEventFilter>',
         :'notification_uri' => :'String',
         :'created_at' => :'Time',
-        :'updated_at' => :'Time'
+        :'updated_at' => :'Time',
+        :'signature_header' => :'String'
       }
     end
 
@@ -139,6 +144,10 @@ module Coinbase::Client
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
+
+      if attributes.key?(:'signature_header')
+        self.signature_header = attributes[:'signature_header']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -167,7 +176,8 @@ module Coinbase::Client
           event_filters == o.event_filters &&
           notification_uri == o.notification_uri &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          signature_header == o.signature_header
     end
 
     # @see the `==` method
@@ -179,7 +189,7 @@ module Coinbase::Client
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, network_id, event_type, event_filters, notification_uri, created_at, updated_at].hash
+      [id, network_id, event_type, event_filters, notification_uri, created_at, updated_at, signature_header].hash
     end
 
     # Builds the object from hash

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

@@ -4,9 +4,9 @@
 #This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
 
 The version of the OpenAPI document: 0.0.1-alpha
-Contact: yuga.cohler@coinbase.com
+
 Generated by: https://openapi-generator.tech
-Generator version: 7.7.0
+Generator version: 7.8.0
 
 =end
 
@@ -16,13 +16,13 @@ require 'time'
 module Coinbase::Client
   # The event_filter parameter specifies the criteria to filter events from the blockchain. It allows filtering events by contract address, sender address and receiver address. For a single event filter, not all of the properties need to be presented.
   class WebhookEventFilter
-    # The onchain contract address of the token being transferred.
+    # The onchain contract address of the token for which the events should be tracked.
     attr_accessor :contract_address
 
-    # The onchain address of the sender.
+    # The onchain address of the sender. Set this filter to track all transfer events originating from your address.
     attr_accessor :from_address
 
-    # The onchain address of the receiver.
+    # The onchain address of the receiver. Set this filter to track all transfer events sent to your address.
     attr_accessor :to_address
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -4,9 +4,9 @@
 #This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
 
 The version of the OpenAPI document: 0.0.1-alpha
-Contact: yuga.cohler@coinbase.com
+
 Generated by: https://openapi-generator.tech
-Generator version: 7.7.0
+Generator version: 7.8.0
 
 =end
 

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

@@ -4,9 +4,9 @@
 #This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
 
 The version of the OpenAPI document: 0.0.1-alpha
-Contact: yuga.cohler@coinbase.com
+
 Generated by: https://openapi-generator.tech
-Generator version: 7.7.0
+Generator version: 7.8.0
 
 =end
 

data/lib/coinbase/client/version.rb

@@ -4,9 +4,9 @@
 #This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
 
 The version of the OpenAPI document: 0.0.1-alpha
-Contact: yuga.cohler@coinbase.com
+
 Generated by: https://openapi-generator.tech
-Generator version: 7.7.0
+Generator version: 7.8.0
 
 =end
 

data/lib/coinbase/client.rb

@@ -4,9 +4,9 @@
 #This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
 
 The version of the OpenAPI document: 0.0.1-alpha
-Contact: yuga.cohler@coinbase.com
+
 Generated by: https://openapi-generator.tech
-Generator version: 7.7.0
+Generator version: 7.8.0
 
 =end
 
@@ -21,15 +21,21 @@ Coinbase::Client.autoload :Address, 'coinbase/client/models/address'
 Coinbase::Client.autoload :AddressBalanceList, 'coinbase/client/models/address_balance_list'
 Coinbase::Client.autoload :AddressHistoricalBalanceList, 'coinbase/client/models/address_historical_balance_list'
 Coinbase::Client.autoload :AddressList, 'coinbase/client/models/address_list'
+Coinbase::Client.autoload :AddressTransactionList, 'coinbase/client/models/address_transaction_list'
 Coinbase::Client.autoload :Asset, 'coinbase/client/models/asset'
 Coinbase::Client.autoload :Balance, 'coinbase/client/models/balance'
+Coinbase::Client.autoload :BroadcastContractInvocationRequest, 'coinbase/client/models/broadcast_contract_invocation_request'
 Coinbase::Client.autoload :BroadcastStakingOperationRequest, 'coinbase/client/models/broadcast_staking_operation_request'
 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 :ContractEvent, 'coinbase/client/models/contract_event'
 Coinbase::Client.autoload :ContractEventList, 'coinbase/client/models/contract_event_list'
+Coinbase::Client.autoload :ContractInvocation, 'coinbase/client/models/contract_invocation'
+Coinbase::Client.autoload :ContractInvocationList, 'coinbase/client/models/contract_invocation_list'
 Coinbase::Client.autoload :CreateAddressRequest, 'coinbase/client/models/create_address_request'
+Coinbase::Client.autoload :CreateContractInvocationRequest, 'coinbase/client/models/create_contract_invocation_request'
+Coinbase::Client.autoload :CreatePayloadSignatureRequest, 'coinbase/client/models/create_payload_signature_request'
 Coinbase::Client.autoload :CreateServerSignerRequest, 'coinbase/client/models/create_server_signer_request'
 Coinbase::Client.autoload :CreateStakingOperationRequest, 'coinbase/client/models/create_staking_operation_request'
 Coinbase::Client.autoload :CreateTradeRequest, 'coinbase/client/models/create_trade_request'
@@ -37,7 +43,13 @@ Coinbase::Client.autoload :CreateTransferRequest, 'coinbase/client/models/create
 Coinbase::Client.autoload :CreateWalletRequest, 'coinbase/client/models/create_wallet_request'
 Coinbase::Client.autoload :CreateWalletRequestWallet, 'coinbase/client/models/create_wallet_request_wallet'
 Coinbase::Client.autoload :CreateWebhookRequest, 'coinbase/client/models/create_webhook_request'
+Coinbase::Client.autoload :ERC20TransferEvent, 'coinbase/client/models/erc20_transfer_event'
+Coinbase::Client.autoload :ERC721TransferEvent, 'coinbase/client/models/erc721_transfer_event'
 Coinbase::Client.autoload :Error, 'coinbase/client/models/error'
+Coinbase::Client.autoload :EthereumTransaction, 'coinbase/client/models/ethereum_transaction'
+Coinbase::Client.autoload :EthereumTransactionAccess, 'coinbase/client/models/ethereum_transaction_access'
+Coinbase::Client.autoload :EthereumTransactionAccessList, 'coinbase/client/models/ethereum_transaction_access_list'
+Coinbase::Client.autoload :EthereumTransactionFlattenedTrace, 'coinbase/client/models/ethereum_transaction_flattened_trace'
 Coinbase::Client.autoload :EthereumValidatorMetadata, 'coinbase/client/models/ethereum_validator_metadata'
 Coinbase::Client.autoload :FaucetTransaction, 'coinbase/client/models/faucet_transaction'
 Coinbase::Client.autoload :FeatureSet, 'coinbase/client/models/feature_set'
@@ -48,6 +60,8 @@ Coinbase::Client.autoload :GetStakingContextRequest, 'coinbase/client/models/get
 Coinbase::Client.autoload :HistoricalBalance, 'coinbase/client/models/historical_balance'
 Coinbase::Client.autoload :Network, 'coinbase/client/models/network'
 Coinbase::Client.autoload :NetworkIdentifier, 'coinbase/client/models/network_identifier'
+Coinbase::Client.autoload :PayloadSignature, 'coinbase/client/models/payload_signature'
+Coinbase::Client.autoload :PayloadSignatureList, 'coinbase/client/models/payload_signature_list'
 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'
@@ -70,11 +84,11 @@ Coinbase::Client.autoload :StakingRewardUSDValue, 'coinbase/client/models/stakin
 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'
+Coinbase::Client.autoload :TransactionContent, 'coinbase/client/models/transaction_content'
 Coinbase::Client.autoload :TransactionType, 'coinbase/client/models/transaction_type'
 Coinbase::Client.autoload :Transfer, 'coinbase/client/models/transfer'
 Coinbase::Client.autoload :TransferList, 'coinbase/client/models/transfer_list'
 Coinbase::Client.autoload :UpdateWebhookRequest, 'coinbase/client/models/update_webhook_request'
-Coinbase::Client.autoload :User, 'coinbase/client/models/user'
 Coinbase::Client.autoload :Validator, 'coinbase/client/models/validator'
 Coinbase::Client.autoload :ValidatorDetails, 'coinbase/client/models/validator_details'
 Coinbase::Client.autoload :ValidatorList, 'coinbase/client/models/validator_list'
@@ -89,14 +103,15 @@ Coinbase::Client.autoload :WebhookList, 'coinbase/client/models/webhook_list'
 # APIs
 Coinbase::Client.autoload :AddressesApi, 'coinbase/client/api/addresses_api'
 Coinbase::Client.autoload :AssetsApi, 'coinbase/client/api/assets_api'
+Coinbase::Client.autoload :BalanceHistoryApi, 'coinbase/client/api/balance_history_api'
 Coinbase::Client.autoload :ContractEventsApi, 'coinbase/client/api/contract_events_api'
+Coinbase::Client.autoload :ContractInvocationsApi, 'coinbase/client/api/contract_invocations_api'
 Coinbase::Client.autoload :ExternalAddressesApi, 'coinbase/client/api/external_addresses_api'
 Coinbase::Client.autoload :NetworksApi, 'coinbase/client/api/networks_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'
 Coinbase::Client.autoload :ValidatorsApi, 'coinbase/client/api/validators_api'
 Coinbase::Client.autoload :WalletStakeApi, 'coinbase/client/api/wallet_stake_api'
 Coinbase::Client.autoload :WalletsApi, 'coinbase/client/api/wallets_api'

data/lib/coinbase/constants.rb

@@ -9,4 +9,7 @@ module Coinbase
 
   # The default page limit for paginated API requests.
   DEFAULT_PAGE_LIMIT = 100
+
+  # The default page limit for transaction paginated API request.
+  DEFAULT_TRANSACTION_PAGE_LIMIT = 10
 end

data/lib/coinbase/contract_invocation.rb

@@ -0,0 +1,259 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
+module Coinbase
+  # A representation of a Contract Invocation.
+  class ContractInvocation
+    class << self
+      # Creates a new ContractInvocation object.
+      # @param address_id [String] The Address ID of the signing Address
+      # @param wallet_id [String] The Wallet ID associated with the signing Address
+      # @param contract_address [String] The contract address
+      # @param abi [Array<Hash>] The contract ABI
+      # @param method [String] The contract method
+      # @param amount [Integer, Float, BigDecimal] The amount of the native Asset
+      #   to send to a payable contract method.
+      # @param asset_id [Symbol] The ID of the Asset to send to a payable contract method.
+      #   The Asset must be a denomination of the native Asset. For Ethereum, :eth, :gwei, and :wei are supported.
+      # @param network [Coinbase::Network, Symbol] The Network or Network ID of the Asset
+      # @param args [Hash] The arguments to pass to the contract method.
+      #   The keys should be the argument names, and the values should be the argument values.
+      # @return [ContractInvocation] The new Contract Invocation object
+      # @raise [Coinbase::ApiError] If the request to create the Contract Invocation fails
+      def create(
+        address_id:,
+        wallet_id:,
+        contract_address:,
+        abi:,
+        method:,
+        amount:,
+        asset_id:,
+        network:,
+        args: {}
+      )
+        atomic_amount = nil
+
+        if amount && asset_id && network
+          network = Coinbase::Network.from_id(network)
+          asset = network.get_asset(asset_id)
+          atomic_amount = asset.to_atomic_amount(amount).to_i_to_s
+        end
+
+        model = Coinbase.call_api do
+          contract_invocation_api.create_contract_invocation(
+            wallet_id,
+            address_id,
+            contract_address: contract_address,
+            abi: abi.to_json,
+            method: method,
+            args: args.to_json,
+            amount: atomic_amount
+          )
+        end
+
+        new(model)
+      end
+
+      # Enumerates the payload signatures for a given address belonging to a wallet.
+      # The result is an enumerator that lazily fetches from the server, and can be iterated over,
+      # converted an array, etc...
+      # @return [Enumerable<Coinbase::ContractInvocation>] Enumerator that returns payload signatures
+      def list(wallet_id:, address_id:)
+        Coinbase::Pagination.enumerate(
+          ->(page) { fetch_page(wallet_id, address_id, page) }
+        ) do |contract_invocation|
+          new(contract_invocation)
+        end
+      end
+
+      private
+
+      def contract_invocation_api
+        Coinbase::Client::ContractInvocationsApi.new(Coinbase.configuration.api_client)
+      end
+
+      def fetch_page(wallet_id, address_id, page)
+        contract_invocation_api.list_contract_invocations(
+          wallet_id,
+          address_id,
+          limit: DEFAULT_PAGE_LIMIT,
+          page: page
+        )
+      end
+    end
+
+    # Returns a new ContractInvocation object. Do not use this method directly.
+    # Instead use Coinbase::ContractInvocation.create.
+    # @param model [Coinbase::Client::ContractInvocation] The underlying Contract Invocation obejct
+    def initialize(model)
+      raise unless model.is_a?(Coinbase::Client::ContractInvocation)
+
+      @model = model
+    end
+
+    # Returns the Contract Invocation ID.
+    # @return [String] The Contract Invocation ID
+    def id
+      @model.contract_invocation_id
+    end
+
+    # Returns the Wallet ID of the Contract Invocation.
+    # @return [String] The Wallet ID
+    def wallet_id
+      @model.wallet_id
+    end
+
+    # Returns the Address ID of the Contract Invocation.
+    # @return [String] The Address ID
+    def address_id
+      @model.address_id
+    end
+
+    # Returns the Network of the Contract Invocation.
+    # @return [Coinbase::Network] The Network
+    def network
+      @network ||= Coinbase::Network.from_id(@model.network_id)
+    end
+
+    # Returns the Contract Address of the Contract Invocation.
+    # @return [String] The Contract Address
+    def contract_address
+      @model.contract_address
+    end
+
+    # Returns the ABI of the Contract Invocation.
+    # @return [Array<Hash>] The ABI
+    def abi
+      JSON.parse(@model.abi)
+    end
+
+    # Returns the method of the Contract Invocation.
+    # @return [String] The method
+    def method
+      @model.method
+    end
+
+    # Returns the arguments of the Contract Invocation.
+    # @return [Hash] The arguments
+    def args
+      JSON.parse(@model.args).transform_keys(&:to_sym)
+    end
+
+    # Returns the amount of the native asset sent to a payable contract method, if applicable.
+    # @return [BigDecimal] The amount in atomic units of the native asset
+    def amount
+      BigDecimal(@model.amount)
+    end
+
+    # Returns the transaction.
+    # @return [Coinbase::Transaction] The Transfer transaction
+    def transaction
+      @transaction ||= Coinbase::Transaction.new(@model.transaction)
+    end
+
+    # Returns the status of the Contract Invocation.
+    # @return [String] The status
+    def status
+      transaction.status
+    end
+
+    # Signs the Contract Invocation transaction with the given key.
+    # This is required before broadcasting the Contract Invocation when not using
+    # a Server-Signer.
+    # @param key [Eth::Key] The key to sign the ContractInvocation with
+    # @raise [RuntimeError] If the key is not an Eth::Key
+    # @return [ContractInvocation] The ContractInvocation object
+    def sign(key)
+      raise unless key.is_a?(Eth::Key)
+
+      transaction.sign(key)
+
+      self
+    end
+
+    # Broadcasts the ContractInvocation to the Network.
+    # @raise [RuntimeError] If the ContractInvocation is not signed
+    # @return [ContractInvocation] The ContractInvocation object
+    def broadcast!
+      raise TransactionNotSignedError unless transaction.signed?
+
+      @model = Coinbase.call_api do
+        contract_invocation_api.broadcast_contract_invocation(
+          wallet_id,
+          address_id,
+          id,
+          { signed_payload: transaction.signature }
+        )
+      end
+
+      @transaction = Coinbase::Transaction.new(@model.transaction)
+
+      self
+    end
+
+    # # Reload reloads the Contract Invocation model with the latest version from the server side.
+    # @return [ContractInvocation] The most recent version of Contract Invocation from the server
+    def reload
+      @model = Coinbase.call_api do
+        contract_invocation_api.get_contract_invocation(wallet_id, address_id, id)
+      end
+
+      @transaction = Coinbase::Transaction.new(@model.transaction)
+
+      self
+    end
+
+    # Waits until the Contract Invocation is signed or failed by polling the server at the given interval. Raises a
+    # Timeout::Error if the Contract Invocation takes longer than the given timeout.
+    # @param interval_seconds [Integer] The interval at which to poll the server, in seconds
+    # @param timeout_seconds [Integer] The maximum amount of time to wait for the Contract Invocation to be signed,
+    # in seconds.
+    # @return [ContractInvocation] The completed Contract Invocation object
+    def wait!(interval_seconds = 0.2, timeout_seconds = 20)
+      start_time = Time.now
+
+      loop do
+        reload
+
+        return self if transaction.terminal_state?
+
+        raise Timeout::Error, 'Contract Invocation timed out' if Time.now - start_time > timeout_seconds
+
+        self.sleep interval_seconds
+      end
+
+      self
+    end
+
+    # Returns a String representation of the Contract Invocation.
+    # @return [String] a String representation of the Contract Invocation
+    def to_s
+      Coinbase.pretty_print_object(
+        self.class,
+        id: id,
+        wallet_id: wallet_id,
+        address_id: address_id,
+        network_id: network.id,
+        status: status,
+        abi: abi.to_json,
+        method: method,
+        args: args.to_json,
+        transaction_hash: transaction.transaction_hash,
+        transaction_link: transaction.transaction_link
+      )
+    end
+
+    # Same as to_s.
+    # @return [String] a String representation of the ContractInvocation
+    def inspect
+      to_s
+    end
+
+    private
+
+    def contract_invocation_api
+      @contract_invocation_api ||= Coinbase::Client::ContractInvocationsApi.new(Coinbase.configuration.api_client)
+    end
+  end
+end