getLamportsEncoder

function getLamportsEncoder<TEncoder>(
    innerEncoder,
): Encoder<Sol | Lamports> &
    ExtractAdditionalProps<TEncoder, NumberEncoder>;

Returns an encoder that you can use to encode a Lamports value to a byte array. The encoder also accepts a Sol fixed-point value, whose raw bigint is written as if it were a Lamports value.

You must supply a number decoder that will determine how encode the numeric value.

Type Parameters

Type Parameter
TEncoder extends NumberEncoder

Parameters

ParameterType
innerEncoderTEncoder

Returns

Encoder< | Sol | Lamports> & ExtractAdditionalProps<TEncoder, NumberEncoder>

Example

import { getLamportsEncoder } from '@solana/rpc-types';
import { getU16Encoder } from '@solana/codecs-numbers';
 
const lamports = lamports(256n);
const lamportsEncoder = getLamportsEncoder(getU16Encoder());
const lamportsBytes = lamportsEncoder.encode(lamports);
// Uint8Array(2) [ 0, 1 ]

On this page