ox
Version:
71 lines • 2.01 kB
JavaScript
import * as Address from '../core/Address.js';
import * as Hex from '../core/Hex.js';
const tip20Prefix = '0x20c0';
/**
* 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 function from(tokenIdOrAddress) {
if (typeof tokenIdOrAddress === 'bigint' ||
typeof tokenIdOrAddress === 'number')
return BigInt(tokenIdOrAddress);
return fromAddress(tokenIdOrAddress);
}
/**
* 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('0x20c00000000000000000000000000000000000000001')
* ```
*
* @param address - The token address.
* @returns The token ID.
*/
export function fromAddress(address) {
if (!address.toLowerCase().startsWith(tip20Prefix))
throw new Error('invalid tip20 address.');
return Hex.toBigInt(Hex.slice(address, tip20Prefix.length));
}
/**
* 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 function toAddress(tokenId) {
if (typeof tokenId === 'string') {
Address.assert(tokenId);
return tokenId;
}
const tokenIdHex = Hex.fromNumber(tokenId, { size: 18 });
return Hex.concat(tip20Prefix, tokenIdHex);
}
//# sourceMappingURL=TokenId.js.map