@alephium/web3 1.8.5 → 1.9.0

package/dist/src/codec/instr-codec.d.ts

@@ -823,3 +823,5 @@ export declare class InstrCodec extends Codec<Instr> {
 }
 export declare const instrCodec: InstrCodec;
 export declare const instrsCodec: ArrayCodec<Instr>;
+export declare function toU256(number: bigint): Instr;
+export declare function toI256(number: bigint): Instr;

package/dist/src/codec/instr-codec.js

@@ -4,7 +4,7 @@ exports.I256Add = exports.BoolToByteVec = exports.BoolNeq = exports.BoolEq = exp
 exports.Sha3 = exports.Sha256 = exports.Keccak256 = exports.Blake2b = exports.Assert = exports.IfFalse = exports.IfTrue = exports.Jump = exports.IsContractAddress = exports.IsAssetAddress = exports.AddressToByteVec = exports.AddressNeq = exports.AddressEq = exports.ByteVecConcat = exports.ByteVecSize = exports.ByteVecNeq = exports.ByteVecEq = exports.U256ToByteVec = exports.U256ToI256 = exports.I256ToByteVec = exports.I256ToU256 = exports.U256SHR = exports.U256SHL = exports.U256Xor = exports.U256BitOr = exports.U256BitAnd = exports.U256ModMul = exports.U256ModSub = exports.U256ModAdd = exports.U256Ge = exports.U256Gt = exports.U256Le = exports.U256Lt = exports.U256Neq = exports.U256Eq = exports.U256Mod = exports.U256Div = exports.U256Mul = exports.U256Sub = exports.U256Add = exports.I256Ge = exports.I256Gt = exports.I256Le = exports.I256Lt = exports.I256Neq = exports.I256Eq = exports.I256Mod = exports.I256Div = exports.I256Mul = exports.I256Sub = void 0;
 exports.U256Exp = exports.I256Exp = exports.TxGasFee = exports.TxGasAmount = exports.TxGasPrice = exports.DEBUG = exports.BlockHash = exports.Swap = exports.AssertWithErrorCode = exports.Dup = exports.StoreLocalByIndex = exports.LoadLocalByIndex = exports.ContractIdToAddress = exports.Log9 = exports.Log8 = exports.Log7 = exports.Log6 = exports.EthEcRecover = exports.U256From32Byte = exports.U256From16Byte = exports.U256From8Byte = exports.U256From4Byte = exports.U256From2Byte = exports.U256From1Byte = exports.U256To32Byte = exports.U256To16Byte = exports.U256To8Byte = exports.U256To4Byte = exports.U256To2Byte = exports.U256To1Byte = exports.Zeros = exports.Encode = exports.ByteVecToAddress = exports.ByteVecSlice = exports.Log5 = exports.Log4 = exports.Log3 = exports.Log2 = exports.Log1 = exports.VerifyRelativeLocktime = exports.VerifyAbsoluteLocktime = exports.TxInputsSize = exports.TxInputAddressAt = exports.TxId = exports.BlockTarget = exports.BlockTimeStamp = exports.NetworkId = exports.VerifyED25519 = exports.VerifySecP256K1 = exports.VerifyTxSignature = void 0;
 exports.CreateSubContractAndTransferToken = exports.CopyCreateContractAndTransferToken = exports.CreateContractAndTransferToken = exports.ContractExists = exports.StoreMutFieldByIndex = exports.LoadMutFieldByIndex = exports.CopyCreateSubContractWithToken = exports.CopyCreateSubContract = exports.CreateSubContractWithToken = exports.CreateSubContract = exports.LockApprovedAssets = exports.BurnToken = exports.CopyCreateContractWithToken = exports.MigrateWithFields = exports.MigrateSimple = exports.ContractCodeHash = exports.ContractInitialStateHash = exports.CallerCodeHash = exports.CallerInitialStateHash = exports.IsCalledFromTxScript = exports.CallerAddress = exports.CallerContractId = exports.SelfAddress = exports.SelfContractId = exports.DestroySelf = exports.CopyCreateContract = exports.CreateContractWithToken = exports.CreateContract = exports.TransferTokenToSelf = exports.TransferTokenFromSelf = exports.TransferToken = exports.TransferAlphToSelf = exports.TransferAlphFromSelf = exports.TransferAlph = exports.IsPaying = exports.TokenRemaining = exports.AlphRemaining = exports.ApproveToken = exports.ApproveAlph = exports.StoreMutField = exports.LoadMutField = exports.GroupOfAddress = exports.BoolToString = exports.I256ToString = exports.U256ToString = exports.AddModN = exports.MulModN = exports.GetSegregatedSignature = exports.VerifyBIP340Schnorr = exports.U256ModExp = void 0;
-exports.instrsCodec = exports.instrCodec = exports.InstrCodec = exports.CallExternalBySelector = exports.MethodSelector = exports.CreateMapEntry = exports.MinimalContractDeposit = exports.PayGasFee = exports.LoadImmFieldByIndex = exports.LoadImmField = exports.ALPHTokenId = exports.SubContractIdOf = exports.SubContractId = exports.NullContractAddress = exports.CopyCreateSubContractAndTransferToken = void 0;
+exports.toI256 = exports.toU256 = exports.instrsCodec = exports.instrCodec = exports.InstrCodec = exports.CallExternalBySelector = exports.MethodSelector = exports.CreateMapEntry = exports.MinimalContractDeposit = exports.PayGasFee = exports.LoadImmFieldByIndex = exports.LoadImmField = exports.ALPHTokenId = exports.SubContractIdOf = exports.SubContractId = exports.NullContractAddress = exports.CopyCreateSubContractAndTransferToken = void 0;
 /*
 Copyright 2018 - 2022 The Alephium Authors
 This file is part of the alephium project.
@@ -1090,3 +1090,56 @@ class InstrCodec extends codec_1.Codec {
 exports.InstrCodec = InstrCodec;
 exports.instrCodec = new InstrCodec();
 exports.instrsCodec = new array_codec_1.ArrayCodec(exports.instrCodec);
+function checkU256(number) {
+    if (number < 0n || number >= 2n ** 256n) {
+        throw new Error(`Invalid u256 number: ${number}`);
+    }
+}
+function toU256(number) {
+    checkU256(number);
+    switch (number) {
+        case 0n:
+            return exports.U256Const0;
+        case 1n:
+            return exports.U256Const1;
+        case 2n:
+            return exports.U256Const2;
+        case 3n:
+            return exports.U256Const3;
+        case 4n:
+            return exports.U256Const4;
+        case 5n:
+            return exports.U256Const5;
+        default:
+            return (0, exports.U256Const)(number);
+    }
+}
+exports.toU256 = toU256;
+function checkI256(number) {
+    const upperBound = 2n ** 255n;
+    if (number < -upperBound || number >= upperBound) {
+        throw new Error(`Invalid i256 number: ${number}`);
+    }
+}
+function toI256(number) {
+    checkI256(number);
+    switch (number) {
+        case 0n:
+            return exports.I256Const0;
+        case 1n:
+            return exports.I256Const1;
+        case 2n:
+            return exports.I256Const2;
+        case 3n:
+            return exports.I256Const3;
+        case 4n:
+            return exports.I256Const4;
+        case 5n:
+            return exports.I256Const5;
+        case -1n:
+            return exports.I256ConstN1;
+        default:
+            return (0, exports.I256Const)(number);
+    }
+}
+exports.toI256 = toI256;

package/dist/src/constants.d.ts

@@ -4,7 +4,11 @@ export declare const MIN_UTXO_SET_AMOUNT: bigint;
 export declare const ALPH_TOKEN_ID: string;
 export declare const ONE_ALPH: bigint;
 export declare const DUST_AMOUNT: bigint;
+/**
+ * @deprecated `ZERO_ADDRESS` is deprecated. Use `NULL_CONTRACT_ADDRESS` instead.
+ */
 export declare const ZERO_ADDRESS = "tgx7VNFoP9DJiFMFgXXtafQZkUvyEdDHT9ryamHJYrjq";
+export declare const NULL_CONTRACT_ADDRESS = "tgx7VNFoP9DJiFMFgXXtafQZkUvyEdDHT9ryamHJYrjq";
 export declare const DEFAULT_GAS_AMOUNT = 20000;
 export declare const DEFAULT_GAS_PRICE: bigint;
 export declare const DEFAULT_GAS_ATTOALPH_AMOUNT: bigint;

package/dist/src/constants.js

@@ -17,14 +17,18 @@ You should have received a copy of the GNU Lesser General Public License
 along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MAP_ENTRY_DEPOSIT = exports.MINIMAL_CONTRACT_DEPOSIT = exports.DEFAULT_GAS_ALPH_AMOUNT = exports.DEFAULT_GAS_ATTOALPH_AMOUNT = exports.DEFAULT_GAS_PRICE = exports.DEFAULT_GAS_AMOUNT = exports.ZERO_ADDRESS = exports.DUST_AMOUNT = exports.ONE_ALPH = exports.ALPH_TOKEN_ID = exports.MIN_UTXO_SET_AMOUNT = exports.TOTAL_NUMBER_OF_CHAINS = exports.TOTAL_NUMBER_OF_GROUPS = void 0;
+exports.MAP_ENTRY_DEPOSIT = exports.MINIMAL_CONTRACT_DEPOSIT = exports.DEFAULT_GAS_ALPH_AMOUNT = exports.DEFAULT_GAS_ATTOALPH_AMOUNT = exports.DEFAULT_GAS_PRICE = exports.DEFAULT_GAS_AMOUNT = exports.NULL_CONTRACT_ADDRESS = exports.ZERO_ADDRESS = exports.DUST_AMOUNT = exports.ONE_ALPH = exports.ALPH_TOKEN_ID = exports.MIN_UTXO_SET_AMOUNT = exports.TOTAL_NUMBER_OF_CHAINS = exports.TOTAL_NUMBER_OF_GROUPS = void 0;
 exports.TOTAL_NUMBER_OF_GROUPS = 4;
 exports.TOTAL_NUMBER_OF_CHAINS = exports.TOTAL_NUMBER_OF_GROUPS * exports.TOTAL_NUMBER_OF_GROUPS;
 exports.MIN_UTXO_SET_AMOUNT = BigInt(1000000000000);
 exports.ALPH_TOKEN_ID = ''.padStart(64, '0');
 exports.ONE_ALPH = 10n ** 18n;
 exports.DUST_AMOUNT = 10n ** 15n;
+/**
+ * @deprecated `ZERO_ADDRESS` is deprecated. Use `NULL_CONTRACT_ADDRESS` instead.
+ */
 exports.ZERO_ADDRESS = 'tgx7VNFoP9DJiFMFgXXtafQZkUvyEdDHT9ryamHJYrjq';
+exports.NULL_CONTRACT_ADDRESS = 'tgx7VNFoP9DJiFMFgXXtafQZkUvyEdDHT9ryamHJYrjq';
 exports.DEFAULT_GAS_AMOUNT = 20000;
 exports.DEFAULT_GAS_PRICE = 10n ** 11n;
 exports.DEFAULT_GAS_ATTOALPH_AMOUNT = BigInt(exports.DEFAULT_GAS_AMOUNT) * exports.DEFAULT_GAS_PRICE;

package/dist/src/contract/dapp-tx-builder.d.ts

@@ -0,0 +1,26 @@
+import { Val } from '../api';
+import { Instr } from '../codec';
+import { SignExecuteScriptTxParams } from '../signer';
+import { HexString } from '../utils';
+export declare class DappTransactionBuilder {
+    readonly callerAddress: string;
+    private callerLockupScript;
+    private approvedAssets;
+    private instrs;
+    constructor(callerAddress: string);
+    callContract(params: {
+        contractAddress: string;
+        methodIndex: number;
+        args: Val[];
+        attoAlphAmount?: bigint;
+        tokens?: {
+            id: HexString;
+            amount: bigint;
+        }[];
+        retLength?: number;
+    }): this;
+    getResult(): SignExecuteScriptTxParams;
+    private addTokenToMap;
+    private approveTokens;
+}
+export declare function genArgs(args: Val[]): Instr[];

package/dist/src/contract/dapp-tx-builder.js

@@ -0,0 +1,187 @@
+"use strict";
+/*
+Copyright 2018 - 2022 The Alephium Authors
+This file is part of the alephium project.
+
+The library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+The library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with the library. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.genArgs = exports.DappTransactionBuilder = void 0;
+const address_1 = require("../address");
+const codec_1 = require("../codec");
+const lockup_script_codec_1 = require("../codec/lockup-script-codec");
+const script_codec_1 = require("../codec/script-codec");
+const constants_1 = require("../constants");
+const error_1 = require("../error");
+const utils_1 = require("../utils");
+class DappTransactionBuilder {
+    constructor(callerAddress) {
+        this.callerAddress = callerAddress;
+        try {
+            this.callerLockupScript = lockup_script_codec_1.lockupScriptCodec.decode((0, utils_1.base58ToBytes)(this.callerAddress));
+            if (this.callerLockupScript.kind !== 'P2PKH' && this.callerLockupScript.kind !== 'P2SH') {
+                throw new Error(`Expected a P2PKH address or P2SH address`);
+            }
+        }
+        catch (error) {
+            throw new error_1.TraceableError(`Invalid caller address: ${callerAddress}`, error);
+        }
+        this.approvedAssets = new Map();
+        this.instrs = [];
+    }
+    callContract(params) {
+        if (!(0, utils_1.isBase58)(params.contractAddress)) {
+            throw new Error(`Invalid contract address: ${params.contractAddress}, expected a base58 string`);
+        }
+        if (!(0, address_1.isContractAddress)(params.contractAddress)) {
+            throw new Error(`Invalid contract address: ${params.contractAddress}, expected a P2C address`);
+        }
+        if (params.methodIndex < 0) {
+            throw new Error(`Invalid method index: ${params.methodIndex}`);
+        }
+        const allTokens = (params.tokens ?? []).concat([{ id: constants_1.ALPH_TOKEN_ID, amount: params.attoAlphAmount ?? 0n }]);
+        const instrs = [
+            ...genApproveAssets(this.callerLockupScript, this.approveTokens(allTokens)),
+            ...genContractCall(params.contractAddress, params.methodIndex, params.args, params.retLength ?? 0)
+        ];
+        this.instrs.push(...instrs);
+        return this;
+    }
+    getResult() {
+        const method = {
+            isPublic: true,
+            usePreapprovedAssets: this.approvedAssets.size > 0,
+            useContractAssets: false,
+            usePayToContractOnly: false,
+            argsLength: 0,
+            localsLength: 0,
+            returnLength: 0,
+            instrs: this.instrs
+        };
+        const script = { methods: [method] };
+        const bytecode = script_codec_1.scriptCodec.encode(script);
+        const tokens = Array.from(this.approvedAssets.entries()).map(([id, amount]) => ({ id, amount }));
+        this.approvedAssets.clear();
+        this.instrs = [];
+        return {
+            signerAddress: this.callerAddress,
+            signerKeyType: this.callerLockupScript.kind === 'P2PKH' ? 'default' : 'bip340-schnorr',
+            bytecode: (0, utils_1.binToHex)(bytecode),
+            attoAlphAmount: tokens.find((t) => t.id === constants_1.ALPH_TOKEN_ID)?.amount,
+            tokens: tokens.filter((t) => t.id !== constants_1.ALPH_TOKEN_ID)
+        };
+    }
+    addTokenToMap(tokenId, amount, map) {
+        const current = map.get(tokenId);
+        if (current !== undefined) {
+            map.set(tokenId, current + amount);
+        }
+        else if (amount > 0n) {
+            map.set(tokenId, amount);
+        }
+    }
+    approveTokens(tokens) {
+        const tokenAmounts = new Map();
+        tokens.forEach((token) => {
+            if (!((0, utils_1.isHexString)(token.id) && token.id.length === 64)) {
+                throw new Error(`Invalid token id: ${token.id}`);
+            }
+            if (token.amount < 0n) {
+                throw new Error(`Invalid token amount: ${token.amount}`);
+            }
+            this.addTokenToMap(token.id, token.amount, tokenAmounts);
+            this.addTokenToMap(token.id, token.amount, this.approvedAssets);
+        });
+        return Array.from(tokenAmounts.entries()).map(([id, amount]) => ({ id, amount }));
+    }
+}
+exports.DappTransactionBuilder = DappTransactionBuilder;
+function genApproveAssets(callerLockupScript, tokens) {
+    if (tokens.length === 0) {
+        return [];
+    }
+    const approveInstrs = tokens.flatMap((token) => {
+        if (token.id === constants_1.ALPH_TOKEN_ID) {
+            return [(0, codec_1.U256Const)(token.amount), codec_1.ApproveAlph];
+        }
+        else {
+            const tokenId = (0, codec_1.BytesConst)((0, utils_1.hexToBinUnsafe)(token.id));
+            return [tokenId, (0, codec_1.U256Const)(token.amount), codec_1.ApproveToken];
+        }
+    });
+    return [
+        (0, codec_1.AddressConst)(callerLockupScript),
+        ...Array.from(Array(tokens.length - 1).keys()).map(() => codec_1.Dup),
+        ...approveInstrs
+    ];
+}
+function bigintToNumeric(value) {
+    return value >= 0 ? (0, codec_1.toU256)(value) : (0, codec_1.toI256)(value);
+}
+function strToNumeric(str) {
+    const regex = /^-?\d+[ui]?$/;
+    if (regex.test(str)) {
+        if (str.endsWith('i'))
+            return (0, codec_1.toI256)(BigInt(str.slice(0, str.length - 1)));
+        if (str.endsWith('u'))
+            return (0, codec_1.toU256)(BigInt(str.slice(0, str.length - 1)));
+        return bigintToNumeric(BigInt(str));
+    }
+    throw new Error(`Invalid number: ${str}`);
+}
+function toAddressOpt(str) {
+    if (!(0, utils_1.isBase58)(str))
+        return undefined;
+    try {
+        return lockup_script_codec_1.lockupScriptCodec.decode((0, utils_1.base58ToBytes)(str));
+    }
+    catch (_) {
+        return undefined;
+    }
+}
+function genArgs(args) {
+    return args.flatMap((arg) => {
+        if (typeof arg === 'boolean')
+            return arg ? [codec_1.ConstTrue] : [codec_1.ConstFalse];
+        if (typeof arg === 'bigint')
+            return bigintToNumeric(arg);
+        if (typeof arg === 'string') {
+            if ((0, utils_1.isHexString)(arg))
+                return [(0, codec_1.BytesConst)((0, utils_1.hexToBinUnsafe)(arg))];
+            const addressOpt = toAddressOpt(arg);
+            if (addressOpt !== undefined)
+                return (0, codec_1.AddressConst)(addressOpt);
+            return strToNumeric(arg);
+        }
+        if (Array.isArray(arg))
+            return genArgs(arg);
+        if (arg instanceof Map)
+            throw new Error(`Map cannot be used as a function argument`);
+        if (typeof arg === 'object')
+            return genArgs(Object.values(arg));
+        throw new Error(`Unknown argument type: ${typeof arg}, arg: ${arg}`);
+    });
+}
+exports.genArgs = genArgs;
+function genContractCall(contractAddress, methodIndex, args, retLength) {
+    const argInstrs = genArgs(args);
+    return [
+        ...argInstrs,
+        (0, codec_1.toU256)(BigInt(argInstrs.length)),
+        (0, codec_1.toU256)(BigInt(retLength)),
+        (0, codec_1.BytesConst)((0, address_1.contractIdFromAddress)(contractAddress)),
+        (0, codec_1.CallExternal)(methodIndex),
+        ...Array.from(Array(retLength).keys()).map(() => codec_1.Pop)
+    ];
+}

package/dist/src/contract/index.d.ts

@@ -3,3 +3,4 @@ export * from './contract';
 export * from './events';
 export * from './script-simulator';
 export * from './deployment';
+export { DappTransactionBuilder } from './dapp-tx-builder';

package/dist/src/contract/index.js

@@ -31,8 +31,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DappTransactionBuilder = void 0;
 __exportStar(require("./ralph"), exports);
 __exportStar(require("./contract"), exports);
 __exportStar(require("./events"), exports);
 __exportStar(require("./script-simulator"), exports);
 __exportStar(require("./deployment"), exports);
+var dapp_tx_builder_1 = require("./dapp-tx-builder");
+Object.defineProperty(exports, "DappTransactionBuilder", { enumerable: true, get: function () { return dapp_tx_builder_1.DappTransactionBuilder; } });

package/dist/src/contract/ralph.js

@@ -91,42 +91,10 @@ function invalidScriptField(tpe, value) {
     return Error(`Invalid script field ${value} for type ${tpe}`);
 }
 function encodeScriptFieldI256(value) {
-    switch (value) {
-        case 0n:
-            return codec_1.instrCodec.encode(codec_1.I256Const0);
-        case 1n:
-            return codec_1.instrCodec.encode(codec_1.I256Const1);
-        case 2n:
-            return codec_1.instrCodec.encode(codec_1.I256Const2);
-        case 3n:
-            return codec_1.instrCodec.encode(codec_1.I256Const3);
-        case 4n:
-            return codec_1.instrCodec.encode(codec_1.I256Const4);
-        case 5n:
-            return codec_1.instrCodec.encode(codec_1.I256Const5);
-        case -1n:
-            return codec_1.instrCodec.encode(codec_1.I256ConstN1);
-        default:
-            return codec_1.instrCodec.encode((0, codec_1.I256Const)(value));
-    }
+    return codec_1.instrCodec.encode((0, codec_1.toI256)(value));
 }
 function encodeScriptFieldU256(value) {
-    switch (value) {
-        case 0n:
-            return codec_1.instrCodec.encode(codec_1.U256Const0);
-        case 1n:
-            return codec_1.instrCodec.encode(codec_1.U256Const1);
-        case 2n:
-            return codec_1.instrCodec.encode(codec_1.U256Const2);
-        case 3n:
-            return codec_1.instrCodec.encode(codec_1.U256Const3);
-        case 4n:
-            return codec_1.instrCodec.encode(codec_1.U256Const4);
-        case 5n:
-            return codec_1.instrCodec.encode(codec_1.U256Const5);
-        default:
-            return codec_1.instrCodec.encode((0, codec_1.U256Const)(value));
-    }
+    return codec_1.instrCodec.encode((0, codec_1.toU256)(value));
 }
 function encodeScriptFieldAsString(tpe, value) {
     return (0, utils_1.binToHex)(encodeScriptField(tpe, value));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "1.8.5",
+  "version": "1.9.0",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -45,14 +45,14 @@
     "bn.js": "5.2.1",
     "cross-fetch": "^3.1.5",
     "crypto-browserify": "^3.12.0",
-    "elliptic": "6.5.4",
+    "elliptic": "6.6.0",
     "eventemitter3": "^4.0.7",
     "path-browserify": "^1.0.1",
     "stream-browserify": "^3.0.0"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.21.3",
-    "@types/elliptic": "^6.4.14",
+    "@types/elliptic": "^6.4.18",
     "@types/find-up": "^2.1.1",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.5.2",

package/src/codec/instr-codec.ts

@@ -20,7 +20,7 @@ import { ArrayCodec } from './array-codec'
 import { i256Codec, u256Codec, i32Codec } from './compact-int-codec'
 import { ByteString, byteStringCodec, byteStringsCodec } from './bytestring-codec'
 import { LockupScript, lockupScriptCodec } from './lockup-script-codec'
-import { byteCodec, Codec } from './codec'
+import { assert, byteCodec, Codec } from './codec'
 import { intAs4BytesCodec } from './int-as-4bytes-codec'
 import { Reader } from './reader'
 export type Instr =
@@ -1263,3 +1263,58 @@ export class InstrCodec extends Codec<Instr> {
 }
 export const instrCodec = new InstrCodec()
 export const instrsCodec = new ArrayCodec<Instr>(instrCodec)
+
+function checkU256(number: bigint) {
+  if (number < 0n || number >= 2n ** 256n) {
+    throw new Error(`Invalid u256 number: ${number}`)
+  }
+}
+
+export function toU256(number: bigint) {
+  checkU256(number)
+  switch (number) {
+    case 0n:
+      return U256Const0
+    case 1n:
+      return U256Const1
+    case 2n:
+      return U256Const2
+    case 3n:
+      return U256Const3
+    case 4n:
+      return U256Const4
+    case 5n:
+      return U256Const5
+    default:
+      return U256Const(number)
+  }
+}
+
+function checkI256(number: bigint) {
+  const upperBound = 2n ** 255n
+  if (number < -upperBound || number >= upperBound) {
+    throw new Error(`Invalid i256 number: ${number}`)
+  }
+}
+
+export function toI256(number: bigint) {
+  checkI256(number)
+  switch (number) {
+    case 0n:
+      return I256Const0
+    case 1n:
+      return I256Const1
+    case 2n:
+      return I256Const2
+    case 3n:
+      return I256Const3
+    case 4n:
+      return I256Const4
+    case 5n:
+      return I256Const5
+    case -1n:
+      return I256ConstN1
+    default:
+      return I256Const(number)
+  }
+}

package/src/constants.ts

@@ -22,7 +22,11 @@ export const MIN_UTXO_SET_AMOUNT = BigInt(1000000000000)
 export const ALPH_TOKEN_ID = ''.padStart(64, '0')
 export const ONE_ALPH = 10n ** 18n
 export const DUST_AMOUNT = 10n ** 15n
+/**
+ * @deprecated `ZERO_ADDRESS` is deprecated. Use `NULL_CONTRACT_ADDRESS` instead.
+ */
 export const ZERO_ADDRESS = 'tgx7VNFoP9DJiFMFgXXtafQZkUvyEdDHT9ryamHJYrjq'
+export const NULL_CONTRACT_ADDRESS = 'tgx7VNFoP9DJiFMFgXXtafQZkUvyEdDHT9ryamHJYrjq'
 export const DEFAULT_GAS_AMOUNT = 20000
 export const DEFAULT_GAS_PRICE = 10n ** 11n
 export const DEFAULT_GAS_ATTOALPH_AMOUNT = BigInt(DEFAULT_GAS_AMOUNT) * DEFAULT_GAS_PRICE