@dynamic-labs/aleo 4.79.1 → 4.80.0

package/src/utils/aleoSendableTokens/aleoSendableTokens.js

@@ -0,0 +1,175 @@
+'use client'
+/**
+ * Per-network registry of tokens spendable from the wallet's *shielded*
+ * (private record) state via the widget Send view.
+ *
+ * Three program kinds, three submit paths:
+ *
+ *   - `credits`     `credits.aleo/transfer_private`
+ *                   inputs:     [record, recipient, amount]
+ *                   inputTypes: ['credits.record','address.private','u64.private']
+ *
+ *                   `credits.aleo/transfer_private_to_public`
+ *                   inputs:     [record, recipient, amount]
+ *                   inputTypes: ['credits.record','address.public','u64.public']
+ *
+ *   - `stablecoin`  `<stablecoin>/transfer_private`
+ *                   inputs:     [recipient, amount, record]
+ *                   inputTypes: ['address.private','u128.private','Token.record']
+ *                   (Sealance proof + its `[MerkleProof; 2u32].private` type
+ *                   are appended by the iframe — see
+ *                   `dynamic-waas-sdk/packages/aleo/src/client/client.ts`.)
+ *
+ *   - `arc21`       `token_registry.aleo/transfer_private`
+ *                   inputs:     [recipient, amount, record]
+ *                   inputTypes: ['address.private','u128.private','Token.record']
+ *                   (token_id is encoded inside the record's plaintext, not
+ *                   passed as an explicit input.)
+ *
+ * The 5 ARC-21 entries are mainnet-only (Hyperlane warp routes are not
+ * deployed on testnet). Stablecoins and credits exist on both networks.
+ */
+const ALEO_MAINNET_NETWORK_ID = 0;
+const ALEO_TESTNET_NETWORK_ID = 1;
+const ALEO_CREDITS_DECIMALS = 6;
+const ALEO_CREDITS_PROGRAM = 'credits.aleo';
+const ALEO_TOKEN_REGISTRY_PROGRAM = 'token_registry.aleo';
+const ALEO_CREDITS_TOKEN = {
+    contractAddress: ALEO_CREDITS_PROGRAM,
+    decimals: ALEO_CREDITS_DECIMALS,
+    logoURI: '',
+    name: 'Aleo Credits',
+    programId: ALEO_CREDITS_PROGRAM,
+    programKind: 'credits',
+    recordName: 'credits',
+    recordTypeLiteral: 'credits.record',
+    symbol: 'ALEO',
+};
+const ALEO_STABLECOIN_DECIMALS = 6;
+const buildStablecoin = (programId, symbol, name) => ({
+    contractAddress: programId,
+    decimals: ALEO_STABLECOIN_DECIMALS,
+    name,
+    programId,
+    programKind: 'stablecoin',
+    recordName: 'Token',
+    recordTypeLiteral: 'Token.record',
+    symbol,
+});
+const buildArc21 = (args) => ({
+    contractAddress: args.warpProgram,
+    decimals: args.decimals,
+    externalAuthRequired: false,
+    name: args.name,
+    programId: ALEO_TOKEN_REGISTRY_PROGRAM,
+    programKind: 'arc21',
+    recordName: 'Token',
+    recordTypeLiteral: 'Token.record',
+    symbol: args.symbol,
+    tokenId: args.tokenId,
+});
+const ALEO_SENDABLE_TOKENS_BY_NETWORK = {
+    [ALEO_MAINNET_NETWORK_ID]: [
+        ALEO_CREDITS_TOKEN,
+        buildStablecoin('usad_stablecoin.aleo', 'USAD', 'USAD'),
+        buildStablecoin('usdcx_stablecoin.aleo', 'USDCx', 'USDCx'),
+        buildArc21({
+            decimals: 9,
+            name: 'Wrapped SOL',
+            symbol: 'wSOL',
+            tokenId: '2045969100091121326225168054634646230244820821909676777152465722877810201564field',
+            warpProgram: 'hyp_warp_token_sol.aleo',
+        }),
+        buildArc21({
+            decimals: 18,
+            name: 'Wrapped ETH',
+            symbol: 'wETH',
+            tokenId: '8189585964265444162798552221009403350643900573290534096996249214099143169251field',
+            warpProgram: 'hyp_warp_token_eth.aleo',
+        }),
+        buildArc21({
+            decimals: 8,
+            name: 'Wrapped BTC',
+            symbol: 'wBTC',
+            tokenId: '3491859903473482085250871387962132231204352466326026409883548131580582527809field',
+            warpProgram: 'hyp_warp_token_wbtc.aleo',
+        }),
+        buildArc21({
+            decimals: 6,
+            name: 'Tether USD',
+            symbol: 'USDT',
+            tokenId: '7881654794448182580124231856035865816599796419758925654292946277940935117913field',
+            warpProgram: 'hyp_warp_token_usdt.aleo',
+        }),
+        buildArc21({
+            decimals: 6,
+            name: 'USD Coin',
+            symbol: 'USDC',
+            tokenId: '4697275201844475848710842677807162058146139844643350200269139278887318953049field',
+            warpProgram: 'hyp_warp_token_usdc.aleo',
+        }),
+    ],
+    [ALEO_TESTNET_NETWORK_ID]: [
+        ALEO_CREDITS_TOKEN,
+        buildStablecoin('test_usad_stablecoin.aleo', 'USAD', 'USAD'),
+        buildStablecoin('test_usdcx_stablecoin.aleo', 'USDCx', 'USDCx'),
+    ],
+};
+const getAleoSendableTokensForNetwork = (networkId) => { var _a; return (_a = ALEO_SENDABLE_TOKENS_BY_NETWORK[networkId]) !== null && _a !== void 0 ? _a : []; };
+/**
+ * True when the owned record matches the given sendable token: same program
+ * + record name, and (for ARC-21) same token_id encoded in the plaintext.
+ *
+ * For ARC-21, multiple tokens share `token_registry.aleo/Token`, so the
+ * plaintext-level token_id check is what disambiguates wSOL records from
+ * USDT records, etc. We match by substring rather than parsing the full
+ * record DSL — the field literal `<digits>field` is unambiguous and the
+ * record DSL is stable across snarkVM versions.
+ */
+const recordMatchesSendableToken = (record, token) => {
+    if (record.program_name !== token.programId)
+        return false;
+    if (record.record_name !== token.recordName)
+        return false;
+    if (typeof record.record_plaintext !== 'string')
+        return false;
+    if (token.programKind !== 'arc21')
+        return true;
+    if (!token.tokenId)
+        return false;
+    return record.record_plaintext.includes(`token_id: ${token.tokenId}`);
+};
+/**
+ * Atomic-units amount from the record plaintext.
+ *
+ *   - credits → pre-parsed `microcredits` (decimal string).
+ *   - stablecoin / arc21 → parsed from `amount: <digits>u128` in plaintext.
+ *
+ * Returns `0n` when nothing parses — the caller's UI rules
+ * (sum / merge CTA / picker entry) all degrade gracefully on a zero amount.
+ */
+const extractRecordAtomicAmount = (record, token) => {
+    if (token.programKind === 'credits') {
+        if (typeof record.microcredits !== 'string')
+            return BigInt(0);
+        try {
+            return BigInt(record.microcredits);
+        }
+        catch (_a) {
+            return BigInt(0);
+        }
+    }
+    if (typeof record.record_plaintext !== 'string')
+        return BigInt(0);
+    const match = /amount:\s*(\d+)u128/.exec(record.record_plaintext);
+    if (!match)
+        return BigInt(0);
+    try {
+        return BigInt(match[1]);
+    }
+    catch (_b) {
+        return BigInt(0);
+    }
+};
+
+export { ALEO_CREDITS_DECIMALS, ALEO_CREDITS_PROGRAM, ALEO_SENDABLE_TOKENS_BY_NETWORK, ALEO_TOKEN_REGISTRY_PROGRAM, extractRecordAtomicAmount, getAleoSendableTokensForNetwork, recordMatchesSendableToken };

package/src/utils/aleoSendableTokens/index.d.ts

@@ -0,0 +1,2 @@
+export { ALEO_CREDITS_DECIMALS, ALEO_CREDITS_PROGRAM, ALEO_SENDABLE_TOKENS_BY_NETWORK, ALEO_TOKEN_REGISTRY_PROGRAM, extractRecordAtomicAmount, getAleoSendableTokensForNetwork, recordMatchesSendableToken, } from './aleoSendableTokens';
+export type { AleoOwnedRecord, AleoProgramKind, AleoSendableToken, } from './aleoSendableTokens';

package/src/utils/aleoShieldableTokens/aleoShieldableTokens.cjs

@@ -0,0 +1,119 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Per-network registry of tokens whose UNSHIELDED (public) balance can be
+ * shielded into a private record via `<program>/transfer_public_to_private`.
+ *
+ * The widget surfaces a "Shield Manually" CTA per matching token under the
+ * Unshielded tab; clicking it submits the transition with recipient = self,
+ * minting a private record for the full unshielded balance.
+ *
+ * Three transition signatures, mirroring the Send-side `aleoSendableTokens`
+ * registry:
+ *
+ *   - `credits`     `credits.aleo/transfer_public_to_private`
+ *                   inputs:     [recipient, amount]
+ *                   inputTypes: ['address.private', 'u64.public']
+ *
+ *   - `stablecoin`  `<stablecoin>.aleo/transfer_public_to_private`
+ *                   inputs:     [recipient, amount]
+ *                   inputTypes: ['address.private', 'u128.public']
+ *                   (No Sealance proof — `transfer_public_to_private` is NOT
+ *                   in the iframe's `SEALANCE_FUNCTIONS_REQUIRING_PROOF` set,
+ *                   matching the playground's
+ *                   `transfer_public_to_private_stablecoin.ts`.)
+ *
+ *   - `arc21`       `token_registry.aleo/transfer_public_to_private`
+ *                   inputs:     [token_id, recipient, amount, external_auth]
+ *                   inputTypes: ['field.public','address.private','u128.public','boolean.public']
+ *                   (`external_auth` is `false` for the 5 hyp_warp tokens —
+ *                   verified via app_metadata when the tokenIds were resolved.)
+ *
+ * The 5 ARC-21 entries are mainnet-only (Hyperlane warp routes are not
+ * deployed on testnet). Stablecoins + credits exist on both networks.
+ */
+const ALEO_MAINNET_NETWORK_ID = 0;
+const ALEO_TESTNET_NETWORK_ID = 1;
+const ALEO_CREDITS_PROGRAM = 'credits.aleo';
+const ALEO_TOKEN_REGISTRY_PROGRAM = 'token_registry.aleo';
+const ALEO_CREDITS_TOKEN = {
+    contractAddress: ALEO_CREDITS_PROGRAM,
+    decimals: 6,
+    name: 'Aleo Credits',
+    programId: ALEO_CREDITS_PROGRAM,
+    programKind: 'credits',
+    symbol: 'ALEO',
+};
+const buildStablecoin = (programId, symbol, name) => ({
+    contractAddress: programId,
+    decimals: 6,
+    name,
+    programId,
+    programKind: 'stablecoin',
+    symbol,
+});
+const buildArc21 = (args) => ({
+    contractAddress: args.warpProgram,
+    decimals: args.decimals,
+    externalAuthRequired: false,
+    name: args.name,
+    programId: ALEO_TOKEN_REGISTRY_PROGRAM,
+    programKind: 'arc21',
+    symbol: args.symbol,
+    tokenId: args.tokenId,
+});
+const ALEO_SHIELDABLE_TOKENS_BY_NETWORK = {
+    [ALEO_MAINNET_NETWORK_ID]: [
+        ALEO_CREDITS_TOKEN,
+        buildStablecoin('usad_stablecoin.aleo', 'USAD', 'USAD'),
+        buildStablecoin('usdcx_stablecoin.aleo', 'USDCx', 'USDCx'),
+        buildArc21({
+            decimals: 9,
+            name: 'Wrapped SOL',
+            symbol: 'wSOL',
+            tokenId: '2045969100091121326225168054634646230244820821909676777152465722877810201564field',
+            warpProgram: 'hyp_warp_token_sol.aleo',
+        }),
+        buildArc21({
+            decimals: 18,
+            name: 'Wrapped ETH',
+            symbol: 'wETH',
+            tokenId: '8189585964265444162798552221009403350643900573290534096996249214099143169251field',
+            warpProgram: 'hyp_warp_token_eth.aleo',
+        }),
+        buildArc21({
+            decimals: 8,
+            name: 'Wrapped BTC',
+            symbol: 'wBTC',
+            tokenId: '3491859903473482085250871387962132231204352466326026409883548131580582527809field',
+            warpProgram: 'hyp_warp_token_wbtc.aleo',
+        }),
+        buildArc21({
+            decimals: 6,
+            name: 'Tether USD',
+            symbol: 'USDT',
+            tokenId: '7881654794448182580124231856035865816599796419758925654292946277940935117913field',
+            warpProgram: 'hyp_warp_token_usdt.aleo',
+        }),
+        buildArc21({
+            decimals: 6,
+            name: 'USD Coin',
+            symbol: 'USDC',
+            tokenId: '4697275201844475848710842677807162058146139844643350200269139278887318953049field',
+            warpProgram: 'hyp_warp_token_usdc.aleo',
+        }),
+    ],
+    [ALEO_TESTNET_NETWORK_ID]: [
+        ALEO_CREDITS_TOKEN,
+        buildStablecoin('test_usad_stablecoin.aleo', 'USAD', 'USAD'),
+        buildStablecoin('test_usdcx_stablecoin.aleo', 'USDCx', 'USDCx'),
+    ],
+};
+const getAleoShieldableTokensForNetwork = (networkId) => { var _a; return (_a = ALEO_SHIELDABLE_TOKENS_BY_NETWORK[networkId]) !== null && _a !== void 0 ? _a : []; };
+const findAleoShieldableToken = (networkId, contractAddress) => getAleoShieldableTokensForNetwork(networkId).find((t) => t.contractAddress === contractAddress);
+
+exports.findAleoShieldableToken = findAleoShieldableToken;
+exports.getAleoShieldableTokensForNetwork = getAleoShieldableTokensForNetwork;

package/src/utils/aleoShieldableTokens/aleoShieldableTokens.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Per-network registry of tokens whose UNSHIELDED (public) balance can be
+ * shielded into a private record via `<program>/transfer_public_to_private`.
+ *
+ * The widget surfaces a "Shield Manually" CTA per matching token under the
+ * Unshielded tab; clicking it submits the transition with recipient = self,
+ * minting a private record for the full unshielded balance.
+ *
+ * Three transition signatures, mirroring the Send-side `aleoSendableTokens`
+ * registry:
+ *
+ *   - `credits`     `credits.aleo/transfer_public_to_private`
+ *                   inputs:     [recipient, amount]
+ *                   inputTypes: ['address.private', 'u64.public']
+ *
+ *   - `stablecoin`  `<stablecoin>.aleo/transfer_public_to_private`
+ *                   inputs:     [recipient, amount]
+ *                   inputTypes: ['address.private', 'u128.public']
+ *                   (No Sealance proof — `transfer_public_to_private` is NOT
+ *                   in the iframe's `SEALANCE_FUNCTIONS_REQUIRING_PROOF` set,
+ *                   matching the playground's
+ *                   `transfer_public_to_private_stablecoin.ts`.)
+ *
+ *   - `arc21`       `token_registry.aleo/transfer_public_to_private`
+ *                   inputs:     [token_id, recipient, amount, external_auth]
+ *                   inputTypes: ['field.public','address.private','u128.public','boolean.public']
+ *                   (`external_auth` is `false` for the 5 hyp_warp tokens —
+ *                   verified via app_metadata when the tokenIds were resolved.)
+ *
+ * The 5 ARC-21 entries are mainnet-only (Hyperlane warp routes are not
+ * deployed on testnet). Stablecoins + credits exist on both networks.
+ */
+export type AleoShieldProgramKind = 'arc21' | 'credits' | 'stablecoin';
+export type AleoShieldableToken = {
+    contractAddress: string;
+    symbol: string;
+    name: string;
+    decimals: number;
+    programId: string;
+    tokenId?: string;
+    externalAuthRequired?: boolean;
+    programKind: AleoShieldProgramKind;
+};
+export declare const getAleoShieldableTokensForNetwork: (networkId: number) => AleoShieldableToken[];
+export declare const findAleoShieldableToken: (networkId: number, contractAddress: string) => AleoShieldableToken | undefined;

package/src/utils/aleoShieldableTokens/aleoShieldableTokens.js

@@ -0,0 +1,114 @@
+'use client'
+/**
+ * Per-network registry of tokens whose UNSHIELDED (public) balance can be
+ * shielded into a private record via `<program>/transfer_public_to_private`.
+ *
+ * The widget surfaces a "Shield Manually" CTA per matching token under the
+ * Unshielded tab; clicking it submits the transition with recipient = self,
+ * minting a private record for the full unshielded balance.
+ *
+ * Three transition signatures, mirroring the Send-side `aleoSendableTokens`
+ * registry:
+ *
+ *   - `credits`     `credits.aleo/transfer_public_to_private`
+ *                   inputs:     [recipient, amount]
+ *                   inputTypes: ['address.private', 'u64.public']
+ *
+ *   - `stablecoin`  `<stablecoin>.aleo/transfer_public_to_private`
+ *                   inputs:     [recipient, amount]
+ *                   inputTypes: ['address.private', 'u128.public']
+ *                   (No Sealance proof — `transfer_public_to_private` is NOT
+ *                   in the iframe's `SEALANCE_FUNCTIONS_REQUIRING_PROOF` set,
+ *                   matching the playground's
+ *                   `transfer_public_to_private_stablecoin.ts`.)
+ *
+ *   - `arc21`       `token_registry.aleo/transfer_public_to_private`
+ *                   inputs:     [token_id, recipient, amount, external_auth]
+ *                   inputTypes: ['field.public','address.private','u128.public','boolean.public']
+ *                   (`external_auth` is `false` for the 5 hyp_warp tokens —
+ *                   verified via app_metadata when the tokenIds were resolved.)
+ *
+ * The 5 ARC-21 entries are mainnet-only (Hyperlane warp routes are not
+ * deployed on testnet). Stablecoins + credits exist on both networks.
+ */
+const ALEO_MAINNET_NETWORK_ID = 0;
+const ALEO_TESTNET_NETWORK_ID = 1;
+const ALEO_CREDITS_PROGRAM = 'credits.aleo';
+const ALEO_TOKEN_REGISTRY_PROGRAM = 'token_registry.aleo';
+const ALEO_CREDITS_TOKEN = {
+    contractAddress: ALEO_CREDITS_PROGRAM,
+    decimals: 6,
+    name: 'Aleo Credits',
+    programId: ALEO_CREDITS_PROGRAM,
+    programKind: 'credits',
+    symbol: 'ALEO',
+};
+const buildStablecoin = (programId, symbol, name) => ({
+    contractAddress: programId,
+    decimals: 6,
+    name,
+    programId,
+    programKind: 'stablecoin',
+    symbol,
+});
+const buildArc21 = (args) => ({
+    contractAddress: args.warpProgram,
+    decimals: args.decimals,
+    externalAuthRequired: false,
+    name: args.name,
+    programId: ALEO_TOKEN_REGISTRY_PROGRAM,
+    programKind: 'arc21',
+    symbol: args.symbol,
+    tokenId: args.tokenId,
+});
+const ALEO_SHIELDABLE_TOKENS_BY_NETWORK = {
+    [ALEO_MAINNET_NETWORK_ID]: [
+        ALEO_CREDITS_TOKEN,
+        buildStablecoin('usad_stablecoin.aleo', 'USAD', 'USAD'),
+        buildStablecoin('usdcx_stablecoin.aleo', 'USDCx', 'USDCx'),
+        buildArc21({
+            decimals: 9,
+            name: 'Wrapped SOL',
+            symbol: 'wSOL',
+            tokenId: '2045969100091121326225168054634646230244820821909676777152465722877810201564field',
+            warpProgram: 'hyp_warp_token_sol.aleo',
+        }),
+        buildArc21({
+            decimals: 18,
+            name: 'Wrapped ETH',
+            symbol: 'wETH',
+            tokenId: '8189585964265444162798552221009403350643900573290534096996249214099143169251field',
+            warpProgram: 'hyp_warp_token_eth.aleo',
+        }),
+        buildArc21({
+            decimals: 8,
+            name: 'Wrapped BTC',
+            symbol: 'wBTC',
+            tokenId: '3491859903473482085250871387962132231204352466326026409883548131580582527809field',
+            warpProgram: 'hyp_warp_token_wbtc.aleo',
+        }),
+        buildArc21({
+            decimals: 6,
+            name: 'Tether USD',
+            symbol: 'USDT',
+            tokenId: '7881654794448182580124231856035865816599796419758925654292946277940935117913field',
+            warpProgram: 'hyp_warp_token_usdt.aleo',
+        }),
+        buildArc21({
+            decimals: 6,
+            name: 'USD Coin',
+            symbol: 'USDC',
+            tokenId: '4697275201844475848710842677807162058146139844643350200269139278887318953049field',
+            warpProgram: 'hyp_warp_token_usdc.aleo',
+        }),
+    ],
+    [ALEO_TESTNET_NETWORK_ID]: [
+        ALEO_CREDITS_TOKEN,
+        buildStablecoin('test_usad_stablecoin.aleo', 'USAD', 'USAD'),
+        buildStablecoin('test_usdcx_stablecoin.aleo', 'USDCx', 'USDCx'),
+    ],
+};
+const getAleoShieldableTokensForNetwork = (networkId) => { var _a; return (_a = ALEO_SHIELDABLE_TOKENS_BY_NETWORK[networkId]) !== null && _a !== void 0 ? _a : []; };
+const findAleoShieldableToken = (networkId, contractAddress) => getAleoShieldableTokensForNetwork(networkId).find((t) => t.contractAddress === contractAddress);
+
+export { findAleoShieldableToken, getAleoShieldableTokensForNetwork };

package/src/utils/aleoShieldableTokens/index.d.ts

@@ -0,0 +1,2 @@
+export { findAleoShieldableToken, getAleoShieldableTokensForNetwork, } from './aleoShieldableTokens';
+export type { AleoShieldableToken, AleoShieldProgramKind, } from './aleoShieldableTokens';