@alephium/web3 0.2.0-rc.10 → 0.2.0-rc.11

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

@@ -8,3 +8,4 @@ export declare class ExplorerProvider extends ExplorerApi<null> {
 }
 export * as node from './api-alephium';
 export * as explorer from './api-explorer';
+export * from './types';

package/dist/src/api/index.js

@@ -39,6 +39,9 @@ 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");
@@ -68,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/contract/contract.d.ts

@@ -1,9 +1,10 @@
-import { node, NodeProvider } from '../api';
+import { NamedVals, node, NodeProvider, Number256, Token, Val } from '../api';
 import { SignDeployContractTxParams, SignExecuteScriptTxParams, SignerWithNodeProvider } from '../signer';
-import { CompileContractResult, CompileScriptResult } from '../api/api-alephium';
-declare type FieldsSig = node.FieldsSig;
-declare type EventSig = node.EventSig;
-declare type FunctionSig = node.FunctionSig;
+export declare type FieldsSig = node.FieldsSig;
+export declare type EventSig = node.EventSig;
+export declare type FunctionSig = node.FunctionSig;
+export declare type Fields = NamedVals;
+export declare type Arguments = NamedVals;
 declare enum SourceType {
     Contract = 0,
     Script = 1,
@@ -70,8 +71,8 @@ export declare class Project {
     private constructor();
     private getContractPath;
     static checkCompilerWarnings(warnings: string[], errorOnWarnings: boolean): void;
-    static contract(path: string): Contract;
-    static script(path: string): Script;
+    static contract(name: string): Contract;
+    static script(name: string): Script;
     private saveArtifactsToFile;
     contractByCodeHash(codeHash: string): Contract;
     private static compile;
@@ -81,8 +82,9 @@ export declare class Project {
     static build(compilerOptionsPartial?: Partial<CompilerOptions>, contractsRootPath?: string, artifactsRootPath?: string): Promise<void>;
 }
 export declare abstract class Artifact {
+    readonly name: string;
     readonly functions: FunctionSig[];
-    constructor(functions: FunctionSig[]);
+    constructor(name: string, functions: FunctionSig[]);
     abstract buildByteCodeToDeploy(initialFields?: Fields): string;
     publicFunctions(): string[];
     usingPreapprovedAssetsFunctions(): string[];
@@ -93,9 +95,9 @@ export declare class Contract extends Artifact {
     readonly codeHash: string;
     readonly fieldsSig: FieldsSig;
     readonly eventsSig: EventSig[];
-    constructor(bytecode: string, codeHash: string, fieldsSig: FieldsSig, eventsSig: EventSig[], functions: FunctionSig[]);
+    constructor(name: string, bytecode: string, codeHash: string, fieldsSig: FieldsSig, eventsSig: EventSig[], functions: FunctionSig[]);
     static fromJson(artifact: any): Contract;
-    static fromCompileResult(result: CompileContractResult): Contract;
+    static fromCompileResult(result: node.CompileContractResult): Contract;
     static fromArtifactFile(path: string): Promise<Contract>;
     fetchState(address: string, group: number): Promise<ContractState>;
     toString(): string;
@@ -121,8 +123,8 @@ export declare class Contract extends Artifact {
 export declare class Script extends Artifact {
     readonly bytecodeTemplate: string;
     readonly fieldsSig: FieldsSig;
-    constructor(bytecodeTemplate: string, fieldsSig: FieldsSig, functions: FunctionSig[]);
-    static fromCompileResult(result: CompileScriptResult): Script;
+    constructor(name: string, bytecodeTemplate: string, fieldsSig: FieldsSig, functions: FunctionSig[]);
+    static fromCompileResult(result: node.CompileScriptResult): Script;
     static fromJson(artifact: any): Script;
     static fromArtifactFile(path: string): Promise<Script>;
     toString(): string;
@@ -130,21 +132,10 @@ export declare class Script extends Artifact {
     transactionForDeployment(signer: SignerWithNodeProvider, params: Omit<BuildExecuteScriptTx, 'signerAddress'>): Promise<BuildScriptTxResult>;
     buildByteCodeToDeploy(initialFields: Fields): string;
 }
-export declare type Number256 = number | bigint | string;
-export declare type Val = Number256 | boolean | string | Val[];
-export declare type NamedVals = Record<string, Val>;
-export declare type Fields = NamedVals;
-export declare type Arguments = NamedVals;
-export declare function extractArray(tpe: string, v: Val): node.Val;
-export declare function toApiVal(v: Val, tpe: string): node.Val;
 export interface Asset {
     alphAmount: Number256;
     tokens?: Token[];
 }
-export interface Token {
-    id: string;
-    amount: Number256;
-}
 export interface InputAsset {
     address: string;
     asset: Asset;
@@ -201,7 +192,7 @@ export interface ContractOutput {
     type: string;
     address: string;
     alphAmount: Number256;
-    tokens: Token[];
+    tokens?: Token[];
 }
 export interface DeployContractTransaction {
     fromGroup: number;