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

package/src/api/api-alephium.ts

@@ -124,6 +124,11 @@ export interface Banned {
   type: string
 }
 
+export interface BlockAndEvents {
+  block: BlockEntry
+  events: ContractEventByBlockHash[]
+}
+
 export interface BlockEntry {
   /** @format block-hash */
   hash: string
@@ -174,6 +179,14 @@ export interface BlockHeaderEntry {
   deps: string[]
 }
 
+export interface BlocksAndEventsPerTimeStampRange {
+  blocksAndEvents: BlockAndEvents[][]
+}
+
+export interface BlocksPerTimeStampRange {
+  blocks: BlockEntry[][]
+}
+
 export interface BrokerInfo {
   /** @format clique-id */
   cliqueId: string
@@ -490,6 +503,18 @@ export interface ContractEvent {
   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
@@ -509,11 +534,12 @@ export interface ContractEvents {
   nextStart: number
 }
 
+export interface ContractEventsByBlockHash {
+  events: ContractEventByBlockHash[]
+}
+
 export interface ContractEventsByTxId {
   events: ContractEventByTxId[]
-
-  /** @format int32 */
-  nextStart: number
 }
 
 export interface ContractOutput {
@@ -584,10 +610,6 @@ export interface EventSig {
   fieldTypes: string[]
 }
 
-export interface FetchResponse {
-  blocks: BlockEntry[][]
-}
-
 export interface FieldsSig {
   names: string[]
   types: string[]
@@ -1085,16 +1107,7 @@ export interface WalletUnlock {
 }
 
 import 'cross-fetch/polyfill'
-
-function convertHttpResponse<T>(
-  response: HttpResponse<T, { detail: string }> | HttpResponse<T, { detail: string }>
-): T {
-  if (response.error) {
-    throw new Error(response.error.detail)
-  } else {
-    return response.data
-  }
-}
+import { convertHttpResponse } from './utils'
 
 export type QueryParamsType = Record<string | number, any>
 export type ResponseFormat = keyof Omit<Body, 'body' | 'bodyUsed'>
@@ -1298,7 +1311,6 @@ export class HttpClient<SecurityDataType = unknown> {
         this.abortControllers.delete(cancelToken)
       }
 
-      if (!response.ok) throw data
       return data
     })
   }
@@ -1857,13 +1869,36 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * No description
      *
      * @tags Blockflow
-     * @name GetBlockflow
+     * @name GetBlockflowBlocks
      * @summary List blocks on the given time interval
-     * @request GET:/blockflow
+     * @request GET:/blockflow/blocks
+     */
+    getBlockflowBlocks: (query: { fromTs: number; toTs?: number }, params: RequestParams = {}) =>
+      this.request<
+        BlocksPerTimeStampRange,
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/blockflow/blocks`,
+        method: 'GET',
+        query: query,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * No description
+     *
+     * @tags Blockflow
+     * @name GetBlockflowBlocksWithEvents
+     * @summary List blocks with events on the given time interval
+     * @request GET:/blockflow/blocks-with-events
      */
-    getBlockflow: (query: { fromTs: number; toTs?: number }, params: RequestParams = {}) =>
-      this.request<FetchResponse, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
-        path: `/blockflow`,
+    getBlockflowBlocksWithEvents: (query: { fromTs: number; toTs?: number }, params: RequestParams = {}) =>
+      this.request<
+        BlocksAndEventsPerTimeStampRange,
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/blockflow/blocks-with-events`,
         method: 'GET',
         query: query,
         format: 'json',
@@ -1886,6 +1921,22 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params
       }).then(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: string, params: RequestParams = {}) =>
+      this.request<BlockAndEvents, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/blockflow/blocks-with-events/${blockHash}`,
+        method: 'GET',
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
     /**
      * No description
      *
@@ -2399,6 +2450,23 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params
       }).then(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: { fromGroup: number; toGroup: number }, params: RequestParams = {}) =>
+      this.request<boolean, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/miners/cpu-mining/mine-one-block`,
+        method: 'POST',
+        query: query,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
     /**
      * No description
      *
@@ -2443,7 +2511,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      */
     getEventsContractContractaddress: (
       contractAddress: string,
-      query: { start: number; end?: number; group?: number },
+      query: { start: number; limit?: number; group?: number },
       params: RequestParams = {}
     ) =>
       this.request<ContractEvents, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
@@ -2475,7 +2543,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      *
      * @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 = {}) =>
@@ -2488,6 +2556,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         query: query,
         format: 'json',
         ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * 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 = {}) =>
+      this.request<
+        ContractEventsByBlockHash,
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/events/block-hash/${blockHash}`,
+        method: 'GET',
+        query: query,
+        format: 'json',
+        ...params
       }).then(convertHttpResponse)
   }
 }

package/src/api/api-explorer.ts

@@ -278,16 +278,7 @@ export interface UnconfirmedTransaction {
 }
 
 import 'cross-fetch/polyfill'
-
-function convertHttpResponse<T>(
-  response: HttpResponse<T, { detail: string }> | HttpResponse<T, { detail: string }>
-): T {
-  if (response.error) {
-    throw new Error(response.error.detail)
-  } else {
-    return response.data
-  }
-}
+import { convertHttpResponse } from './utils'
 
 export type QueryParamsType = Record<string | number, any>
 export type ResponseFormat = keyof Omit<Body, 'body' | 'bodyUsed'>
@@ -491,7 +482,6 @@ export class HttpClient<SecurityDataType = unknown> {
         this.abortControllers.delete(cancelToken)
       }
 
-      if (!response.ok) throw data
       return data
     })
   }

package/{scripts/stop-devnet.js → src/api/utils.ts}

@@ -16,17 +16,10 @@ 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/>.
 */
 
-const fs = require('fs')
-const process = require('process')
-const path = require('path')
-
-const pidFile = process.cwd() + path.sep + 'dev' + path.sep + 'alephium.pid'
-try {
-  const pid = parseInt(fs.readFileSync(pidFile).toString())
-  if (pid) {
-    console.log(`Stopping the running devnet: ${pid}`)
-    process.kill(pid)
+export function convertHttpResponse<T>(response: { data: T; error?: { detail: string } }): T {
+  if (response.error) {
+    throw new Error(`[Node API Error] - ${response.error.detail}`)
+  } else {
+    return response.data
   }
-} catch (e) {
-  console.log(`Error in stopping the running devnet: ${e}`)
 }

package/src/contract/contract.ts

@@ -90,8 +90,8 @@ class SourceFile {
   sourceCode: string
   sourceCodeHash: string
 
-  getArtifactPath(artifactsRootPath: string): string {
-    return artifactsRootPath + this.contractPath.slice(this.contractPath.indexOf('/')) + '.json'
+  getArtifactPath(artifactsRootDir: string): string {
+    return artifactsRootDir + this.contractPath.slice(this.contractPath.indexOf('/')) + '.json'
   }
 
   constructor(type: SourceType, sourceCode: string, sourceCodeHash: string, contractPath: string) {
@@ -195,8 +195,8 @@ export class Project {
   scripts: Compiled<Script>[]
   projectArtifact: ProjectArtifact
 
-  readonly contractsRootPath: string
-  readonly artifactsRootPath: string
+  readonly contractsRootDir: string
+  readonly artifactsRootDir: string
   readonly nodeProvider: NodeProvider
 
   static currentProject: Project
@@ -246,8 +246,8 @@ export class Project {
 
   private constructor(
     provider: NodeProvider,
-    contractsRootPath: string,
-    artifactsRootPath: string,
+    contractsRootDir: string,
+    artifactsRootDir: string,
     sourceFiles: SourceFile[],
     contracts: Compiled<Contract>[],
     scripts: Compiled<Script>[],
@@ -255,8 +255,8 @@ export class Project {
     projectArtifact: 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
@@ -271,11 +271,11 @@ export class Project {
   }
 
   private getContractPath(path: string): string {
-    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: string[], errorOnWarnings: boolean): void {
@@ -308,14 +308,14 @@ export class Project {
   }
 
   private async saveArtifactsToFile(): Promise<void> {
-    const artifactsRootPath = this.artifactsRootPath
+    const artifactsRootDir = this.artifactsRootDir
     const saveToFile = async function (compiled: Compiled<Artifact>): Promise<void> {
-      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.existsSync(folder)) {
         fs.mkdirSync(folder, { recursive: true })
       }
-      return fsPromises.writeFile(artifactPath, compiled.artifact.toString())
+      return fsPromises.writeFile(artifactDir, compiled.artifact.toString())
     }
     for (const contract of this.contracts) {
       await saveToFile(contract)
@@ -323,7 +323,7 @@ export 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: string): Contract {
@@ -337,8 +337,8 @@ export class Project {
   private static async compile(
     provider: NodeProvider,
     files: SourceFile[],
-    contractsRootPath: string,
-    artifactsRootPath: string,
+    contractsRootDir: string,
+    artifactsRootDir: string,
     errorOnWarnings: boolean,
     compilerOptions: node.CompilerOptions
   ): Promise<Project> {
@@ -362,8 +362,8 @@ export class Project {
     const projectArtifact = Project.buildProjectArtifact(files, contracts, scripts, compilerOptions)
     const project = new Project(
       provider,
-      contractsRootPath,
-      artifactsRootPath,
+      contractsRootDir,
+      artifactsRootDir,
       files,
       contracts,
       scripts,
@@ -378,8 +378,8 @@ export class Project {
     provider: NodeProvider,
     files: SourceFile[],
     projectArtifact: ProjectArtifact,
-    contractsRootPath: string,
-    artifactsRootPath: string,
+    contractsRootDir: string,
+    artifactsRootDir: string,
     errorOnWarnings: boolean,
     compilerOptions: node.CompilerOptions
   ): Promise<Project> {
@@ -392,20 +392,20 @@ export 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,
+        contractsRootDir,
+        artifactsRootDir,
         files,
         contracts,
         scripts,
@@ -414,7 +414,7 @@ export class Project {
       )
     } 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)
     }
   }
 
@@ -439,7 +439,7 @@ export class Project {
     return SourceFile.from(type, sourceStr, contractPath)
   }
 
-  private static async loadSourceFiles(contractsRootPath: string): Promise<SourceFile[]> {
+  private static async loadSourceFiles(contractsRootDir: string): Promise<SourceFile[]> {
     const loadDir = async function (dirPath: string, results: SourceFile[]): Promise<void> {
       const dirents = await fsPromises.readdir(dirPath, { withFileTypes: true })
       for (const dirent of dirents) {
@@ -453,7 +453,7 @@ export class Project {
       }
     }
     const sourceFiles: SourceFile[] = []
-    await loadDir(contractsRootPath, sourceFiles)
+    await loadDir(contractsRootDir, sourceFiles)
     const contractAndScriptSize = sourceFiles.filter(
       (f) => f.type === SourceType.Contract || f.type === SourceType.Script
     ).length
@@ -463,33 +463,36 @@ export class Project {
     return sourceFiles.sort((a, b) => a.type - b.type)
   }
 
+  static readonly DEFAULT_CONTRACTS_DIR = 'contracts'
+  static readonly DEFAULT_ARTIFACTS_DIR = 'artifacts'
+
   static async build(
     compilerOptionsPartial: Partial<CompilerOptions> = {},
-    contractsRootPath = 'contracts',
-    artifactsRootPath = 'artifacts'
+    contractsRootDir = Project.DEFAULT_CONTRACTS_DIR,
+    artifactsRootDir = Project.DEFAULT_ARTIFACTS_DIR
   ): Promise<void> {
     const provider = getCurrentNodeProvider()
-    const sourceFiles = await Project.loadSourceFiles(contractsRootPath)
+    const sourceFiles = await Project.loadSourceFiles(contractsRootDir)
     const { errorOnWarnings, ...nodeCompilerOptions } = { ...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}"`)
+      console.log(`Compile contracts in folder "${contractsRootDir}"`)
       Project.currentProject = await Project.compile(
         provider,
         sourceFiles,
-        contractsRootPath,
-        artifactsRootPath,
+        contractsRootDir,
+        artifactsRootDir,
         errorOnWarnings,
         nodeCompilerOptions
       )
     } else {
-      console.log(`Load compiled contracts from folder "${artifactsRootPath}"`)
+      console.log(`Load compiled contracts from folder "${artifactsRootDir}"`)
       Project.currentProject = await Project.loadArtifacts(
         provider,
         sourceFiles,
         projectArtifact,
-        contractsRootPath,
-        artifactsRootPath,
+        contractsRootDir,
+        artifactsRootDir,
         errorOnWarnings,
         nodeCompilerOptions
       )

package/src/utils/utils.ts

@@ -24,21 +24,9 @@ import { Buffer } from 'buffer/'
 
 import { TOTAL_NUMBER_OF_GROUPS } from '../constants'
 import djb2 from './djb2'
-import * as node from '../api/api-alephium'
-import * as explorer from '../api/api-explorer'
 
 const ec = new EC('secp256k1')
 
-export function convertHttpResponse<T>(
-  response: node.HttpResponse<T, { detail: string }> | explorer.HttpResponse<T, { detail: string }>
-): T {
-  if (response.error) {
-    throw new Error(response.error.detail)
-  } else {
-    return response.data
-  }
-}
-
 export function signatureEncode(signature: EC.Signature): string {
   let sNormalized = signature.s
   if (ec.n && signature.s.cmp(ec.nh) === 1) {

package/contracts/greeter/greeter.ral

@@ -1,7 +0,0 @@
-Contract Greeter(btcPrice: U256) implements GreeterInterface {
-    @using(readonly = true)
-    pub fn greet() -> U256 {
-        checkCaller!(true, 0)
-        return btcPrice
-    }
-}

package/contracts/greeter/greeter_interface.ral

@@ -1,4 +0,0 @@
-Interface GreeterInterface {
-    @using(readonly = true)
-    pub fn greet() -> U256
-}

package/contracts/greeter_main.ral

@@ -1,7 +0,0 @@
-TxScript GreeterMain(greeterContractId: ByteVec) {
-    let greeter0 = Greeter(greeterContractId)
-    assert!(greeter0.greet() == 1, 0)
-
-    let greeter1 = GreeterInterface(greeterContractId)
-    assert!(greeter1.greet() == 1, 0)
-}

package/dev/user.conf

@@ -1,29 +0,0 @@
-// in most cases, modify the following two lines
-alephium.genesis.allocations = [{address = "1DrDyTr9RpRsQnDnXo2YRiPzPW4ooHX5LLoqXrqfMrpQH", amount = 1000000000000000000000000, lock-duration = 0 seconds}] // 1 million token allocated for your address
-alephium.consensus.num-zeros-at-least-in-hash = 0
-alephium.consensus.uncle-dependency-gap-time = 0 seconds
-alephium.network.leman-hard-fork-timestamp = 1643500800000 // GMT: 30 January 2022 00:00:00
-
-alephium.network.network-id = 4
-alephium.discovery.bootstrap = []
-alephium.wallet.locking-timeout = 99999 minutes
-alephium.mempool.auto-mine-for-dev = true
-alephium.node.event-log.enabled=true
-
-alephium.network.rest-port = 22973
-alephium.network.ws-port = 21973
-alephium.network.miner-api-port = 20973
-alephium.api.network-interface = "0.0.0.0"
-alephium.api.api-key-enabled = false
-alephium.mining.api-interface = "0.0.0.0"
-alephium.network.bind-address  = "0.0.0.0:19973"
-alephium.network.internal-address  = "alephium:19973"
-alephium.network.coordinator-address  = "alephium:19973"
-
-// arbitrary mining addresses
-alephium.mining.miner-addresses = [
-"1FsroWmeJPBhcPiUr37pWXdojRBe6jdey9uukEXk1TheA",
-"1CQvSXsmM5BMFKguKDPpNUfw1idiut8UifLtT8748JdHc",
-"193maApeJWrz9GFwWCfa982ccLARVE9Y1WgKSJaUs7UAx",
-"16fZKYPCZJv2TP3FArA9FLUQceTS9U8xVnSjxFG9MBKyY"
-]

package/dist/scripts/create-project.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};