Class: Solace::Instructions::SplToken::TransferCheckedInstruction

Inherits:
Object
  • Object
show all
Defined in:
lib/solace/instructions/spl_token/transfer_checked_instruction.rb

Overview

Service object for building an SPL Token Program transfer instruction

Constant Summary collapse

INSTRUCTION_INDEX =

SPL Token Program instruction index for Transfer Checked

[12].freeze

Class Method Summary collapse

Class Method Details

.build(amount:, decimals:, to_index:, from_index:, mint_index:, authority_index:, program_index: 3) ⇒ Solace::Instruction

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)

Parameters:

  • amount (Integer) —

    Amount to transfer (in tokens, according to mint’s decimals)

  • decimals (Integer) —

    Number of decimals for the token

  • to_index (Integer) —

    Index of the destination token account in the transaction’s accounts

  • from_index (Integer) —

    Index of the source token account in the transaction’s accounts

  • mint_index (Integer) —

    Index of the mint in the transaction’s accounts

  • authority_index (Integer) —

    Index of the authority (owner) in the transaction’s accounts

  • program_index (Integer) (defaults to: 3) —

    Index of the SPL Token Program in the transaction’s accounts (default: 3)

Returns:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/solace/instructions/spl_token/transfer_checked_instruction.rb', line 26

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

.data(amount, decimals) ⇒ Array

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)]

Parameters:

  • amount (Integer) —

    Amount to transfer

  • decimals (Integer) —

    Number of decimals for the token

Returns:

  • (Array) —

    1-byte instruction index + 8-byte amount + decimals



52
53
54
55
56
 
# File 'lib/solace/instructions/spl_token/transfer_checked_instruction.rb', line 52

def self.data(amount, decimals)
  INSTRUCTION_INDEX +
    Solace::Utils::Codecs.encode_le_u64(amount).bytes +
    [decimals]
end