@alephium/web3 0.2.0-rc.0 → 0.2.0-rc.3

package/dist/scripts/create-project.js

@@ -86,7 +86,8 @@ function prepareShared(packageRoot, projectRoot) {
 }
 function prepareBase(packageRoot, projectRoot) {
     prepareShared(packageRoot, projectRoot);
-    copy('contracts', ['greeter.ral', 'greeter_interface.ral', 'greeter_main.ral']);
+    copy('contracts', ['greeter_main.ral']);
+    copy('contracts/greeter', ['greeter.ral', 'greeter_interface.ral']);
     fs_extra_1.default.copySync(path_1.default.join(packageRoot, 'templates/base'), projectRoot);
 }
 function prepareReact(packageRoot, projectRoot, projectName) {

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

@@ -311,11 +311,13 @@ export interface CompileContractResult {
     fields: FieldsSig;
     functions: FunctionSig[];
     events: EventSig[];
+    warnings: string[];
 }
 export interface CompileScriptResult {
     bytecodeTemplate: string;
     fields: FieldsSig;
     functions: FunctionSig[];
+    warnings: string[];
 }
 export interface Confirmed {
     /** @format block-hash */
@@ -409,7 +411,6 @@ export interface Destination {
 export declare type DiscoveryAction = Reachable | Unreachable;
 export interface EventSig {
     name: string;
-    signature: string;
     fieldNames: string[];
     fieldTypes: string[];
 }
@@ -417,9 +418,9 @@ export interface FetchResponse {
     blocks: BlockEntry[][];
 }
 export interface FieldsSig {
-    signature: string;
     names: string[];
     types: string[];
+    isMutable: boolean[];
 }
 export interface FixedAssetOutput {
     /** @format int32 */
@@ -438,9 +439,12 @@ export interface FixedAssetOutput {
 }
 export interface FunctionSig {
     name: string;
-    signature: string;
-    argNames: string[];
-    argTypes: string[];
+    usePreapprovedAssets: boolean;
+    useAssetsInContract: boolean;
+    isPublic: boolean;
+    paramNames: string[];
+    paramTypes: string[];
+    paramIsMutable: boolean[];
     returnTypes: string[];
 }
 export interface Group {
@@ -855,8 +859,8 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 1.5.0-rc0
- * @baseUrl {protocol}://{host}:{port}
+ * @version 1.5.0
+ * @baseUrl ../
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
     wallets: {

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

@@ -28,7 +28,7 @@ var ContentType;
 })(ContentType = exports.ContentType || (exports.ContentType = {}));
 class HttpClient {
     constructor(apiConfig = {}) {
-        this.baseUrl = '{protocol}://{host}:{port}';
+        this.baseUrl = '../';
         this.securityData = null;
         this.abortControllers = new Map();
         this.customFetch = (...fetchParams) => fetch(...fetchParams);
@@ -158,8 +158,8 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Alephium API
- * @version 1.5.0-rc0
- * @baseUrl {protocol}://{host}:{port}
+ * @version 1.5.0
+ * @baseUrl ../
  */
 class Api extends HttpClient {
     constructor() {

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

@@ -470,6 +470,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/utils/sanity-check
          */
         putUtilsSanityCheck: (params?: RequestParams) => Promise<void>;
+        /**
+         * @description Update global log level, accepted: TRACE, DEBUG, INFO, WARN, ERROR
+         *
+         * @tags Utils
+         * @name PutUtilsUpdateGlobalLoglevel
+         * @request PUT:/utils/update-global-loglevel
+         */
+        putUtilsUpdateGlobalLoglevel: (data: 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR', params?: RequestParams) => Promise<void>;
+        /**
+         * @description Update logging file, only logback.xml is accepted
+         *
+         * @tags Utils
+         * @name PutUtilsUpdateLogConfig
+         * @request PUT:/utils/update-log-config
+         */
+        putUtilsUpdateLogConfig: (data: string, params?: RequestParams) => Promise<void>;
     };
 }
 export {};

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

@@ -450,6 +450,32 @@ class Api extends HttpClient {
                 path: `/utils/sanity-check`,
                 method: 'PUT',
                 ...params
+            }).then(convertHttpResponse),
+            /**
+             * @description Update global log level, accepted: TRACE, DEBUG, INFO, WARN, ERROR
+             *
+             * @tags Utils
+             * @name PutUtilsUpdateGlobalLoglevel
+             * @request PUT:/utils/update-global-loglevel
+             */
+            putUtilsUpdateGlobalLoglevel: (data, params = {}) => this.request({
+                path: `/utils/update-global-loglevel`,
+                method: 'PUT',
+                body: data,
+                ...params
+            }).then(convertHttpResponse),
+            /**
+             * @description Update logging file, only logback.xml is accepted
+             *
+             * @tags Utils
+             * @name PutUtilsUpdateLogConfig
+             * @request PUT:/utils/update-log-config
+             */
+            putUtilsUpdateLogConfig: (data, params = {}) => this.request({
+                path: `/utils/update-log-config`,
+                method: 'PUT',
+                body: data,
+                ...params
             }).then(convertHttpResponse)
         };
     }

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

@@ -8,9 +8,12 @@ declare class SourceFile {
     readonly artifactPath: string;
     constructor(dirs: string[], fileName: string);
 }
+declare type FieldsSig = node.FieldsSig;
+declare type EventSig = node.EventSig;
+declare type FunctionSig = node.FunctionSig;
 export declare abstract class Common {
     readonly sourceCodeSha256: string;
-    readonly functions: node.FunctionSig[];
+    readonly functions: FunctionSig[];
     static readonly importRegex: RegExp;
     static readonly contractRegex: RegExp;
     static readonly interfaceRegex: RegExp;
@@ -19,7 +22,7 @@ export declare abstract class Common {
     static artifactCacheCapacity: number;
     protected static _getArtifactFromCache(codeHash: string): Contract | Script | undefined;
     protected static _putArtifactToCache(contract: Contract): void;
-    constructor(sourceCodeSha256: string, functions: node.FunctionSig[]);
+    constructor(sourceCodeSha256: string, functions: FunctionSig[]);
     protected static _artifactsFolder(): string;
     static getSourceFile(path: string, _dirs: string[]): SourceFile;
     protected static _handleImports(pathes: string[], contractStr: string, importsCache: string[]): Promise<string>;
@@ -27,19 +30,25 @@ export declare abstract class Common {
     static checkFileNameExtension(fileName: string): void;
     protected static _from<T extends {
         sourceCodeSha256: string;
-    }>(provider: NodeProvider, sourceFile: SourceFile, loadContractStr: (sourceFile: SourceFile, importsCache: string[]) => Promise<string>, compile: (provider: NodeProvider, sourceFile: SourceFile, contractStr: string, contractHash: string) => Promise<T>): Promise<T>;
+    }>(provider: NodeProvider, sourceFile: SourceFile, loadContractStr: (sourceFile: SourceFile, importsCache: string[]) => Promise<string>, compile: (provider: NodeProvider, sourceFile: SourceFile, contractStr: string, contractHash: string, errorOnWarnings: boolean) => Promise<T>, errorOnWarnings: boolean): Promise<T>;
     protected _saveToFile(sourceFile: SourceFile): Promise<void>;
     abstract buildByteCodeToDeploy(initialFields?: Fields): string;
+    publicFunctions(): string[];
+    usingPreapprovedAssetsFunctions(): string[];
+    usingAssetsInContractFunctions(): string[];
+    protected static checkCompilerWarnings(compiled: {
+        warnings: string[];
+    }, errorOnWarnings: boolean): void;
 }
 export declare class Contract extends Common {
     readonly bytecode: string;
     readonly codeHash: string;
-    readonly fieldsSig: node.FieldsSig;
-    readonly eventsSig: node.EventSig[];
-    constructor(sourceCodeSha256: string, bytecode: string, codeHash: string, fieldsSig: node.FieldsSig, eventsSig: node.EventSig[], functions: node.FunctionSig[]);
+    readonly fieldsSig: FieldsSig;
+    readonly eventsSig: EventSig[];
+    constructor(sourceCodeSha256: string, bytecode: string, codeHash: string, fieldsSig: FieldsSig, eventsSig: EventSig[], functions: FunctionSig[]);
     static checkCodeType(fileName: string, contractStr: string): void;
     private static loadContractStr;
-    static fromSource(provider: NodeProvider, path: string): Promise<Contract>;
+    static fromSource(provider: NodeProvider, path: string, errorOnWarnings?: boolean): Promise<Contract>;
     private static compile;
     static fromJson(artifact: any): Contract;
     static fromArtifactFile(path: string): Promise<Contract>;
@@ -56,10 +65,10 @@ export declare class Contract extends Common {
     toApiContractStates(states?: ContractState[]): node.ContractState[] | undefined;
     toTestContract(funcName: string, params: TestContractParams): node.TestContract;
     static fromCodeHash(codeHash: string): Promise<Contract>;
-    static getFieldsSig(state: node.ContractState): Promise<node.FieldsSig>;
+    static getFieldsSig(state: node.ContractState): Promise<FieldsSig>;
     fromApiContractState(state: node.ContractState): Promise<ContractState>;
-    static ContractCreatedEvent: node.EventSig;
-    static ContractDestroyedEvent: node.EventSig;
+    static ContractCreatedEvent: EventSig;
+    static ContractDestroyedEvent: EventSig;
     static fromApiEvent(event: node.ContractEventByTxId, codeHash: string | undefined): Promise<ContractEventByTxId>;
     fromTestContractResult(methodIndex: number, result: node.TestContractResult): Promise<TestContractResult>;
     paramsForDeployment(params: BuildDeployContractTx): Promise<SignDeployContractTxParams>;
@@ -68,11 +77,11 @@ export declare class Contract extends Common {
 }
 export declare class Script extends Common {
     readonly bytecodeTemplate: string;
-    readonly fieldsSig: node.FieldsSig;
-    constructor(sourceCodeSha256: string, bytecodeTemplate: string, fieldsSig: node.FieldsSig, functions: node.FunctionSig[]);
+    readonly fieldsSig: FieldsSig;
+    constructor(sourceCodeSha256: string, bytecodeTemplate: string, fieldsSig: FieldsSig, functions: FunctionSig[]);
     static checkCodeType(fileName: string, contractStr: string): void;
     private static loadContractStr;
-    static fromSource(provider: NodeProvider, path: string): Promise<Script>;
+    static fromSource(provider: NodeProvider, path: string, errorOnWarnings?: boolean): Promise<Script>;
     private static compile;
     static fromJson(artifact: any): Script;
     static fromArtifactFile(path: string): Promise<Script>;
@@ -107,7 +116,7 @@ export interface ContractState {
     initialStateHash?: string;
     codeHash: string;
     fields: Fields;
-    fieldsSig: node.FieldsSig;
+    fieldsSig: FieldsSig;
     asset: Asset;
 }
 export interface TestContractParams {

package/dist/src/contract/contract.js

@@ -135,7 +135,7 @@ class Common {
             throw new Error('Smart contract file name should end with ".ral"');
         }
     }
-    static async _from(provider, sourceFile, loadContractStr, compile) {
+    static async _from(provider, sourceFile, loadContractStr, compile, errorOnWarnings) {
         Common.checkFileNameExtension(sourceFile.contractPath);
         const contractStr = await loadContractStr(sourceFile, []);
         const contractHash = cryptojs.SHA256(contractStr).toString();
@@ -144,7 +144,7 @@ class Common {
             return existingContract;
         }
         else {
-            return compile(provider, sourceFile, contractStr, contractHash);
+            return compile(provider, sourceFile, contractStr, contractHash, errorOnWarnings);
         }
     }
     _saveToFile(sourceFile) {
@@ -154,10 +154,32 @@ class Common {
         }
         return fs_2.promises.writeFile(sourceFile.artifactPath, this.toString());
     }
+    publicFunctions() {
+        return this.functions.filter((func) => func.isPublic).map((func) => func.name);
+    }
+    usingPreapprovedAssetsFunctions() {
+        return this.functions.filter((func) => func.usePreapprovedAssets).map((func) => func.name);
+    }
+    usingAssetsInContractFunctions() {
+        return this.functions.filter((func) => func.useAssetsInContract).map((func) => func.name);
+    }
+    static checkCompilerWarnings(compiled, errorOnWarnings) {
+        if (compiled.warnings.length !== 0) {
+            const prefixPerWarning = '  - ';
+            const warningString = prefixPerWarning + compiled.warnings.join('\n' + prefixPerWarning);
+            const output = 'Compilation warnings:\n' + warningString + '\n';
+            if (errorOnWarnings) {
+                throw new Error(output);
+            }
+            else {
+                console.log(output);
+            }
+        }
+    }
 }
 exports.Common = Common;
 Common.importRegex = new RegExp('^import "([^"/]+/(([^"]+)/)?)?[a-z][a-z_0-9]*.ral"', 'mg');
-Common.contractRegex = new RegExp('^TxContract [A-Z][a-zA-Z0-9]*', 'mg');
+Common.contractRegex = new RegExp('^(Abstract[ ]+)?Contract [A-Z][a-zA-Z0-9]*', 'mg');
 Common.interfaceRegex = new RegExp('^Interface [A-Z][a-zA-Z0-9]* \\{', 'mg');
 Common.scriptRegex = new RegExp('^TxScript [A-Z][a-zA-Z0-9]*', 'mg');
 Common._artifactCache = new Map();
@@ -193,17 +215,18 @@ class Contract extends Common {
     static async loadContractStr(sourceFile) {
         return Common._loadContractStr(sourceFile, [], (code) => Contract.checkCodeType(sourceFile.contractPath, code));
     }
-    static async fromSource(provider, path) {
+    static async fromSource(provider, path, errorOnWarnings = true) {
         if (!fs_1.default.existsSync(Common._artifactsFolder())) {
             fs_1.default.mkdirSync(Common._artifactsFolder(), { recursive: true });
         }
         const sourceFile = this.getSourceFile(path, []);
-        const contract = await Common._from(provider, sourceFile, (sourceFile) => Contract.loadContractStr(sourceFile), Contract.compile);
+        const contract = await Common._from(provider, sourceFile, (sourceFile) => Contract.loadContractStr(sourceFile), Contract.compile, errorOnWarnings);
         this._putArtifactToCache(contract);
         return contract;
     }
-    static async compile(provider, sourceFile, contractStr, contractHash) {
+    static async compile(provider, sourceFile, contractStr, contractHash, errorOnWarnings) {
         const compiled = await provider.contracts.postContractsCompileContract({ code: contractStr });
+        Common.checkCompilerWarnings(compiled, errorOnWarnings);
         const artifact = new Contract(contractHash, compiled.bytecode, compiled.codeHash, compiled.fields, compiled.events, compiled.functions);
         await artifact._saveToFile(sourceFile);
         return artifact;
@@ -265,7 +288,7 @@ class Contract extends Common {
         const apiParams = this.toTestContract(funcName, params);
         const apiResult = await provider.contracts.postContractsTestContract(apiParams);
         const methodIndex = typeof params.testMethodIndex !== 'undefined' ? params.testMethodIndex : this.getMethodIndex(funcName);
-        const isPublic = this.functions[`${methodIndex}`].signature.indexOf('pub ') !== -1;
+        const isPublic = this.functions[`${methodIndex}`].isPublic;
         if (isPublic === expectPublic) {
             const result = await this.fromTestContractResult(methodIndex, apiResult);
             return result;
@@ -424,13 +447,11 @@ class Contract extends Common {
 exports.Contract = Contract;
 Contract.ContractCreatedEvent = {
     name: 'ContractCreated',
-    signature: 'event ContractCreated(address:Address)',
     fieldNames: ['address'],
     fieldTypes: ['Address']
 };
 Contract.ContractDestroyedEvent = {
     name: 'ContractDestroyed',
-    signature: 'event ContractDestroyed(address:Address)',
     fieldNames: ['address'],
     fieldTypes: ['Address']
 };
@@ -455,12 +476,13 @@ class Script extends Common {
     static async loadContractStr(sourceFile) {
         return Common._loadContractStr(sourceFile, [], (code) => Script.checkCodeType(sourceFile.contractPath, code));
     }
-    static async fromSource(provider, path) {
+    static async fromSource(provider, path, errorOnWarnings = true) {
         const sourceFile = this.getSourceFile(path, []);
-        return Common._from(provider, sourceFile, (sourceFile) => Script.loadContractStr(sourceFile), Script.compile);
+        return Common._from(provider, sourceFile, (sourceFile) => Script.loadContractStr(sourceFile), Script.compile, errorOnWarnings);
     }
-    static async compile(provider, sourceFile, scriptStr, contractHash) {
+    static async compile(provider, sourceFile, scriptStr, contractHash, errorOnWarnings = true) {
         const compiled = await provider.contracts.postContractsCompileScript({ code: scriptStr });
+        Common.checkCompilerWarnings(compiled, errorOnWarnings);
         const artifact = new Script(contractHash, compiled.bytecodeTemplate, compiled.fields, compiled.functions);
         await artifact._saveToFile(sourceFile);
         return artifact;
@@ -752,7 +774,7 @@ function toApiFields(fields, fieldsSig) {
     return toApiVals(fields, fieldsSig.names, fieldsSig.types);
 }
 function toApiArgs(args, funcSig) {
-    return toApiVals(args, funcSig.argNames, funcSig.argTypes);
+    return toApiVals(args, funcSig.paramNames, funcSig.paramTypes);
 }
 function toApiVals(fields, names, types) {
     return names.map((name, index) => {

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

@@ -20,8 +20,8 @@ export declare function addressFromContractId(contractId: string): string;
 export declare function contractIdFromTx(txId: string, outputIndex: number): string;
 export declare function subContractId(parentContractId: string, pathInHex: string): string;
 export declare function stringToHex(str: string): string;
-export declare function hexToString(str: any): string;
-export declare function timeout(ms: number): Promise<unknown>;
+export declare function hexToString(str: string): string;
+export declare function timeout(ms: number): Promise<void>;
 declare type _Eq<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;
 export declare type Eq<X, Y> = _Eq<{
     [P in keyof X]: X[P];

package/dist/src/utils/utils.js

@@ -182,7 +182,7 @@ function contractIdFromTx(txId, outputIndex) {
 }
 exports.contractIdFromTx = contractIdFromTx;
 function subContractId(parentContractId, pathInHex) {
-    const data = buffer_1.Buffer.concat([hexToBinUnsafe(pathInHex), hexToBinUnsafe(parentContractId)]);
+    const data = buffer_1.Buffer.concat([hexToBinUnsafe(parentContractId), hexToBinUnsafe(pathInHex)]);
     return binToHex(blakejs_1.default.blake2b(blakejs_1.default.blake2b(data, undefined, 32), undefined, 32));
 }
 exports.subContractId = subContractId;
@@ -195,7 +195,7 @@ function stringToHex(str) {
 }
 exports.stringToHex = stringToHex;
 function hexToString(str) {
-    return buffer_1.Buffer.from(str.toString(), 'hex').toString();
+    return buffer_1.Buffer.from(str, 'hex').toString();
 }
 exports.hexToString = hexToString;
 function timeout(ms) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.2.0-rc.0",
+  "version": "0.2.0-rc.3",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -27,8 +27,8 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "1.5.0-rc0",
-    "explorer_backend_version": "1.7.0"
+    "alephium_version": "1.5.0-rc4",
+    "explorer_backend_version": "1.7.1"
   },
   "scripts": {
     "build": "rm -rf dist/* && npx tsc --build . && webpack",

package/scripts/create-project.ts

@@ -87,7 +87,8 @@ function prepareShared(packageRoot: string, projectRoot: string) {
 
 function prepareBase(packageRoot: string, projectRoot: string) {
   prepareShared(packageRoot, projectRoot)
-  copy('contracts', ['greeter.ral', 'greeter_interface.ral', 'greeter_main.ral'])
+  copy('contracts', ['greeter_main.ral'])
+  copy('contracts/greeter', ['greeter.ral', 'greeter_interface.ral'])
   fsExtra.copySync(path.join(packageRoot, 'templates/base'), projectRoot)
 }
 

package/src/api/api-alephium.ts

@@ -429,12 +429,14 @@ export interface CompileContractResult {
   fields: FieldsSig
   functions: FunctionSig[]
   events: EventSig[]
+  warnings: string[]
 }
 
 export interface CompileScriptResult {
   bytecodeTemplate: string
   fields: FieldsSig
   functions: FunctionSig[]
+  warnings: string[]
 }
 
 export interface Confirmed {
@@ -561,7 +563,6 @@ export type DiscoveryAction = Reachable | Unreachable
 
 export interface EventSig {
   name: string
-  signature: string
   fieldNames: string[]
   fieldTypes: string[]
 }
@@ -571,9 +572,9 @@ export interface FetchResponse {
 }
 
 export interface FieldsSig {
-  signature: string
   names: string[]
   types: string[]
+  isMutable: boolean[]
 }
 
 export interface FixedAssetOutput {
@@ -599,9 +600,12 @@ export interface FixedAssetOutput {
 
 export interface FunctionSig {
   name: string
-  signature: string
-  argNames: string[]
-  argTypes: string[]
+  usePreapprovedAssets: boolean
+  useAssetsInContract: boolean
+  isPublic: boolean
+  paramNames: string[]
+  paramTypes: string[]
+  paramIsMutable: boolean[]
   returnTypes: string[]
 }
 
@@ -1114,7 +1118,7 @@ export enum ContentType {
 }
 
 export class HttpClient<SecurityDataType = unknown> {
-  public baseUrl: string = '{protocol}://{host}:{port}'
+  public baseUrl: string = '../'
   private securityData: SecurityDataType | null = null
   private securityWorker?: ApiConfig<SecurityDataType>['securityWorker']
   private abortControllers = new Map<CancelToken, AbortController>()
@@ -1279,8 +1283,8 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 1.5.0-rc0
- * @baseUrl {protocol}://{host}:{port}
+ * @version 1.5.0
+ * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
   wallets = {

package/src/api/api-explorer.ts

@@ -847,6 +847,36 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         path: `/utils/sanity-check`,
         method: 'PUT',
         ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * @description Update global log level, accepted: TRACE, DEBUG, INFO, WARN, ERROR
+     *
+     * @tags Utils
+     * @name PutUtilsUpdateGlobalLoglevel
+     * @request PUT:/utils/update-global-loglevel
+     */
+    putUtilsUpdateGlobalLoglevel: (data: 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR', params: RequestParams = {}) =>
+      this.request<void, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/utils/update-global-loglevel`,
+        method: 'PUT',
+        body: data,
+        ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * @description Update logging file, only logback.xml is accepted
+     *
+     * @tags Utils
+     * @name PutUtilsUpdateLogConfig
+     * @request PUT:/utils/update-log-config
+     */
+    putUtilsUpdateLogConfig: (data: string, params: RequestParams = {}) =>
+      this.request<void, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/utils/update-log-config`,
+        method: 'PUT',
+        body: data,
+        ...params
       }).then(convertHttpResponse)
   }
 }