@alephium/web3 0.2.0-rc.1 → 0.2.0-rc.12

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

@@ -12,14 +12,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Api = exports.HttpClient = exports.ContentType = void 0;
 require("cross-fetch/polyfill");
-function convertHttpResponse(response) {
-    if (response.error) {
-        throw new Error(response.error.detail);
-    }
-    else {
-        return response.data;
-    }
-}
+const utils_1 = require("./utils");
 var ContentType;
 (function (ContentType) {
     ContentType["Json"] = "application/json";
@@ -113,8 +106,6 @@ class HttpClient {
                 if (cancelToken) {
                     this.abortControllers.delete(cancelToken);
                 }
-                if (!response.ok)
-                    throw data;
                 return data;
             });
         };
@@ -177,7 +168,7 @@ class Api extends HttpClient {
                 query: query,
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get a block with hash
              *
@@ -190,7 +181,7 @@ class Api extends HttpClient {
                 method: 'GET',
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get block's transactions
              *
@@ -204,7 +195,7 @@ class Api extends HttpClient {
                 query: query,
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse)
+            }).then(utils_1.convertHttpResponse)
         };
         this.transactions = {
             /**
@@ -219,7 +210,7 @@ class Api extends HttpClient {
                 method: 'GET',
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse)
+            }).then(utils_1.convertHttpResponse)
         };
         this.addresses = {
             /**
@@ -234,7 +225,7 @@ class Api extends HttpClient {
                 method: 'GET',
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description List transactions of a given address
              *
@@ -248,7 +239,7 @@ class Api extends HttpClient {
                 query: query,
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get total transactions of a given address
              *
@@ -261,7 +252,7 @@ class Api extends HttpClient {
                 method: 'GET',
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get address balance
              *
@@ -274,7 +265,7 @@ class Api extends HttpClient {
                 method: 'GET',
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse)
+            }).then(utils_1.convertHttpResponse)
         };
         this.infos = {
             /**
@@ -289,7 +280,7 @@ class Api extends HttpClient {
                 method: 'GET',
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description List latest height for each chain
              *
@@ -302,7 +293,7 @@ class Api extends HttpClient {
                 method: 'GET',
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get token supply list
              *
@@ -316,7 +307,7 @@ class Api extends HttpClient {
                 query: query,
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get the ALPH total supply
              *
@@ -328,7 +319,7 @@ class Api extends HttpClient {
                 path: `/infos/supply/total-alph`,
                 method: 'GET',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get the ALPH circulating supply
              *
@@ -340,7 +331,7 @@ class Api extends HttpClient {
                 path: `/infos/supply/circulating-alph`,
                 method: 'GET',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get the ALPH reserved supply
              *
@@ -352,7 +343,7 @@ class Api extends HttpClient {
                 path: `/infos/supply/reserved-alph`,
                 method: 'GET',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get the ALPH locked supply
              *
@@ -364,7 +355,7 @@ class Api extends HttpClient {
                 path: `/infos/supply/locked-alph`,
                 method: 'GET',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get the total number of transactions
              *
@@ -376,7 +367,7 @@ class Api extends HttpClient {
                 path: `/infos/total-transactions`,
                 method: 'GET',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Get the average block time for each chain
              *
@@ -389,7 +380,7 @@ class Api extends HttpClient {
                 method: 'GET',
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse)
+            }).then(utils_1.convertHttpResponse)
         };
         this.charts = {
             /**
@@ -406,7 +397,7 @@ class Api extends HttpClient {
                 query: query,
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description `interval-type` query param: hourly, daily
              *
@@ -421,7 +412,7 @@ class Api extends HttpClient {
                 query: query,
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description `interval-type` query param: hourly, daily
              *
@@ -436,7 +427,7 @@ class Api extends HttpClient {
                 query: query,
                 format: 'json',
                 ...params
-            }).then(convertHttpResponse)
+            }).then(utils_1.convertHttpResponse)
         };
         this.utils = {
             /**
@@ -450,7 +441,7 @@ class Api extends HttpClient {
                 path: `/utils/sanity-check`,
                 method: 'PUT',
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Update global log level, accepted: TRACE, DEBUG, INFO, WARN, ERROR
              *
@@ -463,7 +454,7 @@ class Api extends HttpClient {
                 method: 'PUT',
                 body: data,
                 ...params
-            }).then(convertHttpResponse),
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description Update logging file, only logback.xml is accepted
              *
@@ -476,7 +467,7 @@ class Api extends HttpClient {
                 method: 'PUT',
                 body: data,
                 ...params
-            }).then(convertHttpResponse)
+            }).then(utils_1.convertHttpResponse)
         };
     }
 }

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

@@ -1,10 +1,11 @@
 import { Api as NodeApi } from './api-alephium';
 import { Api as ExplorerApi } from './api-explorer';
-export declare class NodeProvider extends NodeApi<null> {
-    constructor(baseUrl: string);
+export declare class NodeProvider extends NodeApi<string> {
+    constructor(baseUrl: string, apiKey?: string);
 }
 export declare class ExplorerProvider extends ExplorerApi<null> {
     constructor(baseUrl: string);
 }
 export * as node from './api-alephium';
 export * as explorer from './api-explorer';
+export * from './types';

package/dist/src/api/index.js

@@ -18,7 +18,11 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -35,13 +39,27 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+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.explorer = exports.node = exports.ExplorerProvider = exports.NodeProvider = void 0;
 const api_alephium_1 = require("./api-alephium");
 const api_explorer_1 = require("./api-explorer");
 class NodeProvider extends api_alephium_1.Api {
-    constructor(baseUrl) {
-        super({ baseUrl: baseUrl });
+    constructor(baseUrl, apiKey) {
+        // eslint-disable-next-line security/detect-possible-timing-attacks
+        if (apiKey === undefined) {
+            super({ baseUrl: baseUrl });
+        }
+        else {
+            super({
+                baseUrl: baseUrl,
+                baseApiParams: { secure: true },
+                securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {})
+            });
+            this.setSecurityData(apiKey);
+        }
     }
 }
 exports.NodeProvider = NodeProvider;
@@ -53,3 +71,4 @@ class ExplorerProvider extends api_explorer_1.Api {
 exports.ExplorerProvider = ExplorerProvider;
 exports.node = __importStar(require("./api-alephium"));
 exports.explorer = __importStar(require("./api-explorer"));
+__exportStar(require("./types"), exports);

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

@@ -0,0 +1,23 @@
+import * as node from './api-alephium';
+export declare type Number256 = number | bigint | string;
+export declare type Val = Number256 | boolean | string | Val[];
+export declare type NamedVals = Record<string, Val>;
+export interface Token {
+    id: string;
+    amount: Number256;
+}
+export declare function toApiToken(token: Token): node.Token;
+export declare function toApiTokens(tokens?: Token[]): node.Token[] | undefined;
+export declare function fromApiToken(token: node.Token): Token;
+export declare function fromApiTokens(tokens?: node.Token[]): Token[] | undefined;
+export declare function toApiBoolean(v: Val): boolean;
+export declare function toApiNumber256(v: Val): string;
+export declare function toApiNumber256Optional(v?: Val): string | undefined;
+export declare function fromApiNumber256(n: string): Number256;
+export declare function toApiByteVec(v: Val): string;
+export declare function toApiAddress(v: Val): string;
+export declare function toApiArray(tpe: string, v: Val): node.Val;
+export declare function toApiVal(v: Val, tpe: string): node.Val;
+export declare function fromApiVals(vals: node.Val[], names: string[], types: string[]): NamedVals;
+export declare function fromApiArray(vals: node.Val[], types: string[]): Val[];
+export declare function fromApiVal(v: node.Val, tpe: string): Val;

package/dist/src/api/types.js

@@ -0,0 +1,240 @@
+"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.fromApiVal = exports.fromApiArray = exports.fromApiVals = exports.toApiVal = exports.toApiArray = exports.toApiAddress = exports.toApiByteVec = exports.fromApiNumber256 = exports.toApiNumber256Optional = exports.toApiNumber256 = exports.toApiBoolean = exports.fromApiTokens = exports.fromApiToken = exports.toApiTokens = exports.toApiToken = void 0;
+const utils_1 = require("../utils");
+utils_1.assertType;
+function toApiToken(token) {
+    return { id: token.id, amount: toApiNumber256(token.amount) };
+}
+exports.toApiToken = toApiToken;
+function toApiTokens(tokens) {
+    return tokens?.map(toApiToken);
+}
+exports.toApiTokens = toApiTokens;
+function fromApiToken(token) {
+    return { id: token.id, amount: fromApiNumber256(token.amount) };
+}
+exports.fromApiToken = fromApiToken;
+function fromApiTokens(tokens) {
+    return tokens?.map(fromApiToken);
+}
+exports.fromApiTokens = fromApiTokens;
+function toApiBoolean(v) {
+    if (typeof v === 'boolean') {
+        return v;
+    }
+    else {
+        throw new Error(`Invalid boolean value: ${v}`);
+    }
+}
+exports.toApiBoolean = toApiBoolean;
+// TODO: check integer bounds
+function toApiNumber256(v) {
+    if ((typeof v === 'number' && Number.isInteger(v)) || typeof v === 'bigint') {
+        return v.toString();
+    }
+    else if (typeof v === 'string') {
+        return v;
+    }
+    else {
+        throw new Error(`Invalid 256 bit number: ${v}`);
+    }
+}
+exports.toApiNumber256 = toApiNumber256;
+function toApiNumber256Optional(v) {
+    return v === undefined ? undefined : toApiNumber256(v);
+}
+exports.toApiNumber256Optional = toApiNumber256Optional;
+function fromApiNumber256(n) {
+    if (Number.isSafeInteger(Number.parseInt(n))) {
+        return Number(n);
+    }
+    else {
+        return BigInt(n);
+    }
+}
+exports.fromApiNumber256 = fromApiNumber256;
+// TODO: check hex string
+function toApiByteVec(v) {
+    if (typeof v === 'string') {
+        // try to convert from address to contract id
+        try {
+            const address = utils_1.bs58.decode(v);
+            if (address.length == 33 && address[0] == 3) {
+                return Buffer.from(address.slice(1)).toString('hex');
+            }
+        }
+        catch (_) {
+            return v;
+        }
+        return v;
+    }
+    else {
+        throw new Error(`Invalid string: ${v}`);
+    }
+}
+exports.toApiByteVec = toApiByteVec;
+function toApiAddress(v) {
+    if (typeof v === 'string') {
+        try {
+            utils_1.bs58.decode(v);
+            return v;
+        }
+        catch (error) {
+            throw new Error(`Invalid base58 string: ${v}`);
+        }
+    }
+    else {
+        throw new Error(`Invalid string: ${v}`);
+    }
+}
+exports.toApiAddress = toApiAddress;
+function toApiArray(tpe, v) {
+    if (!Array.isArray(v)) {
+        throw new Error(`Expected array, got ${v}`);
+    }
+    const semiColonIndex = tpe.lastIndexOf(';');
+    if (semiColonIndex == -1) {
+        throw new Error(`Invalid Val type: ${tpe}`);
+    }
+    const subType = tpe.slice(1, semiColonIndex);
+    const dim = parseInt(tpe.slice(semiColonIndex + 1, -1));
+    if (v.length != dim) {
+        throw new Error(`Invalid val dimension: ${v}`);
+    }
+    else {
+        return { value: v.map((v) => toApiVal(v, subType)), type: 'Array' };
+    }
+}
+exports.toApiArray = toApiArray;
+function toApiVal(v, tpe) {
+    if (tpe === 'Bool') {
+        return { value: toApiBoolean(v), type: tpe };
+    }
+    else if (tpe === 'U256' || tpe === 'I256') {
+        return { value: toApiNumber256(v), type: tpe };
+    }
+    else if (tpe === 'ByteVec') {
+        return { value: toApiByteVec(v), type: tpe };
+    }
+    else if (tpe === 'Address') {
+        return { value: toApiAddress(v), type: tpe };
+    }
+    else {
+        return toApiArray(tpe, v);
+    }
+}
+exports.toApiVal = toApiVal;
+function _fromApiVal(vals, valIndex, tpe) {
+    if (vals.length === 0) {
+        throw new Error('Not enough Vals');
+    }
+    const firstVal = vals[`${valIndex}`];
+    if (tpe === 'Bool' && firstVal.type === tpe) {
+        return [firstVal.value, valIndex + 1];
+    }
+    else if ((tpe === 'U256' || tpe === 'I256') && firstVal.type === tpe) {
+        return [fromApiNumber256(firstVal.value), valIndex + 1];
+    }
+    else if ((tpe === 'ByteVec' || tpe === 'Address') && firstVal.type === tpe) {
+        return [firstVal.value, valIndex + 1];
+    }
+    else {
+        const [baseType, dims] = decodeArrayType(tpe);
+        const arraySize = dims.reduce((a, b) => a * b);
+        const nextIndex = valIndex + arraySize;
+        const valsToUse = vals.slice(valIndex, nextIndex);
+        if (valsToUse.length == arraySize && valsToUse.every((val) => val.type === baseType)) {
+            const localVals = valsToUse.map((val) => fromApiVal(val, baseType));
+            return [foldVals(localVals, dims), nextIndex];
+        }
+        else {
+            throw new Error(`Invalid array Val type: ${valsToUse}, ${tpe}`);
+        }
+    }
+}
+function fromApiVals(vals, names, types) {
+    let valIndex = 0;
+    const result = {};
+    types.forEach((currentType, index) => {
+        const currentName = names[`${index}`];
+        const [val, nextIndex] = _fromApiVal(vals, valIndex, currentType);
+        valIndex = nextIndex;
+        result[`${currentName}`] = val;
+    });
+    return result;
+}
+exports.fromApiVals = fromApiVals;
+function fromApiArray(vals, types) {
+    let valIndex = 0;
+    const result = [];
+    for (const currentType of types) {
+        const [val, nextIndex] = _fromApiVal(vals, valIndex, currentType);
+        result.push(val);
+        valIndex = nextIndex;
+    }
+    return result;
+}
+exports.fromApiArray = fromApiArray;
+function fromApiVal(v, tpe) {
+    if (v.type === 'Bool' && v.type === tpe) {
+        return v.value;
+    }
+    else if ((v.type === 'U256' || v.type === 'I256') && v.type === tpe) {
+        return fromApiNumber256(v.value);
+    }
+    else if ((v.type === 'ByteVec' || v.type === 'Address') && v.type === tpe) {
+        return v.value;
+    }
+    else {
+        throw new Error(`Invalid node.Val type: ${v}`);
+    }
+}
+exports.fromApiVal = fromApiVal;
+function decodeArrayType(tpe) {
+    const semiColonIndex = tpe.lastIndexOf(';');
+    if (semiColonIndex === -1) {
+        throw new Error(`Invalid Val type: ${tpe}`);
+    }
+    const subType = tpe.slice(1, semiColonIndex);
+    const dim = parseInt(tpe.slice(semiColonIndex + 1, -1));
+    if (subType[0] == '[') {
+        const [baseType, subDim] = decodeArrayType(subType);
+        return [baseType, (subDim.unshift(dim), subDim)];
+    }
+    else {
+        return [subType, [dim]];
+    }
+}
+function foldVals(vals, dims) {
+    if (dims.length == 1) {
+        return vals;
+    }
+    else {
+        const result = [];
+        const chunkSize = vals.length / dims[0];
+        const chunkDims = dims.slice(1);
+        for (let i = 0; i < vals.length; i += chunkSize) {
+            const chunk = vals.slice(i, i + chunkSize);
+            result.push(foldVals(chunk, chunkDims));
+        }
+        return result;
+    }
+}

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

@@ -0,0 +1,6 @@
+export declare function convertHttpResponse<T>(response: {
+    data: T;
+    error?: {
+        detail: string;
+    };
+}): T;

package/{src/utils/djb2.test.ts → dist/src/api/utils.js}

@@ -1,3 +1,4 @@
+"use strict";
 /*
 Copyright 2018 - 2022 The Alephium Authors
 This file is part of the alephium project.
@@ -15,21 +16,14 @@ 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/>.
 */
-
-import { Buffer } from 'buffer/'
-import djb2 from './djb2'
-
-describe('djb2', function () {
-  it('djb2', async () => {
-    function check(str: string, expected: number) {
-      const bytes = Buffer.from(str, 'utf8')
-      expect(djb2(bytes)).toEqual(expected)
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertHttpResponse = void 0;
+function convertHttpResponse(response) {
+    if (response.error) {
+        throw new Error(`[Node API Error] - ${response.error.detail}`);
     }
-
-    check('', 5381)
-    check('a', 177670)
-    check('z', 177695)
-    check('foo', 193491849)
-    check('bar', 193487034)
-  })
-})
+    else {
+        return response.data;
+    }
+}
+exports.convertHttpResponse = convertHttpResponse;