@alephium/web3 0.15.0 → 0.16.0

package/dist/src/api/api-explorer.d.ts

@@ -29,6 +29,14 @@ export interface AddressInfo {
     /** @format int32 */
     txNumber: number;
 }
+export interface AddressTokenBalance {
+    /** @format 32-byte-hash */
+    tokenId: string;
+    /** @format uint256 */
+    balance: string;
+    /** @format uint256 */
+    lockedBalance: string;
+}
 export interface AssetOutput {
     /** @format int32 */
     hint: number;
@@ -55,9 +63,9 @@ export interface BlockEntryLite {
     hash: string;
     /** @format int64 */
     timestamp: number;
-    /** @format int32 */
+    /** @format group-index */
     chainFrom: number;
-    /** @format int32 */
+    /** @format group-index */
     chainTo: number;
     /** @format int32 */
     height: number;
@@ -101,6 +109,10 @@ export interface Event {
 export interface ExplorerInfo {
     releaseVersion: string;
     commit: string;
+    /** @format int32 */
+    migrationsVersion: number;
+    /** @format int64 */
+    lastFinalizedInputTime: number;
 }
 export interface Hashrate {
     /** @format int64 */
@@ -139,9 +151,9 @@ export interface LogbackValue {
 export interface MempoolTransaction {
     /** @format 32-byte-hash */
     hash: string;
-    /** @format int32 */
+    /** @format group-index */
     chainFrom: number;
-    /** @format int32 */
+    /** @format group-index */
     chainTo: number;
     inputs?: Input[];
     outputs?: Output[];
@@ -166,9 +178,9 @@ export interface OutputRef {
 export interface PendingTransaction {
     /** @format 32-byte-hash */
     hash: string;
-    /** @format int32 */
+    /** @format group-index */
     chainFrom: number;
-    /** @format int32 */
+    /** @format group-index */
     chainTo: number;
     inputs?: Input[];
     outputs?: Output[];
@@ -406,8 +418,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<Transaction[]>;
     };
     transactions: {
@@ -447,8 +457,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<Transaction[]>;
         /**
          * @description List transactions for given addresses
@@ -468,8 +476,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, data?: string[], params?: RequestParams) => Promise<Transaction[]>;
         /**
          * @description List transactions of a given address within a time-range
@@ -499,8 +505,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<Transaction[]>;
         /**
          * @description Get total transactions of a given address
@@ -544,8 +548,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<string[]>;
         /**
          * @description List address tokens
@@ -565,8 +567,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<Transaction[]>;
         /**
          * @description Get address balance of given token
@@ -575,7 +575,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name GetAddressesAddressTokensTokenIdBalance
          * @request GET:/addresses/{address}/tokens/{token_id}/balance
          */
-        getAddressesAddressTokensTokenIdBalance: (address: string, tokenId: string, params?: RequestParams) => Promise<AddressBalance>;
+        getAddressesAddressTokensTokenIdBalance: (address: string, tokenId: string, params?: RequestParams) => Promise<AddressTokenBalance>;
+        /**
+         * @description Get address tokens with balance
+         *
+         * @tags Addresses
+         * @name GetAddressesAddressTokensBalance
+         * @request GET:/addresses/{address}/tokens-balance
+         */
+        getAddressesAddressTokensBalance: (address: string, query?: {
+            /**
+             * Page number
+             * @format int32
+             */
+            page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
+            limit?: number;
+        }, params?: RequestParams) => Promise<AddressTokenBalance[]>;
         /**
          * @description Are the addresses used (at least 1 transaction)
          *
@@ -659,8 +678,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<TokenSupply[]>;
         /**
          * @description Get the ALPH total supply
@@ -730,8 +747,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<MempoolTransaction[]>;
     };
     tokens: {
@@ -753,8 +768,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<string[]>;
         /**
          * @description List token transactions
@@ -774,8 +787,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<Transaction[]>;
     };
     charts: {
@@ -870,8 +881,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<Event[]>;
         /**
          * @description Get contract events by contract and input addresses
@@ -891,8 +900,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<Event[]>;
     };
     contracts: {
@@ -922,8 +929,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-            /** Reverse pagination */
-            reverse?: boolean;
         }, params?: RequestParams) => Promise<SubContracts>;
     };
     utils: {

package/dist/src/api/api-explorer.js

@@ -357,6 +357,20 @@ class Api extends HttpClient {
                 format: 'json',
                 ...params
             }).then(utils_1.convertHttpResponse),
+            /**
+             * @description Get address tokens with balance
+             *
+             * @tags Addresses
+             * @name GetAddressesAddressTokensBalance
+             * @request GET:/addresses/{address}/tokens-balance
+             */
+            getAddressesAddressTokensBalance: (address, query, params = {}) => this.request({
+                path: `/addresses/${address}/tokens-balance`,
+                method: 'GET',
+                query: query,
+                format: 'json',
+                ...params
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Are the addresses used (at least 1 transaction)
              *

package/dist/src/api/types.js

@@ -51,11 +51,16 @@ function toApiNumber256(v) {
         return v.toString();
     }
     else if (typeof v === 'string') {
-        return v;
-    }
-    else {
-        throw new Error(`Invalid 256 bit number: ${v}`);
+        try {
+            if (BigInt(v).toString() === v) {
+                return v;
+            }
+        }
+        catch (_) {
+            throw new Error(`Invalid value: ${v}, expected a 256 bit number`);
+        }
     }
+    throw new Error(`Invalid value: ${v}, expected a 256 bit number`);
 }
 exports.toApiNumber256 = toApiNumber256;
 function toApiNumber256Optional(v) {
@@ -66,9 +71,13 @@ function fromApiNumber256(n) {
     return BigInt(n);
 }
 exports.fromApiNumber256 = fromApiNumber256;
-// TODO: check hex string
 function toApiByteVec(v) {
-    if (typeof v === 'string') {
+    if (typeof v !== 'string') {
+        throw new Error(`Invalid value: ${v}, expected a hex-string`);
+    }
+    if ((0, utils_1.isHexString)(v))
+        return v;
+    if ((0, utils_1.isBase58)(v)) {
         // try to convert from address to contract id
         try {
             const address = utils_1.bs58.decode(v);
@@ -77,13 +86,10 @@ function toApiByteVec(v) {
             }
         }
         catch (_) {
-            return v;
+            throw new Error(`Invalid hex-string: ${v}`);
         }
-        return v;
-    }
-    else {
-        throw new Error(`Invalid string: ${v}`);
     }
+    throw new Error(`Invalid hex-string: ${v}`);
 }
 exports.toApiByteVec = toApiByteVec;
 function toApiAddress(v) {
@@ -97,7 +103,7 @@ function toApiAddress(v) {
         }
     }
     else {
-        throw new Error(`Invalid string: ${v}`);
+        throw new Error(`Invalid value: ${v}, expected a base58 string`);
     }
 }
 exports.toApiAddress = toApiAddress;

package/dist/src/api/utils.d.ts

@@ -1,4 +1,5 @@
 import 'cross-fetch/polyfill';
+import { node } from '..';
 export declare function convertHttpResponse<T>(response: {
     status: number;
     data: T;
@@ -6,3 +7,4 @@ export declare function convertHttpResponse<T>(response: {
         detail: string;
     };
 }): T;
+export declare function isBalanceEqual(b0: node.Balance, b1: node.Balance): boolean;

package/dist/src/api/utils.js

@@ -17,7 +17,7 @@ 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.convertHttpResponse = void 0;
+exports.isBalanceEqual = exports.convertHttpResponse = void 0;
 require("cross-fetch/polyfill");
 function convertHttpResponse(response) {
     if (response.error) {
@@ -29,3 +29,27 @@ function convertHttpResponse(response) {
     }
 }
 exports.convertHttpResponse = convertHttpResponse;
+function isBalanceEqual(b0, b1) {
+    const isTokenBalanceEqual = (tokens0, tokens1) => {
+        const tokens0Size = tokens0?.length ?? 0;
+        const tokens1Size = tokens1?.length ?? 0;
+        if (tokens0Size !== tokens1Size)
+            return false;
+        if (tokens0Size === 0)
+            return true;
+        const _tokens1 = tokens1.map((t) => ({ ...t, used: false }));
+        return tokens0.every((t0) => {
+            const t1 = _tokens1.find((t) => !t.used && t0.id === t.id && t0.amount === t.amount);
+            if (t1 === undefined)
+                return false;
+            t1.used = true;
+            return true;
+        });
+    };
+    const isAlphBalanceEqual = b0.balance === b1.balance && b0.lockedBalance === b1.lockedBalance;
+    return (b0.utxoNum === b1.utxoNum &&
+        isAlphBalanceEqual &&
+        isTokenBalanceEqual(b0.tokenBalances, b1.tokenBalances) &&
+        isTokenBalanceEqual(b0.lockedTokenBalances, b1.lockedTokenBalances));
+}
+exports.isBalanceEqual = isBalanceEqual;

package/dist/src/contract/contract.js

@@ -704,7 +704,12 @@ class Contract extends Artifact {
         return signerParams;
     }
     buildByteCodeToDeploy(initialFields) {
-        return ralph.buildContractByteCode(this.bytecode, initialFields, this.fieldsSig);
+        try {
+            return ralph.buildContractByteCode(this.bytecode, initialFields, this.fieldsSig);
+        }
+        catch (error) {
+            throw new Error(`Failed to build bytecode for contract ${this.name}, error: ${error}`);
+        }
     }
     static fromApiEvents(events, addressToCodeHash, txId, getContractByCodeHash) {
         return events.map((event) => {
@@ -808,7 +813,12 @@ class Script extends Artifact {
         return signerParams;
     }
     buildByteCodeToDeploy(initialFields) {
-        return ralph.buildScriptByteCode(this.bytecodeTemplate, initialFields, this.fieldsSig);
+        try {
+            return ralph.buildScriptByteCode(this.bytecodeTemplate, initialFields, this.fieldsSig);
+        }
+        catch (error) {
+            throw new Error(`Failed to build bytecode for script ${this.name}, error: ${error}`);
+        }
     }
 }
 exports.Script = Script;

package/dist/src/contract/ralph.js

@@ -20,6 +20,7 @@ var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildDebugBytecode = exports.encodeContractField = exports.buildContractByteCode = exports.buildScriptByteCode = exports.encodeScriptField = exports.encodeScriptFieldAsString = exports.encodeAddress = exports.encodeByteVec = exports.encodeU256 = exports.encodeI256 = exports.encodeBool = void 0;
 const buffer_1 = require("buffer/");
+const api_1 = require("../api");
 const utils_1 = require("../utils");
 const bigIntZero = BigInt(0);
 class UnSigned {
@@ -200,40 +201,24 @@ function encodeScriptFieldAsString(tpe, value) {
     return buffer_1.Buffer.from(encodeScriptField(tpe, value)).toString('hex');
 }
 exports.encodeScriptFieldAsString = encodeScriptFieldAsString;
+// TODO: support array type
 function encodeScriptField(tpe, value) {
     switch (tpe) {
         case 'Bool':
-            if (typeof value === 'boolean') {
-                const byte = value ? Instruction.trueConst : Instruction.falseConst;
-                return new Uint8Array([byte]);
-            }
-            break;
+            const byte = (0, api_1.toApiBoolean)(value) ? Instruction.trueConst : Instruction.falseConst;
+            return new Uint8Array([byte]);
         case 'I256':
-            if (typeof value === 'number' && Number.isInteger(value)) {
-                return encodeScriptFieldI256(BigInt(value));
-            }
-            else if (typeof value === 'bigint') {
-                return encodeScriptFieldI256(value);
-            }
-            break;
+            const i256 = (0, api_1.toApiNumber256)(value);
+            return encodeScriptFieldI256(BigInt(i256));
         case 'U256':
-            if (typeof value === 'number' && Number.isInteger(value)) {
-                return encodeScriptFieldU256(BigInt(value));
-            }
-            else if (typeof value === 'bigint') {
-                return encodeScriptFieldU256(value);
-            }
-            break;
+            const u256 = (0, api_1.toApiNumber256)(value);
+            return encodeScriptFieldU256(BigInt(u256));
         case 'ByteVec':
-            if (typeof value === 'string') {
-                return new Uint8Array([Instruction.bytesConst, ...encodeByteVec(value)]);
-            }
-            break;
+            const hexStr = (0, api_1.toApiByteVec)(value);
+            return new Uint8Array([Instruction.bytesConst, ...encodeByteVec(hexStr)]);
         case 'Address':
-            if (typeof value === 'string') {
-                return new Uint8Array([Instruction.addressConst, ...encodeAddress(value)]);
-            }
-            break;
+            const address = (0, api_1.toApiAddress)(value);
+            return new Uint8Array([Instruction.addressConst, ...encodeAddress(address)]);
     }
     throw invalidScriptField(tpe, value);
 }
@@ -245,7 +230,7 @@ function buildScriptByteCode(bytecodeTemplate, fields, fieldsSig) {
         const fieldType = fieldsSig.types[`${fieldIndex}`];
         if (fieldName in fields) {
             const fieldValue = fields[`${fieldName}`];
-            return encodeScriptFieldAsString(fieldType, fieldValue);
+            return _encodeField(fieldName, () => encodeScriptFieldAsString(fieldType, fieldValue));
         }
         else {
             throw new Error(`The value of field ${fieldName} is not provided`);
@@ -253,6 +238,17 @@ function buildScriptByteCode(bytecodeTemplate, fields, fieldsSig) {
     });
 }
 exports.buildScriptByteCode = buildScriptByteCode;
+function _encodeField(fieldName, encodeFunc) {
+    try {
+        return encodeFunc();
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            throw new Error(`Invalid ${fieldName}, error: ${error.message}`);
+        }
+        throw error;
+    }
+}
 function encodeFields(fields, fieldsSig, mutable) {
     const fieldIndexes = fieldsSig.isMutable
         .map((_, index) => index)
@@ -262,7 +258,7 @@ function encodeFields(fields, fieldsSig, mutable) {
         const fieldType = fieldsSig.types[`${fieldIndex}`];
         if (fieldName in fields) {
             const fieldValue = fields[`${fieldName}`];
-            return encodeContractField(fieldType, fieldValue);
+            return _encodeField(fieldName, () => encodeContractField(fieldType, fieldValue));
         }
         else {
             throw new Error(`The value of field ${fieldName} is not provided`);
@@ -311,47 +307,26 @@ function encodeContractFieldArray(tpe, val) {
 function encodeContractField(tpe, value) {
     switch (tpe) {
         case 'Bool':
-            if (typeof value === 'boolean') {
-                const byte = value ? 1 : 0;
-                return [new Uint8Array([ApiValType.Bool, byte])];
-            }
-            break;
+            const byte = (0, api_1.toApiBoolean)(value) ? 1 : 0;
+            return [new Uint8Array([ApiValType.Bool, byte])];
         case 'I256':
-            if (typeof value === 'number' && Number.isInteger(value)) {
-                return [encodeContractFieldI256(BigInt(value))];
-            }
-            else if (typeof value === 'bigint') {
-                return [encodeContractFieldI256(value)];
-            }
-            break;
+            const i256 = (0, api_1.toApiNumber256)(value);
+            return [encodeContractFieldI256(BigInt(i256))];
         case 'U256':
-            if (typeof value === 'number' && Number.isInteger(value)) {
-                return [encodeContractFieldU256(BigInt(value))];
-            }
-            else if (typeof value === 'bigint') {
-                return [encodeContractFieldU256(value)];
-            }
-            break;
+            const u256 = (0, api_1.toApiNumber256)(value);
+            return [encodeContractFieldU256(BigInt(u256))];
         case 'ByteVec':
-            if (typeof value === 'string') {
-                return [new Uint8Array([ApiValType.ByteVec, ...encodeByteVec(value)])];
-            }
-            break;
+            const hexStr = (0, api_1.toApiByteVec)(value);
+            return [new Uint8Array([ApiValType.ByteVec, ...encodeByteVec(hexStr)])];
         case 'Address':
-            if (typeof value === 'string') {
-                return [new Uint8Array([ApiValType.Address, ...encodeAddress(value)])];
-            }
-            break;
+            const address = (0, api_1.toApiAddress)(value);
+            return [new Uint8Array([ApiValType.Address, ...encodeAddress(address)])];
         default:
             // Array type
             return encodeContractFieldArray(tpe, value);
     }
-    throw invalidVal(tpe, value);
 }
 exports.encodeContractField = encodeContractField;
-function invalidVal(tpe, value) {
-    return Error(`Invalid API value ${value} for type ${tpe}`);
-}
 function buildDebugBytecode(bytecode, bytecodePatch) {
     if (bytecodePatch === '') {
         return bytecode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -28,7 +28,7 @@
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
     "alephium_version": "2.3.5",
-    "explorer_backend_version": "1.13.5"
+    "explorer_backend_version": "1.15.1"
   },
   "type": "commonjs",
   "dependencies": {