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

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

@@ -85,6 +85,10 @@ export interface Banned {
     until: number;
     type: string;
 }
+export interface BlockAndEvents {
+    block: BlockEntry;
+    events: ContractEventByBlockHash[];
+}
 export interface BlockEntry {
     /** @format block-hash */
     hash: string;
@@ -121,6 +125,12 @@ export interface BlockHeaderEntry {
     height: number;
     deps: string[];
 }
+export interface BlocksAndEventsPerTimeStampRange {
+    blocksAndEvents: BlockAndEvents[][];
+}
+export interface BlocksPerTimeStampRange {
+    blocks: BlockEntry[][];
+}
 export interface BrokerInfo {
     /** @format clique-id */
     cliqueId: string;
@@ -359,6 +369,15 @@ export interface ContractEvent {
     eventIndex: number;
     fields: Val[];
 }
+export interface ContractEventByBlockHash {
+    /** @format 32-byte-hash */
+    txId: string;
+    /** @format address */
+    contractAddress: string;
+    /** @format int32 */
+    eventIndex: number;
+    fields: Val[];
+}
 export interface ContractEventByTxId {
     /** @format block-hash */
     blockHash: string;
@@ -373,10 +392,11 @@ export interface ContractEvents {
     /** @format int32 */
     nextStart: number;
 }
+export interface ContractEventsByBlockHash {
+    events: ContractEventByBlockHash[];
+}
 export interface ContractEventsByTxId {
     events: ContractEventByTxId[];
-    /** @format int32 */
-    nextStart: number;
 }
 export interface ContractOutput {
     /** @format int32 */
@@ -429,9 +449,6 @@ export interface EventSig {
     fieldNames: string[];
     fieldTypes: string[];
 }
-export interface FetchResponse {
-    blocks: BlockEntry[][];
-}
 export interface FieldsSig {
     names: string[];
     types: string[];
@@ -1178,14 +1195,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * No description
          *
          * @tags Blockflow
-         * @name GetBlockflow
+         * @name GetBlockflowBlocks
          * @summary List blocks on the given time interval
-         * @request GET:/blockflow
+         * @request GET:/blockflow/blocks
          */
-        getBlockflow: (query: {
+        getBlockflowBlocks: (query: {
             fromTs: number;
             toTs?: number;
-        }, params?: RequestParams) => Promise<FetchResponse>;
+        }, params?: RequestParams) => Promise<BlocksPerTimeStampRange>;
+        /**
+         * No description
+         *
+         * @tags Blockflow
+         * @name GetBlockflowBlocksWithEvents
+         * @summary List blocks with events on the given time interval
+         * @request GET:/blockflow/blocks-with-events
+         */
+        getBlockflowBlocksWithEvents: (query: {
+            fromTs: number;
+            toTs?: number;
+        }, params?: RequestParams) => Promise<BlocksAndEventsPerTimeStampRange>;
         /**
          * No description
          *
@@ -1195,6 +1224,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/blockflow/blocks/{block_hash}
          */
         getBlockflowBlocksBlockHash: (blockHash: string, params?: RequestParams) => Promise<BlockEntry>;
+        /**
+         * No description
+         *
+         * @tags Blockflow
+         * @name GetBlockflowBlocksWithEventsBlockHash
+         * @summary Get a block and events with hash
+         * @request GET:/blockflow/blocks-with-events/{block_hash}
+         */
+        getBlockflowBlocksWithEventsBlockHash: (blockHash: string, params?: RequestParams) => Promise<BlockAndEvents>;
         /**
          * No description
          *
@@ -1467,6 +1505,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         postMinersCpuMining: (query: {
             action: string;
         }, params?: RequestParams) => Promise<boolean>;
+        /**
+         * No description
+         *
+         * @tags Miners
+         * @name PostMinersCpuMiningMineOneBlock
+         * @summary Mine a block on CPU miner. !!! for test only !!!
+         * @request POST:/miners/cpu-mining/mine-one-block
+         */
+        postMinersCpuMiningMineOneBlock: (query: {
+            fromGroup: number;
+            toGroup: number;
+        }, params?: RequestParams) => Promise<boolean>;
         /**
          * No description
          *
@@ -1497,7 +1547,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getEventsContractContractaddress: (contractAddress: string, query: {
             start: number;
-            end?: number;
+            limit?: number;
             group?: number;
         }, params?: RequestParams) => Promise<ContractEvents>;
         /**
@@ -1514,12 +1564,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          *
          * @tags Events
          * @name GetEventsTxIdTxid
-         * @summary Get events for a TxScript
+         * @summary Get contract events for a transaction
          * @request GET:/events/tx-id/{txId}
          */
         getEventsTxIdTxid: (txId: string, query?: {
             group?: number;
         }, params?: RequestParams) => Promise<ContractEventsByTxId>;
+        /**
+         * No description
+         *
+         * @tags Events
+         * @name GetEventsBlockHashBlockhash
+         * @summary Get contract events for a block
+         * @request GET:/events/block-hash/{blockHash}
+         */
+        getEventsBlockHashBlockhash: (blockHash: string, query?: {
+            group?: number;
+        }, params?: RequestParams) => Promise<ContractEventsByBlockHash>;
     };
 }
 export {};

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

@@ -619,12 +619,27 @@ class Api extends HttpClient {
              * No description
              *
              * @tags Blockflow
-             * @name GetBlockflow
+             * @name GetBlockflowBlocks
              * @summary List blocks on the given time interval
-             * @request GET:/blockflow
+             * @request GET:/blockflow/blocks
              */
-            getBlockflow: (query, params = {}) => this.request({
-                path: `/blockflow`,
+            getBlockflowBlocks: (query, params = {}) => this.request({
+                path: `/blockflow/blocks`,
+                method: 'GET',
+                query: query,
+                format: 'json',
+                ...params
+            }).then(utils_1.convertHttpResponse),
+            /**
+             * No description
+             *
+             * @tags Blockflow
+             * @name GetBlockflowBlocksWithEvents
+             * @summary List blocks with events on the given time interval
+             * @request GET:/blockflow/blocks-with-events
+             */
+            getBlockflowBlocksWithEvents: (query, params = {}) => this.request({
+                path: `/blockflow/blocks-with-events`,
                 method: 'GET',
                 query: query,
                 format: 'json',
@@ -644,6 +659,20 @@ class Api extends HttpClient {
                 format: 'json',
                 ...params
             }).then(utils_1.convertHttpResponse),
+            /**
+             * No description
+             *
+             * @tags Blockflow
+             * @name GetBlockflowBlocksWithEventsBlockHash
+             * @summary Get a block and events with hash
+             * @request GET:/blockflow/blocks-with-events/{block_hash}
+             */
+            getBlockflowBlocksWithEventsBlockHash: (blockHash, params = {}) => this.request({
+                path: `/blockflow/blocks-with-events/${blockHash}`,
+                method: 'GET',
+                format: 'json',
+                ...params
+            }).then(utils_1.convertHttpResponse),
             /**
              * No description
              *
@@ -1069,6 +1098,21 @@ class Api extends HttpClient {
                 format: 'json',
                 ...params
             }).then(utils_1.convertHttpResponse),
+            /**
+             * No description
+             *
+             * @tags Miners
+             * @name PostMinersCpuMiningMineOneBlock
+             * @summary Mine a block on CPU miner. !!! for test only !!!
+             * @request POST:/miners/cpu-mining/mine-one-block
+             */
+            postMinersCpuMiningMineOneBlock: (query, params = {}) => this.request({
+                path: `/miners/cpu-mining/mine-one-block`,
+                method: 'POST',
+                query: query,
+                format: 'json',
+                ...params
+            }).then(utils_1.convertHttpResponse),
             /**
              * No description
              *
@@ -1134,7 +1178,7 @@ class Api extends HttpClient {
              *
              * @tags Events
              * @name GetEventsTxIdTxid
-             * @summary Get events for a TxScript
+             * @summary Get contract events for a transaction
              * @request GET:/events/tx-id/{txId}
              */
             getEventsTxIdTxid: (txId, query, params = {}) => this.request({
@@ -1143,6 +1187,21 @@ class Api extends HttpClient {
                 query: query,
                 format: 'json',
                 ...params
+            }).then(utils_1.convertHttpResponse),
+            /**
+             * No description
+             *
+             * @tags Events
+             * @name GetEventsBlockHashBlockhash
+             * @summary Get contract events for a block
+             * @request GET:/events/block-hash/{blockHash}
+             */
+            getEventsBlockHashBlockhash: (blockHash, query, params = {}) => this.request({
+                path: `/events/block-hash/${blockHash}`,
+                method: 'GET',
+                query: query,
+                format: 'json',
+                ...params
             }).then(utils_1.convertHttpResponse)
         };
     }

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

@@ -27,7 +27,7 @@ declare class SourceFile {
     contractPath: string;
     sourceCode: string;
     sourceCodeHash: string;
-    getArtifactPath(artifactsRootPath: string): string;
+    getArtifactPath(artifactsRootDir: string): string;
     constructor(type: SourceType, sourceCode: string, sourceCodeHash: string, contractPath: string);
     static from(type: SourceType, sourceCode: string, contractPath: string): Promise<SourceFile>;
 }
@@ -58,8 +58,8 @@ export declare class Project {
     contracts: Compiled<Contract>[];
     scripts: Compiled<Script>[];
     projectArtifact: ProjectArtifact;
-    readonly contractsRootPath: string;
-    readonly artifactsRootPath: string;
+    readonly contractsRootDir: string;
+    readonly artifactsRootDir: string;
     readonly nodeProvider: NodeProvider;
     static currentProject: Project;
     static readonly abstractContractMatcher: TypedMatcher<SourceType>;
@@ -79,7 +79,9 @@ export declare class Project {
     private static loadArtifacts;
     private static loadSourceFile;
     private static loadSourceFiles;
-    static build(compilerOptionsPartial?: Partial<CompilerOptions>, contractsRootPath?: string, artifactsRootPath?: string): Promise<void>;
+    static readonly DEFAULT_CONTRACTS_DIR = "contracts";
+    static readonly DEFAULT_ARTIFACTS_DIR = "artifacts";
+    static build(compilerOptionsPartial?: Partial<CompilerOptions>, contractsRootDir?: string, artifactsRootDir?: string): Promise<void>;
 }
 export declare abstract class Artifact {
     readonly name: string;

package/dist/src/contract/contract.js

@@ -85,8 +85,8 @@ class SourceFile {
         this.sourceCodeHash = sourceCodeHash;
         this.contractPath = contractPath;
     }
-    getArtifactPath(artifactsRootPath) {
-        return artifactsRootPath + this.contractPath.slice(this.contractPath.indexOf('/')) + '.json';
+    getArtifactPath(artifactsRootDir) {
+        return artifactsRootDir + this.contractPath.slice(this.contractPath.indexOf('/')) + '.json';
     }
     static async from(type, sourceCode, contractPath) {
         const sourceCodeHash = await crypto_1.webcrypto.subtle.digest('SHA-256', buffer_1.Buffer.from(sourceCode));
@@ -155,10 +155,10 @@ class ProjectArtifact {
 }
 ProjectArtifact.artifactFileName = '.project.json';
 class Project {
-    constructor(provider, contractsRootPath, artifactsRootPath, sourceFiles, contracts, scripts, errorOnWarnings, projectArtifact) {
+    constructor(provider, contractsRootDir, artifactsRootDir, sourceFiles, contracts, scripts, errorOnWarnings, projectArtifact) {
         this.nodeProvider = provider;
-        this.contractsRootPath = contractsRootPath;
-        this.artifactsRootPath = artifactsRootPath;
+        this.contractsRootDir = contractsRootDir;
+        this.artifactsRootDir = artifactsRootDir;
         this.sourceFiles = sourceFiles;
         this.contracts = contracts;
         this.scripts = scripts;
@@ -191,11 +191,11 @@ class Project {
         return new ProjectArtifact(compilerOptions, files);
     }
     getContractPath(path) {
-        return path.startsWith(`./${this.contractsRootPath}`)
+        return path.startsWith(`./${this.contractsRootDir}`)
             ? path.slice(2)
-            : path.startsWith(this.contractsRootPath)
+            : path.startsWith(this.contractsRootDir)
                 ? path
-                : this.contractsRootPath + '/' + path;
+                : this.contractsRootDir + '/' + path;
     }
     static checkCompilerWarnings(warnings, errorOnWarnings) {
         if (warnings.length !== 0) {
@@ -225,14 +225,14 @@ class Project {
         return script.artifact;
     }
     async saveArtifactsToFile() {
-        const artifactsRootPath = this.artifactsRootPath;
+        const artifactsRootDir = this.artifactsRootDir;
         const saveToFile = async function (compiled) {
-            const artifactPath = compiled.sourceFile.getArtifactPath(artifactsRootPath);
-            const folder = artifactPath.slice(0, artifactPath.lastIndexOf('/'));
+            const artifactDir = compiled.sourceFile.getArtifactPath(artifactsRootDir);
+            const folder = artifactDir.slice(0, artifactDir.lastIndexOf('/'));
             if (!fs_1.default.existsSync(folder)) {
                 fs_1.default.mkdirSync(folder, { recursive: true });
             }
-            return fs_2.promises.writeFile(artifactPath, compiled.artifact.toString());
+            return fs_2.promises.writeFile(artifactDir, compiled.artifact.toString());
         };
         for (const contract of this.contracts) {
             await saveToFile(contract);
@@ -240,7 +240,7 @@ class Project {
         for (const script of this.scripts) {
             await saveToFile(script);
         }
-        await this.projectArtifact.saveToFile(this.artifactsRootPath);
+        await this.projectArtifact.saveToFile(this.artifactsRootDir);
     }
     contractByCodeHash(codeHash) {
         const contract = this.contracts.find((c) => c.artifact.codeHash === codeHash);
@@ -249,7 +249,7 @@ class Project {
         }
         return contract.artifact;
     }
-    static async compile(provider, files, contractsRootPath, artifactsRootPath, errorOnWarnings, compilerOptions) {
+    static async compile(provider, files, contractsRootDir, artifactsRootDir, errorOnWarnings, compilerOptions) {
         const sourceStr = files.map((f) => f.sourceCode).join('\n');
         const result = await provider.contracts.postContractsCompileProject({
             code: sourceStr,
@@ -268,11 +268,11 @@ class Project {
             scripts.push(new Compiled(sourceFile, script, scriptResult.warnings));
         });
         const projectArtifact = Project.buildProjectArtifact(files, contracts, scripts, compilerOptions);
-        const project = new Project(provider, contractsRootPath, artifactsRootPath, files, contracts, scripts, errorOnWarnings, projectArtifact);
+        const project = new Project(provider, contractsRootDir, artifactsRootDir, files, contracts, scripts, errorOnWarnings, projectArtifact);
         await project.saveArtifactsToFile();
         return project;
     }
-    static async loadArtifacts(provider, files, projectArtifact, contractsRootPath, artifactsRootPath, errorOnWarnings, compilerOptions) {
+    static async loadArtifacts(provider, files, projectArtifact, contractsRootDir, artifactsRootDir, errorOnWarnings, compilerOptions) {
         try {
             const contracts = [];
             const scripts = [];
@@ -282,21 +282,21 @@ class Project {
                     throw Error(`Unable to find project info for ${file.contractPath}, please rebuild the project`);
                 }
                 const warnings = info.warnings;
-                const artifactPath = file.getArtifactPath(artifactsRootPath);
+                const artifactDir = file.getArtifactPath(artifactsRootDir);
                 if (file.type === SourceType.Contract) {
-                    const artifact = await Contract.fromArtifactFile(artifactPath);
+                    const artifact = await Contract.fromArtifactFile(artifactDir);
                     contracts.push(new Compiled(file, artifact, warnings));
                 }
                 else if (file.type === SourceType.Script) {
-                    const artifact = await Script.fromArtifactFile(artifactPath);
+                    const artifact = await Script.fromArtifactFile(artifactDir);
                     scripts.push(new Compiled(file, artifact, warnings));
                 }
             }
-            return new Project(provider, contractsRootPath, artifactsRootPath, files, contracts, scripts, errorOnWarnings, projectArtifact);
+            return new Project(provider, contractsRootDir, artifactsRootDir, files, contracts, scripts, errorOnWarnings, projectArtifact);
         }
         catch (error) {
             console.log(`Failed to load artifacts, error: ${error}, try to re-compile contracts...`);
-            return Project.compile(provider, files, contractsRootPath, artifactsRootPath, errorOnWarnings, compilerOptions);
+            return Project.compile(provider, files, contractsRootDir, artifactsRootDir, errorOnWarnings, compilerOptions);
         }
     }
     static async loadSourceFile(dirPath, filename) {
@@ -318,7 +318,7 @@ class Project {
         const type = this.matchers[`${matcherIndex}`].type;
         return SourceFile.from(type, sourceStr, contractPath);
     }
-    static async loadSourceFiles(contractsRootPath) {
+    static async loadSourceFiles(contractsRootDir) {
         const loadDir = async function (dirPath, results) {
             const dirents = await fs_2.promises.readdir(dirPath, { withFileTypes: true });
             for (const dirent of dirents) {
@@ -333,25 +333,25 @@ class Project {
             }
         };
         const sourceFiles = [];
-        await loadDir(contractsRootPath, sourceFiles);
+        await loadDir(contractsRootDir, sourceFiles);
         const contractAndScriptSize = sourceFiles.filter((f) => f.type === SourceType.Contract || f.type === SourceType.Script).length;
         if (sourceFiles.length === 0 || contractAndScriptSize === 0) {
             throw new Error('Project have no source files');
         }
         return sourceFiles.sort((a, b) => a.type - b.type);
     }
-    static async build(compilerOptionsPartial = {}, contractsRootPath = 'contracts', artifactsRootPath = 'artifacts') {
+    static async build(compilerOptionsPartial = {}, contractsRootDir = Project.DEFAULT_CONTRACTS_DIR, artifactsRootDir = Project.DEFAULT_ARTIFACTS_DIR) {
         const provider = (0, global_1.getCurrentNodeProvider)();
-        const sourceFiles = await Project.loadSourceFiles(contractsRootPath);
+        const sourceFiles = await Project.loadSourceFiles(contractsRootDir);
         const { errorOnWarnings, ...nodeCompilerOptions } = { ...exports.DEFAULT_COMPILER_OPTIONS, ...compilerOptionsPartial };
-        const projectArtifact = await ProjectArtifact.from(artifactsRootPath);
+        const projectArtifact = await ProjectArtifact.from(artifactsRootDir);
         if (typeof projectArtifact === 'undefined' || projectArtifact.needToReCompile(nodeCompilerOptions, sourceFiles)) {
-            console.log(`Compile contracts in folder "${contractsRootPath}"`);
-            Project.currentProject = await Project.compile(provider, sourceFiles, contractsRootPath, artifactsRootPath, errorOnWarnings, nodeCompilerOptions);
+            console.log(`Compile contracts in folder "${contractsRootDir}"`);
+            Project.currentProject = await Project.compile(provider, sourceFiles, contractsRootDir, artifactsRootDir, errorOnWarnings, nodeCompilerOptions);
         }
         else {
-            console.log(`Load compiled contracts from folder "${artifactsRootPath}"`);
-            Project.currentProject = await Project.loadArtifacts(provider, sourceFiles, projectArtifact, contractsRootPath, artifactsRootPath, errorOnWarnings, nodeCompilerOptions);
+            console.log(`Load compiled contracts from folder "${artifactsRootDir}"`);
+            Project.currentProject = await Project.loadArtifacts(provider, sourceFiles, projectArtifact, contractsRootDir, artifactsRootDir, errorOnWarnings, nodeCompilerOptions);
         }
     }
 }
@@ -366,6 +366,8 @@ Project.matchers = [
     Project.interfaceMatcher,
     Project.scriptMatcher
 ];
+Project.DEFAULT_CONTRACTS_DIR = 'contracts';
+Project.DEFAULT_ARTIFACTS_DIR = 'artifacts';
 class Artifact {
     constructor(name, functions) {
         this.name = name;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.2.0-rc.12",
+  "version": "0.2.0-rc.14",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -27,7 +27,7 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "1.5.0-rc7",
+    "alephium_version": "1.5.0-rc8",
     "explorer_backend_version": "1.7.1"
   },
   "scripts": {
@@ -36,24 +36,15 @@
     "update-schemas": "npm run update-schema:alephium && npm run update-schema:explorer",
     "update-schema:alephium": "npx swagger-typescript-api --disable-throw-on-error -t ./configs -o ./src/api -n api-alephium.ts -p https://raw.githubusercontent.com/alephium/alephium/v${npm_package_config_alephium_version}/api/src/main/resources/openapi.json",
     "update-schema:explorer": "npx swagger-typescript-api --disable-throw-on-error -t ./configs -o ./src/api -n api-explorer.ts -p https://raw.githubusercontent.com/alephium/explorer-backend/v${npm_package_config_explorer_backend_version}/app/src/main/resources/explorer-backend-openapi.json",
-    "check-versions": "node scripts/check-versions.js ${npm_package_config_alephium_version} ${npm_package_config_explorer_backend_version}",
-    "start-devnet": "node scripts/start-devnet.js ${npm_package_config_alephium_version}",
-    "restart-devnet": "npm run start-devnet",
-    "stop-devnet": "node scripts/stop-devnet.js"
+    "check-versions": "node scripts/check-versions.js ${npm_package_config_alephium_version} ${npm_package_config_explorer_backend_version}"
   },
   "type": "commonjs",
-  "bin": {
-    "alephium": "dist/scripts/create-project.js"
-  },
   "dependencies": {
     "base-x": "4.0.0",
     "blakejs": "1.2.1",
     "buffer": "^6.0.3",
-    "commander": "^9.1.0",
     "cross-fetch": "^3.1.5",
-    "eventemitter3": "^4.0.7",
-    "find-up": "^2.1.0",
-    "fs-extra": "^10.0.1"
+    "eventemitter3": "^4.0.7"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.18.9",