solace 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 844d1bceeb32ec4fb6758548f24c8a0b04b5ef534cd2d387b6146a7923ee2ca0
-  data.tar.gz: 4ea095f315b2feac568e5bf4361986b19fe951085050a13250f9e6e84065c51f
+  metadata.gz: 21862a029b8b0922fa42fd3798e86d11c69900255bb92a035c806d83a8c985c1
+  data.tar.gz: 10eb8a0433c9907b7e75a7a3bb71637f1e41f0012e7cb695afcb91f2115d3f3f
 SHA512:
-  metadata.gz: 166e17cb2a4fea1dac6e3497d064402bdce4477797d22f57f7812ee1faacf7ea9c77d94bbfa9172a4f1b92ceaacba2fef007ee0018d3ba4360ac568eefb3c3e8
-  data.tar.gz: cdf77b2bf7a7b813aefc1f80f6405a371ff82aad3448097b6030eb74028a770aac282697f128746dd001668171032524aa80906091cebfd871eea98335c1710d
+  metadata.gz: 813efcb0fae947ac7a93bb88d6984ca4b4369390b807d08eb11e9ff7d49b7742c53de1e2a9d0ffd6c2fd98b07dcd3cd8161e477ec91e9b0b5574ebdb54dd5ebc
+  data.tar.gz: a7a077c4af7e7379364bec45ef965eafcab28c58cca0588f9f2c0854a99bb5e4f5bf7a4262e4f5c64d57bd02f311c03bb98146b500e0d6a6621a528fe297a782

data/CHANGELOG

@@ -1,4 +1,5 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
@@ -9,6 +10,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 ## [VERSION] - yyyy-mm-dd
 
 ### Added
+
 1.
 
 ### Changed
@@ -20,6 +22,20 @@ Got it — here’s your changelog tidied up for clarity and consistency without
 
 ---
 
+## [0.1.2] - 2025-05-11
+
+### Added
+
+1. Added support for closing SPL token accounts with:
+  - `Solace::Composers::SystemProgramCreateAccountComposer`
+  - `Solace::Instructions::SystemProgram::CreateAccountInstruction`
+
+## [0.1.1] - 2025-05-11
+
+### Added
+
+1. Added support to inject encoding externally to get the data with respective encoding.
+
 ## [0.1.0] - 2025-18-10
 
 **NOTE (Breaking):**
@@ -30,8 +46,8 @@ Additionally, unless explicitly required by a composer’s instruction, the `pay
 
 1. **`Solace::Tokens`** — a structured registry and lookup system for Solana token metadata.
 
-   * Developers can define token details via a YAML configuration file scoped by network (e.g., `mainnet`, `devnet`).
-   * Programmatic access to token metadata:
+   - Developers can define token details via a YAML configuration file scoped by network (e.g., `mainnet`, `devnet`).
+   - Programmatic access to token metadata:
 
      ```ruby
      Solace::Tokens.load(path: 'tokens.yml', network: :devnet)
@@ -39,49 +55,50 @@ Additionally, unless explicitly required by a composer’s instruction, the `pay
      Solace::Tokens.fetch('USDC')   # => <Solace::Tokens::Token ...>
      Solace::Tokens.where(decimals: 6)
      ```
-   * Dynamically registers constants for each token symbol (`USDC`, `SOL`, etc.).
-   * Safety improvements to preserve internal constants (`Token`) during reloads.
+
+   - Dynamically registers constants for each token symbol (`USDC`, `SOL`, etc.).
+   - Safety improvements to preserve internal constants (`Token`) during reloads.
 
 2. **`SystemProgramCreateAccountComposer`** — composer for building account creation flows via the Solana System Program.
 
-   * Wraps `SystemProgram::CreateAccountInstruction`.
-   * Handles lamport allocation, rent exemption, and ownership assignment.
-   * Simplifies creation of system-owned and program-owned accounts.
+   - Wraps `SystemProgram::CreateAccountInstruction`.
+   - Handles lamport allocation, rent exemption, and ownership assignment.
+   - Simplifies creation of system-owned and program-owned accounts.
 
 3. **`SplTokenProgramInitializeMintComposer`** — composer for initializing new SPL Token mints.
 
-   * Wraps `SplToken::InitializeMintInstruction`.
-   * Supports decimals, mint authority, and optional freeze authority.
-   * Designed to pair with `SystemProgramCreateAccountComposer` for one-transaction mint creation.
+   - Wraps `SplToken::InitializeMintInstruction`.
+   - Supports decimals, mint authority, and optional freeze authority.
+   - Designed to pair with `SystemProgramCreateAccountComposer` for one-transaction mint creation.
 
 4. **`SplTokenProgramMintToComposer`** — composer for minting tokens to an ATA.
 
-   * Wraps `SplToken::MintToInstruction`.
-   * Supports minting tokens to a destination ATA.
+   - Wraps `SplToken::MintToInstruction`.
+   - Supports minting tokens to a destination ATA.
 
 5. **`SplTokenProgramTransferComposer`** — composer for transferring tokens.
 
-   * Wraps `SplToken::TransferInstruction`.
-   * Supports sending SPL tokens.
+   - Wraps `SplToken::TransferInstruction`.
+   - Supports sending SPL tokens.
 
 6. **`Solace::Connection`** — cached blockhash accessors.
 
-   * Added `last_fetched_blockhash` and `last_fetched_block_height`.
-   * Stores the most recently retrieved blockhash and corresponding `lastValidBlockHeight`.
-   * Enables reuse without re-fetching between sequential transactions.
-   * `get_latest_blockhash` now sets these values automatically.
+   - Added `last_fetched_blockhash` and `last_fetched_block_height`.
+   - Stores the most recently retrieved blockhash and corresponding `lastValidBlockHeight`.
+   - Enables reuse without re-fetching between sequential transactions.
+   - `get_latest_blockhash` now sets these values automatically.
 
 7. **`TransactionComposer`** — instruction ordering helpers.
 
-   * Added `prepend_instruction` and `insert_instruction` for finer control of instruction order.
+   - Added `prepend_instruction` and `insert_instruction` for finer control of instruction order.
 
 8. **`Transaction`** — signature helper.
 
-   * Added `transaction.signature` to get the signature from a signed transaction.
+   - Added `transaction.signature` to get the signature from a signed transaction.
 
 9. **Program method options** — higher-level control.
 
-   * Added `execute`, `sign`, and a yield block to relevant Program methods for flow control and composer access.
+   - Added `execute`, `sign`, and a yield block to relevant Program methods for flow control and composer access.
 
 ### Changed
 
@@ -105,23 +122,26 @@ Additionally, unless explicitly required by a composer’s instruction, the `pay
 
 ### Fixed
 
-* Improved token loading safety in `Solace::Tokens` to prevent internal constant removal during reloads.
+- Improved token loading safety in `Solace::Tokens` to prevent internal constant removal during reloads.
 
 ---
 
 ## [0.0.9] - 2025-08-12
 
 ### Added
+
 1. Added `get_program_accounts` to `Solace::Connection`.
 
 ### Changed
 
 ### Fixed
+
 1. Removed use of the `try` method for supporting non-rails environments.
 
 ## [0.0.8] - 2025-08-11
 
 ### Added
+
 1. Added `load` method to `Solace::Constants` to load constants from a YAML file. This method allows for loading constants from a YAML file (i.e. custom program addresses and mint accounts).
 2. Added `to_s` and `address` method to `Solace::Keypair` and `Solace::PublicKey` to return the public key as a Base58 string.
 3. Added `get_signature_status` and `get_signature_statuses` to `Solace::Connection`.
@@ -129,18 +149,22 @@ Additionally, unless explicitly required by a composer’s instruction, the `pay
 5. Added `Errors` module to `Solace::Utils` to handle errors from the HTTP requests made to the Solana RPC node.
 
 ### Changed
+
 1. All methods that take a `Solace::Keypair` or `Solace::Pubkey` where an address is needed now also accept a plain string address. This prevents the need of creating instances of the classes when all that is needed is the address. This is with the exception of the low-level instruction builders, which only expect the correct data and indicies with no required casting.
 2. Changed `wait_for_confirmed_signature` method to accept a `timeout`, `interval`, and `commitment` arguments.
 
 ### Fixed
+
 1. Fixed `get_or_create_address` method in `Solace::Programs::AssociatedTokenAccount` to return the address of the associated token account if it already exists by checking if there is any data at the address.
 
 ## [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 `compose_create_associated_token_account` method.
 
 ### Fixed
@@ -148,20 +172,23 @@ Additionally, unless explicitly required by a composer’s instruction, the `pay
 ## [0.0.6] - 2025-08-07
 
 ### Added
+
 1. Added `from_address` method to `Solace::PublicKey`.
 2. Change docs on most methods to include an `@example` section.
 
 ### Changed
+
 1. Change `private_key` method on Keypair to `pivate_key_bytes`
 2. Change README to include a practical example of using composers.
 
 ### Fixed
-1. Fix `encode_signatures` method in `Solace::Serializers::TransactionSerializer` to correctly count the number of signatures using the `num_required_signatures` field in the message.
 
+1. Fix `encode_signatures` method in `Solace::Serializers::TransactionSerializer` to correctly count the number of signatures using the `num_required_signatures` field in the message.
 
 ## [0.0.3] - 2025-07-30
 
 ### Added
+
 1. Moved `TransferCheckedInstruction` and `TransferInstruction` to `Solace::Instructions::SystemProgram` namespace.
 2. Added `get_token_account_balance` to `Solace::Connection`.
 3. Added `get_or_create_address` to `Solace::Programs::AssociatedTokenAccount`.

data/lib/solace/composers/spl_token_program_close_account_composer.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Solace
+  module Composers
+    # Composer for creating a SPL Token Program CloseAccount instruction.
+    #
+    # This composer resolves and orders the required accounts for a `CloseAccount` instruction,
+    # sets up their access permissions, and delegates construction to the appropriate
+    # instruction builder.
+    #
+    # The CloseAccount instruction closes a token account and transfers remaining lamports
+    # to a destination account. The account must have a balance of zero tokens.
+    #
+    # Required accounts:
+    # - **Account**: token account to close (writable, non-signer)
+    # - **Destination**: account to receive lamports (writable, non-signer)
+    # - **Authority**: account authority (non-writable, signer)
+    #
+    # @example Compose and build a close account instruction
+    #   composer = SplTokenProgramCloseAccountComposer.new(
+    #     account: token_account_address,
+    #     destination: destination_address,
+    #     authority: authority_address
+    #   )
+    #
+    # @since 0.1.2
+    class SplTokenProgramCloseAccountComposer < Base
+      # Extracts the token account address from the params
+      #
+      # @return [String] The token account address
+      def account
+        params[:account].to_s
+      end
+
+      # Extracts the destination address from the params
+      #
+      # @return [String] The destination address
+      def destination
+        params[:destination].to_s
+      end
+
+      # Extracts the authority address from the params
+      #
+      # @return [String] The authority address
+      def authority
+        params[:authority].to_s
+      end
+
+      # Returns the spl token program id
+      #
+      # @return [String] The spl token program id
+      def spl_token_program
+        Constants::TOKEN_PROGRAM_ID.to_s
+      end
+
+      # Setup accounts required for close account instruction
+      # Called automatically during initialization
+      #
+      # @return [void]
+      def setup_accounts
+        account_context.add_writable_nonsigner(account)
+        account_context.add_writable_nonsigner(destination)
+        account_context.add_readonly_signer(authority)
+        account_context.add_readonly_nonsigner(spl_token_program)
+      end
+
+      # Build instruction with resolved account indices
+      #
+      # @param account_context [Utils::AccountContext] The account context
+      # @return [Solace::Instruction]
+      def build_instruction(account_context)
+        Instructions::SplToken::CloseAccountInstruction.build(
+          account_index: account_context.index_of(account),
+          authority_index: account_context.index_of(authority),
+          destination_index: account_context.index_of(destination),
+          program_index: account_context.index_of(spl_token_program)
+        )
+      end
+    end
+  end
+end

data/lib/solace/connection.rb

@@ -55,11 +55,13 @@ module Solace
     # @return [Solace::Connection] The connection object
     # @param [Integer] http_open_timeout The timeout for opening an HTTP connection
     # @param [Integer] http_read_timeout The timeout for reading an HTTP response
+    # @param [String] encoding The encoding for the RPC requests
     def initialize(
       rpc_url = 'http://localhost:8899',
       commitment: 'processed',
       http_open_timeout: 30,
-      http_read_timeout: 60
+      http_read_timeout: 60,
+      encoding: 'base64'
     )
       # Initialize the RPC client
       @rpc_client = Utils::RPCClient.new(
@@ -71,7 +73,7 @@ module Solace
       # Set default options for rpc requests
       @default_options = {
         commitment: commitment,
-        encoding: 'base64'
+        encoding: encoding
       }
     end
 

data/lib/solace/instructions/spl_token/close_account_instruction.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Solace
+  module Instructions
+    module SplToken
+      # Instruction builder for SPL Token Program CloseAccount.
+      #
+      # The CloseAccount instruction closes a token account and transfers all remaining
+      # lamports to a destination account. The token account must have a balance of zero.
+      #
+      # Instruction discriminator: 9
+      #
+      # Accounts:
+      # 1. [writable] Token account to close
+      # 2. [writable] Destination account to receive lamports
+      # 3. [signer] Account authority
+      #
+      # @since 0.1.2
+      class CloseAccountInstruction
+        # Instruction discriminator for CloseAccount
+        INSTRUCTION_DISCRIMINATOR = [9].freeze
+
+        # Builds a CloseAccount instruction
+        #
+        # @param account_index [Integer] Index of the token account to close
+        # @param destination_index [Integer] Index of the destination account
+        # @param authority_index [Integer] Index of the account authority
+        # @param program_index [Integer] Index of the SPL Token program
+        # @return [Solace::Instruction] The constructed instruction
+        def self.build(account_index:, destination_index:, authority_index:, program_index:)
+          Solace::Instruction.new.tap do |ix|
+            ix.program_index = program_index
+            ix.accounts = [account_index, destination_index, authority_index]
+            ix.data = data
+          end
+        end
+
+        # Builds the data for a CloseAccount instruction
+        #
+        # The BufferLayout is:
+        #   - [Instruction Index (1 byte)]
+        #
+        # @return [Array] 1-byte instruction index
+        def self.data
+          INSTRUCTION_DISCRIMINATOR
+        end
+      end
+    end
+  end
+end

data/lib/solace/version.rb

@@ -2,6 +2,5 @@
 
 module Solace
   # Latest version of the Solace gem.
-  # @since 0.1.0
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solace
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Sebastian Scholl
@@ -109,6 +109,7 @@ files:
 - 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_close_account_composer.rb
 - lib/solace/composers/spl_token_program_initialize_mint_composer.rb
 - lib/solace/composers/spl_token_program_mint_to_composer.rb
 - lib/solace/composers/spl_token_program_transfer_checked_composer.rb
@@ -125,6 +126,7 @@ files:
 - lib/solace/errors/rpc_error.rb
 - lib/solace/instruction.rb
 - lib/solace/instructions/associated_token_account/create_associated_token_account_instruction.rb
+- lib/solace/instructions/spl_token/close_account_instruction.rb
 - 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