solace-squads-smart-accounts 0.1.0

data/lib/solace/squads_smart_accounts/composers/cancel_proposal_composer.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Solace
+  module Composers
+    # Composes a `cancelProposal` instruction for the Squads Smart Account program.
+    #
+    # Casts a cancellation vote on an Approved proposal. The signer must be a
+    # smart account member with the Vote permission. Unlike approve/reject, the
+    # System program is a required account (it funds the proposal realloc).
+    #
+    # Required params:
+    #   :settings [#to_s]          Base58 address of the settings account.
+    #   :signer   [#to_s, Keypair] The voting signer (must sign).
+    #   :proposal [#to_s]          The Proposal PDA to cancel (must be Approved).
+    #
+    # Optional params:
+    #   :memo [String] Indexing memo (default: nil).
+    class SquadsSmartAccountsCancelProposalComposer < Base
+      # Extracts the settings address from the params
+      #
+      # @return [String] The settings address
+      def settings
+        params[:settings].to_s
+      end
+
+      # Extracts the voting signer address from the params
+      #
+      # @return [String] The signer address
+      def signer
+        params[:signer].to_s
+      end
+
+      # Extracts the proposal PDA address from the params
+      #
+      # @return [String] The proposal address
+      def proposal
+        params[:proposal].to_s
+      end
+
+      # Extracts the memo from the params
+      #
+      # @return [String, nil] The memo
+      def memo
+        params[:memo]
+      end
+
+      # Returns the Squads Smart Account program id from the constants
+      #
+      # @return [String] The Squads Smart Account program id
+      def program_id
+        SquadsSmartAccounts::PROGRAM_ID
+      end
+
+      # Returns the system program id from the constants
+      #
+      # @return [String] The system program id
+      def system_program
+        Solace::Constants::SYSTEM_PROGRAM_ID
+      end
+
+      # Declares all accounts required by this instruction.
+      def setup_accounts
+        account_context.add_readonly_nonsigner(settings)
+        account_context.add_writable_signer(signer)
+        account_context.add_writable_nonsigner(proposal)
+        account_context.add_readonly_nonsigner(system_program)
+        account_context.add_readonly_nonsigner(program_id)
+      end
+
+      # Builds the instruction with resolved account indices.
+      #
+      # @param context [Solace::Utils::AccountContext] Merged context from TransactionComposer.
+      # @return [Solace::Instruction]
+      def build_instruction(context)
+        SquadsSmartAccounts::Instructions::CancelProposalInstruction.build(
+          memo:,
+          settings_index:       context.index_of(settings),
+          signer_index:         context.index_of(signer),
+          proposal_index:       context.index_of(proposal),
+          system_program_index: context.index_of(system_program),
+          program_index:        context.index_of(program_id)
+        )
+      end
+    end
+  end
+end

data/lib/solace/squads_smart_accounts/composers/change_threshold_as_authority_composer.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Solace
+  module Composers
+    # Composes a `changeThresholdAsAuthority` instruction for the Squads Smart Account program.
+    #
+    # Changes the approval threshold of a controlled smart account. Only the
+    # account's settings authority may do this — single signature, no consensus.
+    #
+    # Required params:
+    #   :settings           [String]         Base58 address of the settings account.
+    #   :settings_authority [#to_s, Keypair] The account's settings authority (must sign).
+    #   :rent_payer         [#to_s, Keypair] Pays for settings account reallocation (must sign).
+    #   :new_threshold      [Integer]        The new approval threshold.
+    #
+    # Optional params:
+    #   :memo [String] Indexing memo (default: nil).
+    class SquadsSmartAccountsChangeThresholdAsAuthorityComposer < Base
+      # Extracts the settings address from the params
+      #
+      # @return [String] The settings address
+      def settings
+        params[:settings].to_s
+      end
+
+      # Extracts the settings authority address from the params
+      #
+      # @return [String] The settings authority address
+      def settings_authority
+        params[:settings_authority].to_s
+      end
+
+      # Extracts the rent payer address from the params
+      #
+      # @return [String] The rent payer address
+      def rent_payer
+        params[:rent_payer].to_s
+      end
+
+      # Extracts the new threshold from the params
+      #
+      # @return [Integer] The new approval threshold
+      def new_threshold
+        params[:new_threshold]
+      end
+
+      # Extracts the memo from the params
+      #
+      # @return [String, nil] The memo
+      def memo
+        params[:memo]
+      end
+
+      # Returns the Squads Smart Account program id from the constants
+      #
+      # @return [String] The Squads Smart Account program id
+      def program_id
+        SquadsSmartAccounts::PROGRAM_ID
+      end
+
+      # Returns the system program id from the constants
+      #
+      # @return [String] The system program id
+      def system_program
+        Solace::Constants::SYSTEM_PROGRAM_ID
+      end
+
+      # Declares all accounts required by this instruction.
+      def setup_accounts
+        account_context.add_writable_nonsigner(settings)
+        account_context.add_readonly_signer(settings_authority)
+        account_context.add_writable_signer(rent_payer)
+        account_context.add_readonly_nonsigner(system_program)
+        account_context.add_readonly_nonsigner(program_id)
+      end
+
+      # Builds the instruction with resolved account indices.
+      #
+      # @param context [Solace::Utils::AccountContext] Merged context from TransactionComposer.
+      # @return [Solace::Instruction]
+      def build_instruction(context)
+        SquadsSmartAccounts::Instructions::ChangeThresholdAsAuthorityInstruction.build(
+          new_threshold:,
+          memo:,
+          settings_index:           context.index_of(settings),
+          settings_authority_index: context.index_of(settings_authority),
+          rent_payer_index:         context.index_of(rent_payer),
+          system_program_index:     context.index_of(system_program),
+          program_index:            context.index_of(program_id)
+        )
+      end
+    end
+  end
+end

data/lib/solace/squads_smart_accounts/composers/close_settings_transaction_composer.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Solace
+  module Composers
+    # Composes a `closeSettingsTransaction` instruction for the Squads Smart
+    # Account program.
+    #
+    # Closes a SettingsTransaction and its Proposal, refunding rent to the
+    # respective collectors. No smart-account signer is required — only the fee
+    # payer signs. The transaction is closeable once its proposal is terminal
+    # (Executed/Rejected/Cancelled) or stale.
+    #
+    # Required params:
+    #   :settings                   [#to_s] Base58 address of the settings account.
+    #   :proposal                   [#to_s] The Proposal PDA to close.
+    #   :transaction                [#to_s] The SettingsTransaction PDA to close.
+    #   :proposal_rent_collector    [#to_s] Receives the proposal rent.
+    #   :transaction_rent_collector [#to_s] Receives the transaction rent (must equal
+    #                                       transaction.rent_collector).
+    class SquadsSmartAccountsCloseSettingsTransactionComposer < Base
+      # Extracts the settings address from the params
+      #
+      # @return [String] The settings address
+      def settings
+        params[:settings].to_s
+      end
+
+      # Extracts the proposal PDA address from the params
+      #
+      # @return [String] The proposal address
+      def proposal
+        params[:proposal].to_s
+      end
+
+      # Extracts the settings transaction PDA address from the params
+      #
+      # @return [String] The transaction address
+      def transaction
+        params[:transaction].to_s
+      end
+
+      # Extracts the proposal rent collector address from the params
+      #
+      # @return [String] The proposal rent collector address
+      def proposal_rent_collector
+        params[:proposal_rent_collector].to_s
+      end
+
+      # Extracts the transaction rent collector address from the params
+      #
+      # @return [String] The transaction rent collector address
+      def transaction_rent_collector
+        params[:transaction_rent_collector].to_s
+      end
+
+      # Returns the Squads Smart Account program id from the constants
+      #
+      # @return [String] The Squads Smart Account program id
+      def program_id
+        SquadsSmartAccounts::PROGRAM_ID
+      end
+
+      # Returns the system program id from the constants
+      #
+      # @return [String] The system program id
+      def system_program
+        Solace::Constants::SYSTEM_PROGRAM_ID
+      end
+
+      # Declares all accounts required by this instruction.
+      def setup_accounts
+        account_context.add_readonly_nonsigner(settings)
+        account_context.add_writable_nonsigner(proposal)
+        account_context.add_writable_nonsigner(transaction)
+        account_context.add_writable_nonsigner(proposal_rent_collector)
+        account_context.add_writable_nonsigner(transaction_rent_collector)
+        account_context.add_readonly_nonsigner(system_program)
+        account_context.add_readonly_nonsigner(program_id)
+      end
+
+      # Builds the instruction with resolved account indices.
+      #
+      # @param context [Solace::Utils::AccountContext] Merged context from TransactionComposer.
+      # @return [Solace::Instruction]
+      def build_instruction(context)
+        SquadsSmartAccounts::Instructions::CloseSettingsTransactionInstruction.build(
+          settings_index:                   context.index_of(settings),
+          proposal_index:                   context.index_of(proposal),
+          transaction_index:                context.index_of(transaction),
+          proposal_rent_collector_index:    context.index_of(proposal_rent_collector),
+          transaction_rent_collector_index: context.index_of(transaction_rent_collector),
+          system_program_index:             context.index_of(system_program),
+          program_index:                    context.index_of(program_id)
+        )
+      end
+    end
+  end
+end

data/lib/solace/squads_smart_accounts/composers/close_transaction_composer.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Solace
+  module Composers
+    # Composes a `closeTransaction` instruction for the Squads Smart Account program.
+    #
+    # Closes a vault Transaction and its Proposal, refunding rent to the
+    # respective collectors. No smart-account signer is required — only the fee
+    # payer signs. Closeable once the proposal is terminal
+    # (Executed/Rejected/Cancelled) or stale and not Approved.
+    #
+    # Required params:
+    #   :settings                   [#to_s] Base58 address of the settings account.
+    #   :proposal                   [#to_s] The Proposal PDA to close.
+    #   :transaction                [#to_s] The vault Transaction PDA to close.
+    #   :proposal_rent_collector    [#to_s] Receives the proposal rent.
+    #   :transaction_rent_collector [#to_s] Receives the transaction rent (must equal
+    #                                       transaction.rent_collector).
+    class SquadsSmartAccountsCloseTransactionComposer < Base
+      # Extracts the settings address from the params
+      #
+      # @return [String] The settings address
+      def settings
+        params[:settings].to_s
+      end
+
+      # Extracts the proposal PDA address from the params
+      #
+      # @return [String] The proposal address
+      def proposal
+        params[:proposal].to_s
+      end
+
+      # Extracts the transaction PDA address from the params
+      #
+      # @return [String] The transaction address
+      def transaction
+        params[:transaction].to_s
+      end
+
+      # Extracts the proposal rent collector address from the params
+      #
+      # @return [String] The proposal rent collector address
+      def proposal_rent_collector
+        params[:proposal_rent_collector].to_s
+      end
+
+      # Extracts the transaction rent collector address from the params
+      #
+      # @return [String] The transaction rent collector address
+      def transaction_rent_collector
+        params[:transaction_rent_collector].to_s
+      end
+
+      # Returns the Squads Smart Account program id from the constants
+      #
+      # @return [String] The Squads Smart Account program id
+      def program_id
+        SquadsSmartAccounts::PROGRAM_ID
+      end
+
+      # Returns the system program id from the constants
+      #
+      # @return [String] The system program id
+      def system_program
+        Solace::Constants::SYSTEM_PROGRAM_ID
+      end
+
+      # Declares all accounts required by this instruction.
+      def setup_accounts
+        account_context.add_readonly_nonsigner(settings)
+        account_context.add_writable_nonsigner(proposal)
+        account_context.add_writable_nonsigner(transaction)
+        account_context.add_writable_nonsigner(proposal_rent_collector)
+        account_context.add_writable_nonsigner(transaction_rent_collector)
+        account_context.add_readonly_nonsigner(system_program)
+        account_context.add_readonly_nonsigner(program_id)
+      end
+
+      # Builds the instruction with resolved account indices.
+      #
+      # @param context [Solace::Utils::AccountContext] Merged context from TransactionComposer.
+      # @return [Solace::Instruction]
+      def build_instruction(context)
+        SquadsSmartAccounts::Instructions::CloseTransactionInstruction.build(
+          settings_index:                   context.index_of(settings),
+          proposal_index:                   context.index_of(proposal),
+          transaction_index:                context.index_of(transaction),
+          proposal_rent_collector_index:    context.index_of(proposal_rent_collector),
+          transaction_rent_collector_index: context.index_of(transaction_rent_collector),
+          system_program_index:             context.index_of(system_program),
+          program_index:                    context.index_of(program_id)
+        )
+      end
+    end
+  end
+end

data/lib/solace/squads_smart_accounts/composers/create_proposal_composer.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Solace
+  module Composers
+    # Composes a `createProposal` instruction for the Squads Smart Account program.
+    #
+    # Creates the Proposal account that tracks votes for a stored Transaction.
+    # The transaction must already exist (its index is referenced here).
+    #
+    # Required params:
+    #   :settings          [#to_s]          Base58 address of the settings account.
+    #   :proposal          [#to_s]          The Proposal PDA to create.
+    #   :creator           [#to_s, Keypair] A smart-account signer creating the proposal (must sign).
+    #   :rent_payer        [#to_s, Keypair] Funds the new account's rent (must sign).
+    #   :transaction_index [Integer]        Index of the transaction this proposal tracks.
+    #
+    # Optional params:
+    #   :draft [Boolean] Initialize as Draft instead of Active (default: false).
+    class SquadsSmartAccountsCreateProposalComposer < Base
+      # Extracts the settings address from the params
+      #
+      # @return [String] The settings address
+      def settings
+        params[:settings].to_s
+      end
+
+      # Extracts the proposal PDA address from the params
+      #
+      # @return [String] The proposal address
+      def proposal
+        params[:proposal].to_s
+      end
+
+      # Extracts the creator address from the params
+      #
+      # @return [String] The creator address
+      def creator
+        params[:creator].to_s
+      end
+
+      # Extracts the rent payer address from the params
+      #
+      # @return [String] The rent payer address
+      def rent_payer
+        params[:rent_payer].to_s
+      end
+
+      # Extracts the transaction index from the params
+      #
+      # @return [Integer] The transaction index the proposal tracks
+      def transaction_index
+        params[:transaction_index]
+      end
+
+      # Extracts the draft flag from the params
+      #
+      # @return [Boolean] Whether to initialize the proposal as Draft (defaults to false)
+      def draft
+        params[:draft] || false
+      end
+
+      # Returns the Squads Smart Account program id from the constants
+      #
+      # @return [String] The Squads Smart Account program id
+      def program_id
+        SquadsSmartAccounts::PROGRAM_ID
+      end
+
+      # Returns the system program id from the constants
+      #
+      # @return [String] The system program id
+      def system_program
+        Solace::Constants::SYSTEM_PROGRAM_ID
+      end
+
+      # Declares all accounts required by this instruction.
+      def setup_accounts
+        account_context.add_readonly_nonsigner(settings)
+        account_context.add_writable_nonsigner(proposal)
+        account_context.add_readonly_signer(creator)
+        account_context.add_writable_signer(rent_payer)
+        account_context.add_readonly_nonsigner(system_program)
+        account_context.add_readonly_nonsigner(program_id)
+      end
+
+      # Builds the instruction with resolved account indices.
+      #
+      # @param context [Solace::Utils::AccountContext] Merged context from TransactionComposer.
+      # @return [Solace::Instruction]
+      def build_instruction(context)
+        SquadsSmartAccounts::Instructions::CreateProposalInstruction.build(
+          transaction_index:,
+          draft:,
+          settings_index:       context.index_of(settings),
+          proposal_index:       context.index_of(proposal),
+          creator_index:        context.index_of(creator),
+          rent_payer_index:     context.index_of(rent_payer),
+          system_program_index: context.index_of(system_program),
+          program_index:        context.index_of(program_id)
+        )
+      end
+    end
+  end
+end

data/lib/solace/squads_smart_accounts/composers/create_settings_transaction_composer.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Solace
+  module Composers
+    # Composes a `createSettingsTransaction` instruction for the Squads Smart
+    # Account program.
+    #
+    # Stores a batch of SettingsActions as a SettingsTransaction for later
+    # approval and execution. Autonomous accounts only.
+    #
+    # Required params:
+    #   :settings    [#to_s]          Base58 address of the settings account.
+    #   :transaction [#to_s]          The SettingsTransaction PDA to create.
+    #   :creator     [#to_s, Keypair] A signer creating the transaction (must sign).
+    #   :rent_payer  [#to_s, Keypair] Funds the new account's rent (must sign).
+    #   :actions     [Array<SquadsSmartAccounts::SettingsAction>] Actions to store.
+    #
+    # Optional params:
+    #   :memo [String] Indexing memo (default: nil).
+    class SquadsSmartAccountsCreateSettingsTransactionComposer < Base
+      # Extracts the settings address from the params
+      #
+      # @return [String] The settings address
+      def settings
+        params[:settings].to_s
+      end
+
+      # Extracts the transaction PDA address from the params
+      #
+      # @return [String] The transaction address
+      def transaction
+        params[:transaction].to_s
+      end
+
+      # Extracts the creator address from the params
+      #
+      # @return [String] The creator address
+      def creator
+        params[:creator].to_s
+      end
+
+      # Extracts the rent payer address from the params
+      #
+      # @return [String] The rent payer address
+      def rent_payer
+        params[:rent_payer].to_s
+      end
+
+      # Extracts the settings actions from the params
+      #
+      # @return [Array<SquadsSmartAccounts::SettingsAction>] The actions to store
+      def actions
+        params[:actions]
+      end
+
+      # Extracts the memo from the params
+      #
+      # @return [String, nil] The memo
+      def memo
+        params[:memo]
+      end
+
+      # Returns the Squads Smart Account program id from the constants
+      #
+      # @return [String] The Squads Smart Account program id
+      def program_id
+        SquadsSmartAccounts::PROGRAM_ID
+      end
+
+      # Returns the system program id from the constants
+      #
+      # @return [String] The system program id
+      def system_program
+        Solace::Constants::SYSTEM_PROGRAM_ID
+      end
+
+      # Declares all accounts required by this instruction.
+      def setup_accounts
+        account_context.add_writable_nonsigner(settings)
+        account_context.add_writable_nonsigner(transaction)
+        account_context.add_readonly_signer(creator)
+        account_context.add_writable_signer(rent_payer)
+        account_context.add_readonly_nonsigner(system_program)
+        account_context.add_readonly_nonsigner(program_id)
+      end
+
+      # Builds the instruction with resolved account indices.
+      #
+      # @param context [Solace::Utils::AccountContext] Merged context from TransactionComposer.
+      # @return [Solace::Instruction]
+      def build_instruction(context)
+        SquadsSmartAccounts::Instructions::CreateSettingsTransactionInstruction.build(
+          actions:,
+          memo:,
+          settings_index:       context.index_of(settings),
+          transaction_index:    context.index_of(transaction),
+          creator_index:        context.index_of(creator),
+          rent_payer_index:     context.index_of(rent_payer),
+          system_program_index: context.index_of(system_program),
+          program_index:        context.index_of(program_id)
+        )
+      end
+    end
+  end
+end