ox/_types/tempo/TokenId.d.ts

Ethereum Standard Library

import * as Address from '../core/Address.js';
import * as Hex from '../core/Hex.js';
import * as TempoAddress from './TempoAddress.js';
export type TokenId = bigint;
export type TokenIdOrAddress<addressType = Address.Address> = TokenId | addressType;
/**
 * Converts a token ID or address to a token ID.
 *
 * TIP-20 is Tempo's native token standard for stablecoins with deterministic addresses
 * derived from sequential token IDs (prefix `0x20c0`).
 *
 * [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
 *
 * @example
 * ```ts twoslash
 * import { TokenId } from 'ox/tempo'
 *
 * const tokenId = TokenId.from(1n)
 * ```
 *
 * @param tokenIdOrAddress - The token ID or address.
 * @returns The token ID.
 */
export declare function from(tokenIdOrAddress: TokenIdOrAddress | number): TokenId;
/**
 * Converts a TIP-20 token address to a token ID.
 *
 * [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
 *
 * @example
 * ```ts twoslash
 * import { TokenId } from 'ox/tempo'
 *
 * const tokenId = TokenId.fromAddress('0x20c0000000000000000000000000000000000001')
 * ```
 *
 * @param address - The token address.
 * @returns The token ID.
 */
export declare function fromAddress(address: TempoAddress.Address): TokenId;
/**
 * Converts a TIP-20 token ID to an address.
 *
 * [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
 *
 * @example
 * ```ts twoslash
 * import { TokenId } from 'ox/tempo'
 *
 * const address = TokenId.toAddress(1n)
 * ```
 *
 * @param tokenId - The token ID.
 * @returns The address.
 */
export declare function toAddress(tokenId: TokenIdOrAddress<TempoAddress.Address>): Address.Address;
/**
 * Computes a deterministic TIP-20 token address from a sender address and salt.
 *
 * The address is computed as: `TIP20_PREFIX (12 bytes) || keccak256(abi.encode(sender, salt))[:8]`
 *
 * [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
 *
 * @example
 * ```ts twoslash
 * import { TokenId } from 'ox/tempo'
 *
 * const id = TokenId.compute({
 *   sender: '0x1234567890123456789012345678901234567890',
 *   salt: '0x0000000000000000000000000000000000000000000000000000000000000001',
 * })
 * ```
 *
 * @param value - The sender address and salt.
 * @returns The computed TIP-20 token id.
 */
export declare function compute(value: compute.Value): bigint;
export declare namespace compute {
    type Value = {
        /** The salt (32 bytes). */
        salt: Hex.Hex;
        /** The sender address. Accepts both hex and Tempo bech32m addresses. */
        sender: TempoAddress.Address;
    };
}
//# sourceMappingURL=TokenId.d.ts.map