Class: Solace::Composers::Base

Inherits:

Object

• Object
• Solace::Composers::Base

Defined in:

lib/solace/composers/base.rb

Overview

A Base class for all composers

Since:

• 0.0.3

Direct Known Subclasses

AssociatedTokenAccountProgramCreateAccountComposer, SplTokenProgramCloseAccountComposer, SplTokenProgramInitializeMintComposer, SplTokenProgramMintToComposer, SplTokenProgramTransferCheckedComposer, SplTokenProgramTransferComposer, SystemProgramCreateAccountComposer, SystemProgramTransferComposer

Instance Attribute Summary

• #account_context ⇒ Utils::AccountContext

  The AccountContext instance for the composer.

• #params ⇒ Hash

  The parameters passed to the composer.

Instance Method Summary

• #build_instruction(indices) ⇒ void

  Build instruction with resolved account indices.

• #initialize(params) ⇒ Base constructor

  Initialize the composer.

• #setup_accounts ⇒ void

  Setup accounts required for this instruction.

Constructor Details

#initialize(params) ⇒ Base

Initialize the composer

Parameters:

• params (Hash) —

  Parameters to pass to the composer constructor

Since:

• 0.0.3

# File 'lib/solace/composers/base.rb', line 59

def initialize(params)
  @params = params
  @account_context = Utils::AccountContext.new
  setup_accounts
end

Instance Attribute Details

#account_context ⇒ Utils::AccountContext

Returns The AccountContext instance for the composer.

Returns:

• (Utils::AccountContext) —

  The AccountContext instance for the composer

Since:

• 0.0.3

# File 'lib/solace/composers/base.rb', line 54

def account_context
  @account_context
end

#params ⇒ Hash

Returns The parameters passed to the composer.

Returns:

• (Hash) —

  The parameters passed to the composer

Since:

• 0.0.3

# File 'lib/solace/composers/base.rb', line 48

def params
  @params
end

Instance Method Details

#build_instruction(indices) ⇒ void

This method returns an undefined value.

Build instruction with resolved account indices

Raises:

• (NotImplementedError)

Since:

• 0.0.3

# File 'lib/solace/composers/base.rb', line 75

def build_instruction(indices)
  raise NotImplementedError, 'Subclasses must implement build_instruction method'
end

#setup_accounts ⇒ void

This method returns an undefined value.

Setup accounts required for this instruction

Raises:

• (NotImplementedError)

Since:

• 0.0.3

# File 'lib/solace/composers/base.rb', line 68

def setup_accounts
  raise NotImplementedError, 'Subclasses must implement setup_accounts method'
end