solace 0.0.2 → 0.0.5

data/lib/solace/utils/pda.rb

@@ -5,27 +5,34 @@ require 'digest'
 
 module Solace
   module Utils
+    # Module for generating program addresses
+    #
+    # This module provides methods for generating program addresses from seeds and program IDs. It interfaces
+    # with the Curve25519 Dalek library to check if a point is on the curve. It also provides a method for
+    # converting seeds to bytes and a method for checking if a string looks like a base58 address.
+    #
+    # @see Solace::Utils::Curve25519Dalek
+    # @since 0.0.1
     module PDA
-      # !@class InvalidPDAError
-      #   An error raised when an invalid PDA is generated
-      #
-      # @return [StandardError]
+      # InvalidPDAError is an error raised when an invalid PDA is generated
       class InvalidPDAError < StandardError; end
 
-      # !@const PDA_MARKER
-      #   The marker used in PDA calculations
-      #
-      # @return [String]
+      # !@attribute PDA_MARKER
+      # PDA_MARKER is the marker used in PDA calculations
       PDA_MARKER = 'ProgramDerivedAddress'
 
-      # !@const MAX_BUMP_SEED
-      #   The maximum seed value for PDA calculations
-      #
-      # @return [Integer]
+      # !@attribute MAX_BUMP_SEED
+      # The maximum seed value for PDA calculations
       MAX_BUMP_SEED = 255
 
       # Finds a valid program address by trying different seeds
       #
+      # @example Find a PDA with bump seed
+      #   seeds = ['metadata', mint_address, 'edition']
+      #   program_id = 'metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s'
+      #
+      #   address, bump = Solace::Utils::PDA.find_program_address(seeds, program_id)
+      #
       # @param seeds [Array] The seeds to use in the calculation
       # @param program_id [String] The program ID to use in the calculation
       # @return [Array] The program address and bump seed
@@ -68,17 +75,9 @@ module Solace
       def self.seed_to_bytes(seed)
         case seed
         when String
-          if looks_like_base58_address?(seed)
-            Solace::Utils::Codecs.base58_to_bytes(seed)
-          else
-            seed.bytes
-          end
+          looks_like_base58_address?(seed) ? Solace::Utils::Codecs.base58_to_bytes(seed) : seed.bytes
         when Integer
-          if seed.between?(0, 255)
-            [seed]
-          else
-            seed.digits(256)
-          end
+          seed.between?(0, 255) ? [seed] : seed.digits(256)
         when Array
           seed
         else
@@ -91,8 +90,7 @@ module Solace
       # @param string [String] The string to check
       # @return [Boolean] True if the string looks like a base58 address, false otherwise
       def self.looks_like_base58_address?(string)
-        string.length >= 32 &&
-          string.length <= 44 &&
+        string.length.between?(32, 44) &&
           Solace::Utils::Codecs.valid_base58?(string)
       end
     end

data/lib/solace/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Solace::VERSION is the version of the Solace gem
 module Solace
-  VERSION = '0.0.2'
+  VERSION = '0.0.5'
 end

data/lib/solace.rb

@@ -8,17 +8,14 @@ require_relative 'solace/constants'
 require_relative 'solace/connection'
 require_relative 'solace/utils/codecs'
 require_relative 'solace/utils/pda'
+require_relative 'solace/utils/account_context'
 require_relative 'solace/utils/curve25519_dalek'
 require_relative 'solace/concerns/binary_serializable'
 
 # ✨ Serializers
-require_relative 'solace/serializers/base'
 require_relative 'solace/serializers/base_serializer'
 require_relative 'solace/serializers/base_deserializer'
 
-# Base classes
-require_relative 'solace/serializable_record'
-
 # 🧬 Primitives
 require_relative 'solace/keypair'
 require_relative 'solace/public_key'
@@ -26,14 +23,19 @@ require_relative 'solace/transaction'
 require_relative 'solace/message'
 require_relative 'solace/instruction'
 require_relative 'solace/address_lookup_table'
+require_relative 'solace/transaction_composer'
+
+# 📦 Composers (Builders)
+#
+# Glob require all instructions
+Dir[File.join(__dir__, 'solace/composers', '**', '*.rb')].each { |file| require file }
 
 # 📦 Instructions (Builders)
-# 
+#
 # Glob require all instructions
-Dir[File.join(__dir__, 'solace/instructions', '**', '*.rb')].sort.each { |file| require file }
+Dir[File.join(__dir__, 'solace/instructions', '**', '*.rb')].each { |file| require file }
 
 # 📦 Programs
 require_relative 'solace/programs/base'
 require_relative 'solace/programs/spl_token'
 require_relative 'solace/programs/associated_token_account'
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solace
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Sebastian Scholl
@@ -52,38 +52,38 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.0'
 description: A Ruby library for working with Solana blockchain. Provides both low-level
   instruction builders and high-level program clients for interacting with Solana
   programs.
 email:
-- sebastian@scholl.io
+- sebscholl@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -93,6 +93,9 @@ files:
 - README.md
 - lib/solace.rb
 - lib/solace/address_lookup_table.rb
+- lib/solace/composers/base.rb
+- lib/solace/composers/spl_token_program_transfer_checked_composer.rb
+- lib/solace/composers/system_program_transfer_composer.rb
 - lib/solace/concerns/binary_serializable.rb
 - lib/solace/connection.rb
 - lib/solace/constants.rb
@@ -101,20 +104,18 @@ files:
 - lib/solace/instructions/spl_token/initialize_account_instruction.rb
 - lib/solace/instructions/spl_token/initialize_mint_instruction.rb
 - lib/solace/instructions/spl_token/mint_to_instruction.rb
+- lib/solace/instructions/spl_token/transfer_checked_instruction.rb
 - lib/solace/instructions/spl_token/transfer_instruction.rb
 - lib/solace/instructions/system_program/create_account_instruction.rb
-- lib/solace/instructions/transfer_checked_instruction.rb
-- lib/solace/instructions/transfer_instruction.rb
+- lib/solace/instructions/system_program/transfer_instruction.rb
 - lib/solace/keypair.rb
 - lib/solace/message.rb
 - lib/solace/programs/associated_token_account.rb
 - lib/solace/programs/base.rb
 - lib/solace/programs/spl_token.rb
 - lib/solace/public_key.rb
-- lib/solace/serializable_record.rb
 - lib/solace/serializers/address_lookup_table_deserializer.rb
 - lib/solace/serializers/address_lookup_table_serializer.rb
-- lib/solace/serializers/base.rb
 - lib/solace/serializers/base_deserializer.rb
 - lib/solace/serializers/base_serializer.rb
 - lib/solace/serializers/instruction_deserializer.rb
@@ -124,6 +125,8 @@ files:
 - lib/solace/serializers/transaction_deserializer.rb
 - lib/solace/serializers/transaction_serializer.rb
 - lib/solace/transaction.rb
+- lib/solace/transaction_composer.rb
+- lib/solace/utils/account_context.rb
 - lib/solace/utils/codecs.rb
 - lib/solace/utils/curve25519_dalek.rb
 - lib/solace/utils/libcurve25519_dalek-linux/libcurve25519_dalek.so

data/lib/solace/instructions/transfer_checked_instruction.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Solace
-  module Instructions
-    # Service object for building an SPL Token Program transfer instruction
-    class TransferCheckedInstruction
-      # SPL Token Program instruction index for Transfer Checked
-      INSTRUCTION_INDEX = [12].freeze
-
-      # Builds a Solace::Instruction for transferring SPL tokens
-      #
-      # SPL Token Program transfer instruction layout:
-      #   - 1 byte: instruction index (12 for transfer checked)
-      #   - 8 bytes: amount (u64, little-endian)
-      #   - 8 bytes: decimals (u64, little-endian)
-      #
-      # @param amount [Integer] Amount to transfer (in tokens, according to mint's decimals)
-      # @param decimals [Integer] Number of decimals for the token
-      # @param to_index [Integer] Index of the destination token account in the transaction's accounts
-      # @param from_index [Integer] Index of the source token account in the transaction's accounts
-      # @param mint_index [Integer] Index of the mint in the transaction's accounts
-      # @param authority_index [Integer] Index of the authority (owner) in the transaction's accounts
-      # @param program_index [Integer] Index of the SPL Token Program in the transaction's accounts (default: 3)
-      # @return [Solace::Instruction]
-      def self.build(
-        amount:,
-        decimals:,
-        to_index:,
-        from_index:,
-        mint_index:,
-        authority_index:,
-        program_index: 3
-      )
-        Solace::Instruction.new.tap do |ix|
-          ix.program_index = program_index
-          ix.accounts = [from_index, mint_index, to_index, authority_index]
-          ix.data = data(amount, decimals)
-        end
-      end
-
-      # Instruction data for a token transfer instruction
-      #
-      # The BufferLayout is:
-      #   - [Instruction Index (1 byte)]
-      #   - [Amount (8 bytes little-endian u64)]
-      #   - [Decimals (8 bytes little-endian u64)]
-      #
-      # @param amount [Integer] Amount to transfer
-      # @param decimals [Integer] Number of decimals for the token
-      # @return [Array] 1-byte instruction index + 8-byte amount + decimals
-      def self.data(amount, decimals)
-        INSTRUCTION_INDEX +
-          Solace::Utils::Codecs.encode_le_u64(amount).bytes +
-          [decimals]
-      end
-    end
-  end
-end

data/lib/solace/instructions/transfer_instruction.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Solace
-  module Instructions
-    # Service object for building a System Program transfer instruction
-    class TransferInstruction
-      # Instruction ID for System Transfer
-      INSTRUCTION_ID = [2, 0, 0, 0].freeze
-
-      # Builds a Solace::Instruction for transferring SOL
-      #
-      # System Program transfer instruction layout:
-      #   - 4 bytes: instruction index (0 for transfer)
-      #   - 8 bytes: amount (u64, little-endian)
-      #
-      # @param lamports [Integer] Amount to transfer (in lamports)
-      # @param to_index [Integer] Index of the recipient in the transaction's accounts
-      # @param from_index [Integer] Index of the sender in the transaction's accounts
-      # @param program_index [Integer] Index of the program in the transaction's accounts (default: 2)
-      # @return [Solace::Instruction]
-      def self.build(
-        lamports:,
-        to_index:,
-        from_index:,
-        program_index: 2
-      )
-        Solace::Instruction.new.tap do |ix|
-          ix.program_index = program_index
-          ix.accounts = [from_index, to_index]
-          ix.data = data(lamports)
-        end
-      end
-
-      # Instruction data for a transfer instruction
-      #
-      # The BufferLayout is:
-      #   - [Instruction ID (4 bytes)]
-      #   - [Amount (8 bytes little-endian u64)]
-      #
-      # @param lamports [Integer] Amount to transfer (in lamports)
-      # @return [Array] 4-byte instruction ID + 8-byte amount
-      def self.data(lamports)
-        INSTRUCTION_ID +
-          Solace::Utils::Codecs.encode_le_u64(lamports).bytes
-      end
-    end
-  end
-end

data/lib/solace/serializable_record.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Solace
-  class SerializableRecord
-    include Solace::Concerns::BinarySerializable
-
-    # Parse instruction from io stream
-    #
-    # @param io [IO or StringIO] The input to read bytes from.
-    # @return [Solace::Instruction] Parsed instruction object
-    def self.deserialize(io)
-      self::DESERIALIZER.call(io)
-    rescue NameError => e
-      raise "DESERIALIZER must be defined: #{e.message}"
-    end
-
-    # Serializes the transaction to a binary format
-    #
-    # @return [String] The serialized transaction (binary)
-    def serialize
-      self.class::SERIALIZER.call(self)
-    rescue NameError => e
-      raise "SERIALIZER must be defined: #{e.message}"
-    end
-  end
-end

data/lib/solace/serializers/base.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Solace
-  module Serializers
-    class Base
-      include Solace::Utils
-
-      # Proxy method to call the serializer and create a new instance
-      #
-      # @return [String] The serialized record (base64)
-      def self.call(*args, **kwargs)
-        new(*args, **kwargs).call
-      end
-
-      # Serializes the record
-      #
-      # @return [String] The serialized record (base64)
-      def call
-        bin = self.class::STEPS
-              .map { |m| send(m) }
-              .flatten
-              .compact
-              .pack('C*')
-
-        Base64.strict_encode64(bin)
-      rescue NameError => e
-        raise "STEPS must be defined: #{e.message}"
-      end
-    end
-  end
-end