coinbase-sdk 0.0.7 → 0.0.9

data/lib/coinbase/wallet.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'digest'
-require 'jimson'
 require 'json'
 require 'money-tree'
 require 'securerandom'
@@ -9,14 +8,14 @@ require 'securerandom'
 module Coinbase
   # A representation of a Wallet. Wallets come with a single default Address, but can expand to have a set of Addresses,
   # each of which can hold a balance of one or more Assets. Wallets can create new Addresses, list their addresses,
-  # list their balances, and transfer Assets to other Addresses. Wallets should be created through User#create_wallet or
-  # User#import_wallet.
+  # list their balances, and transfer Assets to other Addresses.
   class Wallet
-    attr_reader :addresses, :model
-
     # The maximum number of addresses in a Wallet.
     MAX_ADDRESSES = 20
 
+    # The maximum number of wallets to fetch in a single page.
+    PAGE_LIMIT = 100
+
     # A representation of ServerSigner status in a Wallet.
     module ServerSignerStatus
       # The Wallet is awaiting seed creation by the ServerSigner. At this point,
@@ -39,11 +38,31 @@ module Coinbase
           wallets_api.get_wallet(data.wallet_id)
         end
 
-        address_list = Coinbase.call_api do
-          addresses_api.list_addresses(model.id, { limit: MAX_ADDRESSES })
+        new(model, seed: data.seed)
+      end
+
+      # Enumerates the wallets for the requesting user.
+      # The result is an enumerator that lazily fetches from the server, and can be iterated over,
+      # converted to an array, etc...
+      # @return [Enumerable<Coinbase::Wallet>] Enumerator that returns wallets
+      def list
+        Coinbase::Pagination.enumerate(lambda(&method(:fetch_wallets_page))) do |wallet|
+          Coinbase::Wallet.new(wallet, seed: '')
+        end
+      end
+
+      # Fetches a Wallet by its ID.
+      # The returned wallet can be immediately used for signing operations if backed by a server signer.
+      # If the wallet is not backed by a server signer, the wallet's seed will need to be set before
+      # it can be used for signing operations.
+      # @param wallet_id [String] The ID of the Wallet to fetch
+      # @return [Coinbase::Wallet] The fetched Wallet
+      def fetch(wallet_id)
+        model = Coinbase.call_api do
+          wallets_api.get_wallet(wallet_id)
         end
 
-        new(model, seed: data.seed, address_models: address_list.data)
+        new(model, seed: '')
       end
 
       # Creates a new Wallet on the specified Network and generate a default address for it.
@@ -58,7 +77,7 @@ module Coinbase
           wallets_api.create_wallet(
             create_wallet_request: {
               wallet: {
-                network_id: network_id,
+                network_id: Coinbase.normalize_network(network_id),
                 use_server_signer: Coinbase.use_server_signer?
               }
             }
@@ -103,7 +122,6 @@ module Coinbase
         self
       end
 
-      # TODO: Memoize these objects in a thread-safe way at the top-level.
       def addresses_api
         Coinbase::Client::AddressesApi.new(Coinbase.configuration.api_client)
       end
@@ -111,6 +129,10 @@ module Coinbase
       def wallets_api
         Coinbase::Client::WalletsApi.new(Coinbase.configuration.api_client)
       end
+
+      def fetch_wallets_page(page)
+        wallets_api.list_wallets({ limit: PAGE_LIMIT, page: page })
+      end
     end
 
     # Returns a new Wallet object. Do not use this method directly. Instead, use User#create_wallet or
@@ -119,21 +141,30 @@ module Coinbase
     # @param seed [String] (Optional) The seed to use for the Wallet. Expects a 32-byte hexadecimal with no 0x prefix.
     #   If nil, a new seed will be generated. If the empty string, no seed is generated, and the Wallet will be
     #   instantiated without a seed and its corresponding private keys.
-    # @param address_models [Array<Coinbase::Client::Address>] (Optional) The models of the addresses already registered
     #   with the Wallet. If not provided, the Wallet will derive the first default address.
-    # @param client [Jimson::Client] (Optional) The JSON RPC client to use for interacting with the Network
-    def initialize(model, seed: nil, address_models: [])
-      validate_seed_and_address_models(seed, address_models) unless Coinbase.use_server_signer?
+    def initialize(model, seed: nil)
+      raise ArgumentError, 'model must be a Wallet' unless model.is_a?(Coinbase::Client::Wallet)
 
       @model = model
-      @addresses = []
 
-      unless Coinbase.use_server_signer?
-        @master = master_node(seed)
-        @private_key_index = 0
-      end
+      return if Coinbase.use_server_signer?
+
+      @master = master_node(seed)
+    end
+
+    # Returns the addresses belonging to the Wallet.
+    # @return [Array<Coinbase::WalletAddress>] The addresses belonging to the Wallet
+    def addresses
+      @addresses ||= begin
+        address_list = Coinbase.call_api do
+          addresses_api.list_addresses(@model.id, { limit: MAX_ADDRESSES })
+        end
 
-      derive_addresses(address_models)
+        # Build the WalletAddress objects, injecting the key if available.
+        address_list.data.each_with_index.map do |address_model, index|
+          build_wallet_address(address_model, index)
+        end
+      end
     end
 
     # Returns the Wallet ID.
@@ -157,18 +188,22 @@ module Coinbase
     # Sets the seed of the Wallet. This seed is used to derive keys and sign transactions.
     # @param seed [String] The seed to set. Expects a 32-byte hexadecimal with no 0x prefix.
     def seed=(seed)
-      raise ArgumentError, 'Seed must be 32 bytes' if seed.length != 64
-      raise 'Seed is already set' unless @master.nil?
-      raise 'Cannot set seed for Wallet with non-zero private key index' if @private_key_index.positive?
+      raise ArgumentError, 'Seed must not be empty' if seed.nil? || seed.empty?
+      raise StandardError, 'Seed is already set' unless @master.nil?
+
+      @master = master_node(seed)
 
-      @master = MoneyTree::Master.new(seed_hex: seed)
+      # If the addresses are not loaded the keys will be set on them whenever they are loaded.
+      return if @addresses.nil?
 
-      @addresses.each do
-        key = derive_key
-        a = address(key.address.to_s)
-        raise "Seed does not match wallet; cannot find address #{key.address}" if a.nil?
+      # If addresses are already loaded, set the keys on each address.
+      addresses.each_with_index.each do |address, index|
+        key = derive_key(index)
 
-        a.key = key
+        # If we derive a key the derived address must match the address from the API.
+        raise StandardError, 'Seed does not match wallet' unless address.id == key.address.to_s
+
+        address.key = key
       end
     end
 
@@ -178,7 +213,10 @@ module Coinbase
       opts = { create_address_request: {} }
 
       unless Coinbase.use_server_signer?
-        key = derive_key
+        # The index for the next address is the number of addresses already registered.
+        private_key_index = addresses.count
+
+        key = derive_key(private_key_index)
 
         opts = {
           create_address_request: {
@@ -193,9 +231,12 @@ module Coinbase
       end
 
       # Auto-reload wallet to set default address on first address creation.
-      reload if addresses.empty?
+      reload if default_address.nil?
 
-      cache_address(address_model, key)
+      # Cache the address in our memoized list
+      address = WalletAddress.new(address_model, key)
+      @addresses << address
+      address
     end
 
     # Returns the default address of the Wallet.
@@ -208,7 +249,7 @@ module Coinbase
     # @param address_id [String] The ID of the Address to retrieve
     # @return [Address] The Address
     def address(address_id)
-      @addresses.find { |address| address.id == address_id }
+      addresses.find { |address| address.id == address_id }
     end
 
     # Returns the list of balances of this Wallet. Balances are aggregated across all Addresses in the Wallet.
@@ -413,85 +454,35 @@ module Coinbase
       end
     end
 
+    # Returns the master node for the given seed.
     def master_node(seed)
       return MoneyTree::Master.new if seed.nil?
       return nil if seed.empty?
 
+      validate_seed(seed)
+
       MoneyTree::Master.new(seed_hex: seed)
     end
 
     def address_path_prefix
-      # TODO: Add support for other networks.
+      # TODO: Push this logic to the backend.
       @address_path_prefix ||= case network_id.to_s.split('_').first
-                               when 'base'
+                               when 'base', 'ethereum'
                                  "m/44'/60'/0'/0"
                                else
                                  raise ArgumentError, "Unsupported network ID: #{network_id}"
                                end
     end
 
-    # Derives the registered Addresses in the Wallet.
-    # @param address_models [Array<Coinbase::Client::Address>] The models of the addresses already registered with the
-    #   Wallet
-    def derive_addresses(address_models)
-      return unless address_models.any?
-
-      # Create a map tracking which addresses are already registered with the Wallet.
-      address_map = build_address_map(address_models)
-
-      address_models.each do |address_model|
-        # Derive the addresses using the provided models.
-        derive_address(address_map, address_model)
-      end
-    end
-
-    # Derives an already registered Address in the Wallet.
-    # @param address_map [Hash<String, Boolean>] The map of registered Address IDs
-    # @param address_model [Coinbase::Client::Address] The Address model
-    # @return [Address] The new Address
-    def derive_address(address_map, address_model)
-      key = @master.nil? ? nil : derive_key
-
-      unless key.nil?
-        address_from_key = key.address.to_s
-        raise 'Invalid address' if address_map[address_from_key].nil?
-      end
-
-      cache_address(address_model, key)
-    end
-
-    # Derives a key for an already registered Address in the Wallet.
+    # Derives a key for the given address index.
     # @return [Eth::Key] The new key
-    def derive_key
+    def derive_key(index)
       raise 'Cannot derive key for Wallet without seed loaded' if @master.nil?
 
-      path = "#{address_path_prefix}/#{@private_key_index}"
+      path = "#{address_path_prefix}/#{index}"
       private_key = @master.node_for_path(path).private_key.to_hex
-      @private_key_index += 1
-      Eth::Key.new(priv: private_key)
-    end
-
-    # Caches an Address on the client-side and increments the address index.
-    # @param address_model [Coinbase::Client::Address] The Address model
-    # @param key [Eth::Key] The private key of the Address
-    # @return [Address] The new Address
-    def cache_address(address_model, key)
-      address = Address.new(address_model, key)
-      @addresses << address
-      address
-    end
 
-    # Builds a Hash of the registered Addresses.
-    # @param address_models [Array<Coinbase::Client::Address>] The models of the addresses already registered with the
-    #   Wallet
-    # @return [Hash<String, Boolean>] The Hash of registered Addresses
-    def build_address_map(address_models)
-      address_map = {}
-      address_models.each do |address_model|
-        address_map[address_model.address_id] = true
-      end
-
-      address_map
+      Eth::Key.new(priv: private_key)
     end
 
     # Creates an attestation for the Address currently being created.
@@ -520,16 +511,9 @@ module Coinbase
 
     # Validates the seed and address models passed to the constructor.
     # @param seed [String] The seed to use for the Wallet
-    # @param address_models [Array<Coinbase::Client::Address>] The models of the addresses already registered with the
-    #   Wallet
-    def validate_seed_and_address_models(seed, address_models)
-      raise ArgumentError, 'Seed must be 32 bytes' if !seed.nil? && !seed.empty? && seed.length != 64
-
-      raise ArgumentError, 'Seed must be present if address_models are provided' if seed.nil? && address_models.any?
-
-      return unless !seed.nil? && seed.empty? && address_models.empty?
-
-      raise ArgumentError, 'Seed must be empty if address_models are not provided'
+    # @raise [ArgumentError] If the seed is invalid
+    def validate_seed(seed)
+      raise ArgumentError, 'Seed must be 32 bytes' unless seed.length == 64
     end
 
     # Loads the Hash of Wallet seeds from the given file.
@@ -551,6 +535,17 @@ module Coinbase
       pk.dh_compute_key(public_key)
     end
 
+    def build_wallet_address(address_model, index)
+      # Return an unhydrated wallet address is no master seed is set.
+      return WalletAddress.new(address_model, nil) if @master.nil?
+
+      key = derive_key(index)
+
+      raise StandardError, 'Seed does not match wallet' unless address_model.address_id == key.address.to_s
+
+      WalletAddress.new(address_model, key)
+    end
+
     def addresses_api
       @addresses_api ||= Coinbase::Client::AddressesApi.new(Coinbase.configuration.api_client)
     end

data/lib/coinbase.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative 'coinbase/address'
+require_relative 'coinbase/address/wallet_address'
+require_relative 'coinbase/address/external_address'
 require_relative 'coinbase/asset'
 require_relative 'coinbase/authenticator'
 require_relative 'coinbase/balance'
@@ -11,12 +13,15 @@ require_relative 'coinbase/errors'
 require_relative 'coinbase/faucet_transaction'
 require_relative 'coinbase/middleware'
 require_relative 'coinbase/network'
+require_relative 'coinbase/pagination'
 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_relative 'coinbase/staking_operation'
+require_relative 'coinbase/staking_reward'
 require 'json'
 
 # The Coinbase SDK.
@@ -55,13 +60,10 @@ module Coinbase
 
   # Configuration object for the Coinbase SDK.
   class Configuration
-    attr_reader :base_sepolia_rpc_url, :base_sepolia_client
     attr_accessor :api_url, :api_key_name, :api_key_private_key, :debug_api, :use_server_signer
 
     # Initializes the configuration object.
     def initialize
-      @base_sepolia_rpc_url = 'https://sepolia.base.org'
-      @base_sepolia_client = Jimson::Client.new(@base_sepolia_rpc_url)
       @api_url = 'https://api.cdp.coinbase.com'
       @debug_api = false
       @use_server_signer = false
@@ -82,13 +84,6 @@ module Coinbase
       @api_key_private_key = data['privateKey']
     end
 
-    # Sets the Base Sepolia RPC URL.
-    # @param new_base_sepolia_rpc_url [String] the new Base Sepolia RPC URL
-    def base_sepolia_rpc_url=(new_base_sepolia_rpc_url)
-      @base_sepolia_rpc_url = new_base_sepolia_rpc_url
-      @base_sepolia_client = Jimson::Client.new(@base_sepolia_rpc_url)
-    end
-
     # Returns the API client.
     # @return [Coinbase::Client::ApiClient] the API client
     def api_client
@@ -109,6 +104,13 @@ module Coinbase
     value.to_s.gsub('-', '_').to_sym
   end
 
+  # Converts a network symbol to a string, replacing underscores with hyphens.
+  # @param network_sym [Symbol] the network symbol to convert
+  # @return [String] the converted string
+  def self.normalize_network(network_sym)
+    network_sym.to_s.gsub(/_/, '-')
+  end
+
   # Loads the default user.
   # @return [Coinbase::User] the default user
   def self.load_default_user
@@ -122,7 +124,7 @@ module Coinbase
   def self.call_api
     yield
   rescue Coinbase::Client::ApiError => e
-    raise Coinbase::APIError.from_error(e)
+    raise Coinbase::APIError.from_error(e), cause: nil
   rescue StandardError => e
     raise e
   end
@@ -132,4 +134,10 @@ module Coinbase
   def self.use_server_signer?
     Coinbase.configuration.use_server_signer
   end
+
+  # Returns whether the SDK is configured.
+  # @return [bool] whether the SDK is configured
+  def self.configured?
+    !Coinbase.configuration.api_key_name.nil? && !Coinbase.configuration.api_key_private_key.nil?
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinbase-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Yuga Cohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: jimson
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -242,12 +228,16 @@ extra_rdoc_files: []
 files:
 - lib/coinbase.rb
 - lib/coinbase/address.rb
+- lib/coinbase/address/external_address.rb
+- lib/coinbase/address/wallet_address.rb
 - lib/coinbase/asset.rb
 - lib/coinbase/authenticator.rb
 - lib/coinbase/balance.rb
 - lib/coinbase/balance_map.rb
 - lib/coinbase/client.rb
 - lib/coinbase/client/api/addresses_api.rb
+- lib/coinbase/client/api/assets_api.rb
+- lib/coinbase/client/api/external_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
@@ -274,7 +264,10 @@ files:
 - 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/fetch_staking_rewards200_response.rb
+- lib/coinbase/client/models/fetch_staking_rewards_request.rb
+- lib/coinbase/client/models/get_staking_context_request.rb
+- lib/coinbase/client/models/partial_eth_staking_context.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
@@ -284,7 +277,11 @@ files:
 - 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_context.rb
+- lib/coinbase/client/models/staking_context_context.rb
 - lib/coinbase/client/models/staking_operation.rb
+- lib/coinbase/client/models/staking_reward.rb
+- lib/coinbase/client/models/staking_reward_format.rb
 - lib/coinbase/client/models/trade.rb
 - lib/coinbase/client/models/trade_list.rb
 - lib/coinbase/client/models/transaction.rb
@@ -300,7 +297,10 @@ files:
 - lib/coinbase/faucet_transaction.rb
 - lib/coinbase/middleware.rb
 - lib/coinbase/network.rb
+- lib/coinbase/pagination.rb
 - lib/coinbase/server_signer.rb
+- lib/coinbase/staking_operation.rb
+- lib/coinbase/staking_reward.rb
 - lib/coinbase/trade.rb
 - lib/coinbase/transaction.rb
 - lib/coinbase/transfer.rb