@solana/codecs-numbers/dist/types/i128.d.ts

Codecs for numbers of different sizes and endianness

import { FixedSizeCodec, FixedSizeDecoder, FixedSizeEncoder } from '@solana/codecs-core';
import { NumberCodecConfig } from './common';
/**
 * Returns an encoder for 128-bit signed integers (`i128`).
 *
 * This encoder serializes `i128` values using 16 bytes.
 * Values can be provided as either `number` or `bigint`.
 *
 * For more details, see {@link getI128Codec}.
 *
 * @param config - Optional configuration to specify endianness (little by default).
 * @returns A `FixedSizeEncoder<number | bigint, 16>` for encoding `i128` values.
 *
 * @example
 * Encoding an `i128` value.
 * ```ts
 * const encoder = getI128Encoder();
 * const bytes = encoder.encode(-42n); // 0xd6ffffffffffffffffffffffffffffff
 * ```
 *
 * @see {@link getI128Codec}
 */
export declare const getI128Encoder: (config?: NumberCodecConfig) => FixedSizeEncoder<bigint | number, 16>;
/**
 * Returns a decoder for 128-bit signed integers (`i128`).
 *
 * This decoder deserializes `i128` values from 16 bytes.
 * The decoded value is always a `bigint`.
 *
 * For more details, see {@link getI128Codec}.
 *
 * @param config - Optional configuration to specify endianness (little by default).
 * @returns A `FixedSizeDecoder<bigint, 16>` for decoding `i128` values.
 *
 * @example
 * Decoding an `i128` value.
 * ```ts
 * const decoder = getI128Decoder();
 * const value = decoder.decode(new Uint8Array([
 *   0xd6, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
 *   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
 * ])); // -42n
 * ```
 *
 * @see {@link getI128Codec}
 */
export declare const getI128Decoder: (config?: NumberCodecConfig) => FixedSizeDecoder<bigint, 16>;
/**
 * Returns a codec for encoding and decoding 128-bit signed integers (`i128`).
 *
 * This codec serializes `i128` values using 16 bytes.
 * Values can be provided as either `number` or `bigint`, but the decoded value is always a `bigint`.
 *
 * @param config - Optional configuration to specify endianness (little by default).
 * @returns A `FixedSizeCodec<number | bigint, bigint, 16>` for encoding and decoding `i128` values.
 *
 * @example
 * Encoding and decoding an `i128` value.
 * ```ts
 * const codec = getI128Codec();
 * const bytes = codec.encode(-42n); // 0xd6ffffffffffffffffffffffffffffff
 * const value = codec.decode(bytes); // -42n
 * ```
 *
 * @example
 * Using big-endian encoding.
 * ```ts
 * const codec = getI128Codec({ endian: Endian.Big });
 * const bytes = codec.encode(-42n); // 0xffffffffffffffffffffffffffffd6
 * ```
 *
 * @remarks
 * This codec supports values between `-2^127` and `2^127 - 1`.
 * Since JavaScript `number` cannot safely represent values beyond `2^53 - 1`, the decoded value is always a `bigint`.
 *
 * - If you need a smaller signed integer, consider using {@link getI64Codec} or {@link getI32Codec}.
 * - If you need a larger signed integer, consider using a custom codec.
 * - If you need unsigned integers, consider using {@link getU128Codec}.
 *
 * Separate {@link getI128Encoder} and {@link getI128Decoder} functions are available.
 *
 * ```ts
 * const bytes = getI128Encoder().encode(-42);
 * const value = getI128Decoder().decode(bytes);
 * ```
 *
 * @see {@link getI128Encoder}
 * @see {@link getI128Decoder}
 */
export declare const getI128Codec: (config?: NumberCodecConfig) => FixedSizeCodec<bigint | number, bigint, 16>;
//# sourceMappingURL=i128.d.ts.map