toUnsignedBinaryFixedPoint

function toUnsignedBinaryFixedPoint<TTotalBits, TFractionalBits>(
    value,
): BinaryFixedPoint<'unsigned', TTotalBits, TFractionalBits>;

Converts a BinaryFixedPoint to its unsigned equivalent at the same totalBits and fractionalBits.

Unsigned inputs are returned by reference unchanged; signed inputs are accepted as long as their raw value is non-negative.

Throws SOLANA_ERROR__FIXED_POINTS__VALUE_OUT_OF_RANGE when the input represents a negative value that cannot be stored as unsigned.

Type Parameters

Parameters

Returns

BinaryFixedPoint<"unsigned", TTotalBits, TFractionalBits>

Example

const signedUsd = binaryFixedPoint('signed', 16, 8);
toUnsignedBinaryFixedPoint(signedUsd('1.5')); // unsigned, raw unchanged
toUnsignedBinaryFixedPoint(signedUsd('-1'));  // throws

See

toSignedBinaryFixedPoint