solace 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6a955af361ac7765d33c34560a09704730c8a394cd74e0bc17196d8cf3cb8eb
-  data.tar.gz: 3c86565b3f728bdd4b116dff1abc63125d187b2cc6d8b5fcb44c8444c2d15def
+  metadata.gz: c814d4aef33915cc30202d32adf427a92cdf3ef5878903bbe0105a8b2c6c21b2
+  data.tar.gz: 4710f8beef3e275de441bc6d4eafaae1d684abb9773a342de481bbbc927bd7b1
 SHA512:
-  metadata.gz: 489042853cdc2ca68d2e35abab66c26bb1363e9ae31fa9816203b6c267d9083361a006cc73610467581ed179999317f0fefc0b09460497d1ac6f10dcb273b5c2
-  data.tar.gz: bc66a1d998abf224a30365e44ea026b034437cbdc3cf09092bf45147510bf010d8d97178047ee485f088255d86a928a58a752694aa813595e5622d6bd66d1310
+  metadata.gz: 6beec23916e82507f1f2c0c7f81c351709ccc277d628676992530fb6604842447d25c3fbef034077946b6982bdb871e5d0000a58d865ebe1680426fc22c594c3
+  data.tar.gz: 7fc57c0668cf6bdfd62785de961bb34d819de718430ec954848cade2d6c53107d93d20e9925a2237f379637058b129ad579e7c85b04d3b611eb440a7b77f5c29

data/CHANGELOG

@@ -16,6 +16,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 ### Fixed
 ```
 
+## [0.0.7] - 2025-08-09
+  
+### Added
+1. Added `AssociatedTokenAccountProgramCreateAccountComposer` with tests.
+
+### Changed
+1. Updated `AssociatedTokenAccount` to use `AssociatedTokenAccountProgramCreateAccountComposer` and sign the transaction in the `create_associated_token_account` method instead of the `prepare_create_associated_token_account` method.
+ 
+### Fixed
+
 ## [0.0.6] - 2025-08-07
   
 ### Added

data/lib/solace/composers/associated_token_account_program_create_account_composer.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Solace
+  module Composers
+    # Composer for creating an associated token account program create account instruction
+    #
+    # This composer resolves and orders the required accounts for a `CreateAssociatedTokenAccount` instruction,
+    # sets up their access permissions, and delegates construction to the appropriate
+    # instruction builder (`Instructions::AssociatedTokenAccount::CreateAssociatedTokenAccountInstruction`).
+    #
+    # Required accounts:
+    # - **Funder**: the account that will pay for fees and rent.
+    # - **Owner**: the account that will own the new ATA.
+    # - **ATA**: the address of the new ATA.
+    # - **Mint**: the mint address of the token.
+    # - **System Program**: the system program id.
+    # - **Token Program**: the token program id.
+    # - **Associated Token Account Program**: the associated token account program id.
+    #
+    # @example Compose and build a create account instruction
+    #   composer = AssociatedTokenAccountProgramCreateAccountComposer.new(
+    #     funder: funder_address,
+    #     owner: owner_address,
+    #     ata_address: ata_address,
+    #     mint: mint_address
+    #   )
+    #
+    # @see Instructions::AssociatedTokenAccount::CreateAssociatedTokenAccountInstruction
+    # @since 0.0.7
+    class AssociatedTokenAccountProgramCreateAccountComposer < Base
+      # Extracts the owner address from the params
+      #
+      # @return [String] The owner address
+      def owner
+        params[:owner].is_a?(String) ? params[:owner] : params[:owner].address
+      end
+
+      # Extracts the mint address from the params
+      #
+      # @return [String] The mint address
+      def mint
+        params[:mint].is_a?(String) ? params[:mint] : params[:mint].address
+      end
+
+      # Extracts the ata_address from the params
+      #
+      # @return [String] The ata_address
+      def ata_address
+        params[:ata_address].is_a?(String) ? params[:ata_address] : params[:ata_address].address
+      end
+
+      # Extracts the funder address from the params
+      #
+      # @return [String] The funder address
+      def funder
+        params[:funder].is_a?(String) ? params[:funder] : params[:funder].address
+      end
+
+      # Extracts the system program id from the constants
+      #
+      # @return [String] The system program id
+      def system_program_id
+        Constants::SYSTEM_PROGRAM_ID
+      end
+
+      # Extracts the token program id from the constants
+      #
+      # @return [String] The token program id
+      def token_program_id
+        Constants::TOKEN_PROGRAM_ID
+      end
+
+      # Extracts the associated token account program id from the constants
+      #
+      # @return [String] The associated token account program id
+      def associated_token_account_program_id
+        Constants::ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID
+      end
+
+      # Setup accounts required for associated token account program create account instruction
+      # Called automatically during initialization
+      #
+      # @return [void]
+      def setup_accounts # rubocop:disable Metrics/AbcSize
+        account_context.add_writable_signer(funder)
+        account_context.add_writable_nonsigner(ata_address)
+        account_context.add_readonly_nonsigner(owner)
+        account_context.add_readonly_nonsigner(mint)
+        account_context.add_readonly_nonsigner(system_program_id)
+        account_context.add_readonly_nonsigner(token_program_id)
+        account_context.add_readonly_nonsigner(associated_token_account_program_id)
+      end
+
+      # Builds the instruction for the associated token account program create account instruction
+      #
+      # @param account_context [Utils::AccountContext] The account context
+      # @return [Solace::Instruction] The instruction
+      def build_instruction(account_context)
+        Instructions::AssociatedTokenAccount::CreateAssociatedTokenAccountInstruction.build(
+          funder_index: account_context.index_of(funder),
+          owner_index: account_context.index_of(owner),
+          mint_index: account_context.index_of(mint),
+          associated_token_account_index: account_context.index_of(ata_address),
+          system_program_index: account_context.index_of(system_program_id),
+          token_program_index: account_context.index_of(token_program_id),
+          program_index: account_context.index_of(associated_token_account_program_id)
+        )
+      end
+    end
+  end
+end

data/lib/solace/programs/associated_token_account.rb

@@ -51,7 +51,7 @@ module Solace
 
       # Alias method for get_address
       #
-      # @option options [Hash] A hash of options for the get_address class method
+      # @param options [Hash] A hash of options for the get_address class method
       # @return [Array<String, Integer>] The address of the associated token account and the bump seed
       def get_address(**options)
         self.class.get_address(**options)
@@ -67,9 +67,9 @@ module Solace
       def get_or_create_address(payer:, owner:, mint:, commitment: 'confirmed')
         ata_address, _bump = get_address(owner: owner, mint: mint)
 
-        account_info = @connection.get_account_info(ata_address)
+        account_balance = @connection.get_balance(ata_address)
 
-        return ata_address if account_info
+        return ata_address if account_balance
 
         response = create_associated_token_account(payer: payer, owner: owner, mint: mint)
 
@@ -87,6 +87,8 @@ module Solace
       def create_associated_token_account(**options)
         tx = prepare_create_associated_token_account(**options)
 
+        tx.sign(options[:payer])
+
         @connection.send_transaction(tx.serialize)
       end
 
@@ -97,7 +99,6 @@ module Solace
       # @param payer [Solace::Keypair] The keypair that will pay for fees and rent.
       # @return [Solace::Transaction] The signed transaction.
       #
-      # rubocop:disable Metrics/MethodLength
       def prepare_create_associated_token_account(
         payer:,
         owner:,
@@ -105,39 +106,21 @@ module Solace
       )
         ata_address, = get_address(owner: owner, mint: mint)
 
-        accounts = [
-          payer.address,
-          ata_address,
-          owner.address,
-          mint.address,
-          Solace::Constants::SYSTEM_PROGRAM_ID,
-          Solace::Constants::TOKEN_PROGRAM_ID,
-          Solace::Constants::ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID
-        ]
-
-        instruction = Solace::Instructions::AssociatedTokenAccount::CreateAssociatedTokenAccountInstruction.build(
-          funder_index: 0,
-          associated_token_account_index: 1,
-          owner_index: 2,
-          mint_index: 3,
-          system_program_index: 4,
-          token_program_index: 5,
-          program_index: 6
-        )
-
-        message = Solace::Message.new(
-          header: [1, 0, 4],
-          accounts: accounts,
-          recent_blockhash: @connection.get_latest_blockhash,
-          instructions: [instruction]
-        )
-
-        tx = Solace::Transaction.new(message: message)
-        tx.sign(payer)
-
-        tx
+        TransactionComposer.new(connection: connection).try do |tx_composer|
+          tx_composer.set_fee_payer(payer)
+
+          tx_composer.add_instruction(
+            Solace::Composers::AssociatedTokenAccountProgramCreateAccountComposer.new(
+              mint: mint,
+              owner: owner,
+              funder: payer,
+              ata_address: ata_address
+            )
+          )
+
+          tx_composer.compose_transaction
+        end
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/solace/public_key.rb

@@ -103,7 +103,10 @@ module Solace
       #   pubkey = Solace::PublicKey.from_address(address)
       #
       # @param address [String] The base58 address of the public key
-      # @return [PublicKey]
+      # @return [PublicKey] The public key instance
+      # @raise [ArgumentError] If the address is not a valid base58 string
+      #
+      # @since 0.0.6
       def from_address(address)
         new(Solace::Utils::Codecs.base58_to_bytes(address))
       end

data/lib/solace/version.rb

@@ -2,5 +2,5 @@
 
 # Solace::VERSION is the version of the Solace gem
 module Solace
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/solace.rb

@@ -25,9 +25,13 @@ require_relative 'solace/instruction'
 require_relative 'solace/address_lookup_table'
 require_relative 'solace/transaction_composer'
 
-# 📦 Composers (Builders)
+# Base Classes (Abstract classes)
+require_relative 'solace/programs/base'
+require_relative 'solace/composers/base'
+
+# 📦 Composers
 #
-# Glob require all instructions
+# Glob require all composers
 Dir[File.join(__dir__, 'solace/composers', '**', '*.rb')].each { |file| require file }
 
 # 📦 Instructions (Builders)
@@ -36,6 +40,5 @@ Dir[File.join(__dir__, 'solace/composers', '**', '*.rb')].each { |file| require
 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.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Sebastian Scholl
@@ -93,6 +93,7 @@ files:
 - README.md
 - lib/solace.rb
 - lib/solace/address_lookup_table.rb
+- lib/solace/composers/associated_token_account_program_create_account_composer.rb
 - lib/solace/composers/base.rb
 - lib/solace/composers/spl_token_program_transfer_checked_composer.rb
 - lib/solace/composers/system_program_transfer_composer.rb