coinbase-sdk 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4413913708fadc44dcbb49a00a72fe55382187c8084531b9cec43894e0ee9a0
-  data.tar.gz: e47f6295ce5f8bc1d8888b49ba71cdbc1558d606e708e66452f0ae6a76127249
+  metadata.gz: 98cd32134ee8acb14c9dc018f39e7af188646b546998c4182cd50d7ae75f2816
+  data.tar.gz: df6ff19c63798ec10f054972aa75edef79fe65ae39c93cbe0941c77db251e5d6
 SHA512:
-  metadata.gz: acb6233add651f82063b7f2a73da8b7a8112687603d61fb77f3160713d813ea07447e25b5b69e83dd81c1852478c1b9999c1b207c9137ae08868db495721181b
-  data.tar.gz: 3b72b12e92386e7114e0146f257032b904a4f26a2a97369bff19c1bc722b195372c830a2bb405e1a2f2655c81608beeee8d601deab293f87c1adf5fb18ca64e9
+  metadata.gz: a209d25aa72fc185fb667a5ef7b8de617341dba449b0a02b15ad95bc0c434140932353e12258f4665b35ef60e37b5346efca76db811cc5a308cfc69b907f37b8
+  data.tar.gz: 8856f048ea3ecb664559665e2422d60b6c12d607526aea4bea75f8e8273cf0584b2206e14dcb4e99bdca3436114b03961558be36029b40614d018028f9d41183

data/lib/coinbase/address.rb

@@ -15,7 +15,7 @@ module Coinbase
     # Returns a new Address object. Do not use this method directly. Instead, use Wallet#create_address, or use
     # the Wallet's default_address.
     # @param model [Coinbase::Client::Address] The underlying Address object
-    # @param key [Eth::Key] The key backing the Address
+    # @param key [Eth::Key] The key backing the Address. Can be nil.
     def initialize(model, key)
       @model = model
       @key = key
@@ -39,6 +39,14 @@ module Coinbase
       @model.address_id
     end
 
+    # Sets the private key backing the Address. This key is used to sign transactions.
+    # @param key [Eth::Key] The key backing the Address
+    def key=(key)
+      raise 'Private key is already set' unless @key.nil?
+
+      @key = key
+    end
+
     # Returns the balances of the Address.
     # @return [BalanceMap] The balances of the Address, keyed by asset ID. Ether balances are denominated
     #  in ETH.
@@ -70,6 +78,8 @@ module Coinbase
     #  default address. If a String, interprets it as the address ID.
     # @return [String] The hash of the Transfer transaction.
     def transfer(amount, asset_id, destination)
+      raise 'Cannot transfer from address without private key loaded' if @key.nil?
+
       raise ArgumentError, "Unsupported asset: #{asset_id}" unless Coinbase::Asset.supported?(asset_id)
 
       if destination.is_a?(Wallet)
@@ -116,6 +126,12 @@ module Coinbase
       Coinbase::Transfer.new(transfer_model)
     end
 
+    # Returns whether the Address has a private key backing it to sign transactions.
+    # @return [Boolean] Whether the Address has a private key backing it to sign transactions.
+    def can_sign?
+      !@key.nil?
+    end
+
     # Returns a String representation of the Address.
     # @return [String] a String representation of the Address
     def to_s
@@ -142,6 +158,8 @@ module Coinbase
     # Exports the Address's private key to a hex string.
     # @return [String] The Address's private key as a hex String
     def export
+      raise 'Cannot export key without private key loaded' if @key.nil?
+
       @key.private_hex
     end
 

data/lib/coinbase/balance.rb

@@ -25,12 +25,10 @@ module Coinbase
       )
     end
 
-    # Returns a new Asset object. Do not use this method. Instead, use the Asset constants defined in
-    # the Coinbase module.
-    # @param network_id [Symbol] The ID of the Network to which the Asset belongs
+    # Returns a new Balance object. Do not use this method. Instead, use Balance.from_model or
+    # Balance.from_model_and_asset_id.
+    # @param amount [BigDecimal] The amount of the Asset
     # @param asset_id [Symbol] The Asset ID
-    # @param display_name [String] The Asset's display name
-    # @param address_id [String] (Optional) The Asset's address ID, if one exists
     def initialize(amount:, asset_id:)
       @amount = amount
       @asset_id = asset_id

data/lib/coinbase/balance_map.rb

@@ -27,21 +27,21 @@ module Coinbase
     end
 
     # Returns a string representation of the balance map.
-    # @return [String] The string representation of the balance
+    # @return [String] The string representation of the balance map
     def to_s
       to_string
     end
 
     # Returns a string representation of the balance map.
-    # @return [String] The string representation of the balance
+    # @return [String] The string representation of the balance map
     def inspect
       to_string
     end
 
     private
 
-    # Returns a string representation of the balance.
-    # @return [String] The string representation of the balance
+    # Returns a string representation of the balance map.
+    # @return [String] The string representation of the balance map
     def to_string
       result = {}
 

data/lib/coinbase/middleware.rb

@@ -12,8 +12,11 @@ module Coinbase
     # Returns the default middleware configuration for the Coinbase SDK.
     def self.config
       Coinbase::Client::Configuration.default.tap do |config|
+        uri = URI(Coinbase.configuration.api_url)
+
         config.debugging = Coinbase.configuration.debug_api
-        config.host = Coinbase.configuration.api_url
+        config.host = uri.host + (uri.port ? ":#{uri.port}" : '')
+        config.scheme = uri.scheme if uri.scheme
         config.request(:authenticator)
       end
     end

data/lib/coinbase/user.rb

@@ -20,21 +20,14 @@ module Coinbase
     end
 
     # Creates a new Wallet belonging to the User.
+    # @param network_id [String] (Optional) the ID of the blockchain network. Defaults to 'base-sepolia'.
     # @return [Coinbase::Wallet] the new Wallet
-    def create_wallet
-      create_wallet_request = {
-        wallet: {
-          # TODO: Don't hardcode this.
-          network_id: 'base-sepolia'
-        }
-      }
-      opts = { create_wallet_request: create_wallet_request }
-
-      model = Coinbase.call_api do
-        wallets_api.create_wallet(opts)
-      end
+    def create_wallet(create_wallet_options = {})
+      # For ruby 2.7 compatibility we cannot pass in keyword args when the create wallet
+      # options is empty
+      return Wallet.create if create_wallet_options.empty?
 
-      Wallet.new(model)
+      Wallet.create(**create_wallet_options)
     end
 
     # Imports a Wallet belonging to the User.
@@ -44,14 +37,35 @@ module Coinbase
       Wallet.import(data)
     end
 
-    # Lists the IDs of the Wallets belonging to the User.
-    # @return [Array<String>] the IDs of the Wallets belonging to the User
-    def wallet_ids
-      wallets = Coinbase.call_api do
-        wallets_api.list_wallets
+    # Lists the Wallets belonging to the User.
+    # @param page_size [Integer] (Optional) the number of Wallets to return per page. Defaults to 10
+    # @param next_page_token [String] (Optional) the token for the next page of Wallets
+    # @return [Coinbase::Wallet] the Wallets belonging to the User
+    def wallets(page_size: 10, next_page_token: nil)
+      opts = {
+        limit: page_size
+      }
+
+      opts[:page] = next_page_token unless next_page_token.nil?
+
+      wallet_list = Coinbase.call_api do
+        wallets_api.list_wallets(opts)
       end
 
-      wallets.data.map(&:id)
+      # A map from wallet_id to address models.
+      address_model_map = {}
+
+      wallet_list.data.each do |wallet_model|
+        addresses_list = Coinbase.call_api do
+          addresses_api.list_addresses(wallet_model.id, { limit: Coinbase::Wallet::MAX_ADDRESSES })
+        end
+
+        address_model_map[wallet_model.id] = addresses_list.data
+      end
+
+      wallet_list.data.map do |wallet_model|
+        Wallet.new(wallet_model, seed: '', address_models: address_model_map[wallet_model.id])
+      end
     end
 
     # Saves a wallet to local file system. Wallet saved this way can be re-instantiated with load_wallets_from_local

data/lib/coinbase/wallet.rb

@@ -12,7 +12,10 @@ module Coinbase
   # list their balances, and transfer Assets to other Addresses. Wallets should be created through User#create_wallet or
   # User#import_wallet.
   class Wallet
-    attr_reader :addresses
+    attr_reader :addresses, :model
+
+    # The maximum number of addresses in a Wallet.
+    MAX_ADDRESSES = 20
 
     class << self
       # Imports a Wallet from previously exported wallet data.
@@ -25,12 +28,32 @@ module Coinbase
           wallets_api.get_wallet(data.wallet_id)
         end
 
-        # TODO: Pass these addresses in directly
-        address_count = Coinbase.call_api do
-          addresses_api.list_addresses(model.id).total_count
+        address_list = Coinbase.call_api do
+          addresses_api.list_addresses(model.id, { limit: MAX_ADDRESSES })
         end
 
-        new(model, seed: data.seed, address_count: address_count)
+        new(model, seed: data.seed, address_models: address_list.data)
+      end
+
+      # Creates a new Wallet on the specified Network and generate a default address for it.
+      # @param network_id [String] (Optional) the ID of the blockchain network. Defaults to 'base-sepolia'.
+      # @return [Coinbase::Wallet] the new Wallet
+      def create(network_id: 'base-sepolia')
+        model = Coinbase.call_api do
+          wallets_api.create_wallet(
+            create_wallet_request: {
+              wallet: {
+                network_id: network_id
+              }
+            }
+          )
+        end
+
+        wallet = new(model)
+
+        wallet.create_address
+
+        wallet
       end
 
       private
@@ -49,31 +72,20 @@ module Coinbase
     # User#import_wallet.
     # @param model [Coinbase::Client::Wallet] The underlying Wallet object
     # @param seed [String] (Optional) The seed to use for the Wallet. Expects a 32-byte hexadecimal with no 0x prefix.
-    #   If not provided, a new seed will be generated.
-    # @param address_count [Integer] (Optional) The number of addresses already registered for the Wallet.
+    #   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_count: 0)
-      raise ArgumentError, 'Seed must be 32 bytes' if !seed.nil? && seed.length != 64
+    def initialize(model, seed: nil, address_models: [])
+      validate_seed_and_address_models(seed, address_models)
 
       @model = model
-
-      @master = seed.nil? ? MoneyTree::Master.new : MoneyTree::Master.new(seed_hex: seed)
-
-      # TODO: Make Network an argument to the constructor.
-      @network_id = :base_sepolia
+      @master = master_node(seed)
       @addresses = []
+      @private_key_index = 0
 
-      # TODO: Adjust derivation path prefix based on network protocol.
-      @address_path_prefix = "m/44'/60'/0'/0"
-      @address_index = 0
-
-      if address_count.positive?
-        address_count.times { derive_address }
-      else
-        create_address
-        # Update the model to reflect the new default address.
-        update_model
-      end
+      derive_addresses(address_models)
     end
 
     # Returns the Wallet ID.
@@ -88,6 +100,24 @@ module Coinbase
       Coinbase.to_sym(@model.network_id)
     end
 
+    # 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?
+
+      @master = MoneyTree::Master.new(seed_hex: seed)
+
+      @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?
+
+        a.key = key
+      end
+    end
+
     # Creates a new Address in the Wallet.
     # @return [Address] The new Address
     def create_address
@@ -105,13 +135,16 @@ module Coinbase
         addresses_api.create_address(id, opts)
       end
 
+      # Auto-reload wallet to set default address on first address creation.
+      reload if addresses.empty?
+
       cache_address(address_model, key)
     end
 
     # Returns the default address of the Wallet.
     # @return [Address] The default address
     def default_address
-      address(@model.default_address.address_id)
+      address(@model.default_address&.address_id)
     end
 
     # Returns the Address with the given ID.
@@ -153,11 +186,11 @@ module Coinbase
     # @return [Transfer] The hash of the Transfer transaction.
     def transfer(amount, asset_id, destination)
       if destination.is_a?(Wallet)
-        raise ArgumentError, 'Transfer must be on the same Network' if destination.network_id != @network_id
+        raise ArgumentError, 'Transfer must be on the same Network' if destination.network_id != network_id
 
         destination = destination.default_address.id
       elsif destination.is_a?(Address)
-        raise ArgumentError, 'Transfer must be on the same Network' if destination.network_id != @network_id
+        raise ArgumentError, 'Transfer must be on the same Network' if destination.network_id != network_id
 
         destination = destination.id
       end
@@ -168,6 +201,8 @@ module Coinbase
     # Exports the Wallet's data to a Data object.
     # @return [Data] The Wallet data
     def export
+      raise 'Cannot export Wallet without loaded seed' if @master.nil?
+
       Data.new(wallet_id: id, seed: @master.seed_hex)
     end
 
@@ -182,11 +217,17 @@ module Coinbase
       end
     end
 
+    # Returns whether the Wallet has a seed with which to derive keys and sign transactions.
+    # @return [Boolean] Whether the Wallet has a seed with which to derive keys and sign transactions.
+    def can_sign?
+      !@master.nil?
+    end
+
     # Returns a String representation of the Wallet.
     # @return [String] a String representation of the Wallet
     def to_s
       "Coinbase::Wallet{wallet_id: '#{id}', network_id: '#{network_id}', " \
-        "default_address: '#{default_address.id}'}"
+        "default_address: '#{@model.default_address&.address_id}'}"
     end
 
     # Same as to_s.
@@ -223,14 +264,55 @@ module Coinbase
 
     private
 
+    # Reloads the Wallet with the latest data.
+    def reload
+      @model = Coinbase.call_api do
+        wallets_api.get_wallet(id)
+      end
+    end
+
+    def master_node(seed)
+      return MoneyTree::Master.new if seed.nil?
+      return nil if seed.empty?
+
+      MoneyTree::Master.new(seed_hex: seed)
+    end
+
+    def address_path_prefix
+      # TODO: Add support for other networks.
+      @address_path_prefix ||= case network_id.to_s.split('_').first
+                               when 'base'
+                                 "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
-      key = derive_key
+    def derive_address(address_map, address_model)
+      key = @master.nil? ? nil : derive_key
 
-      address_id = key.address.to_s
-      address_model = Coinbase.call_api do
-        addresses_api.get_address(id, address_id)
+      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)
@@ -239,8 +321,11 @@ module Coinbase
     # Derives a key for an already registered Address in the Wallet.
     # @return [Eth::Key] The new key
     def derive_key
-      path = "#{@address_path_prefix}/#{@address_index}"
+      raise 'Cannot derive key for Wallet without seed loaded' if @master.nil?
+
+      path = "#{address_path_prefix}/#{@private_key_index}"
       private_key = @master.node_for_path(path).private_key.to_hex
+      @private_key_index += 1
       Eth::Key.new(priv: private_key)
     end
 
@@ -251,10 +336,22 @@ module Coinbase
     def cache_address(address_model, key)
       address = Address.new(address_model, key)
       @addresses << address
-      @address_index += 1
       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
+    end
+
     # Creates an attestation for the Address currently being created.
     # @param key [Eth::Key] The private key of the Address
     # @return [String] The attestation
@@ -279,11 +376,18 @@ module Coinbase
       new_signature_bytes.pack('C*').unpack1('H*')
     end
 
-    # Updates the Wallet model with the latest data.
-    def update_model
-      @model = Coinbase.call_api do
-        wallets_api.get_wallet(id)
-      end
+    # 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'
     end
 
     def addresses_api

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: coinbase-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Yuga Cohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-05-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  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: eth
   requirement: !ruby/object:Gem::Requirement