@alephium/web3 0.1.0 → 0.2.0-rc.10

package/src/contract/events.ts

@@ -16,64 +16,33 @@ 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 EventEmitter from 'eventemitter3'
-import { node } from '../api'
-import { NodeProvider } from '../api'
+import { ContractEvent } from '../api/api-alephium'
+import { Subscription, SubscribeOptions } from '../utils'
 
-type EventCallback = (event: node.ContractEvent) => Promise<void>
-type ErrorCallback = (error: any, subscription: Subscription) => Promise<void>
-
-export interface SubscribeOptions {
-  provider: NodeProvider
-  contractAddress: string
-  fromCount?: number
-  pollingInterval: number
-  eventCallback: EventCallback
-  errorCallback: ErrorCallback
-}
-
-export class Subscription {
-  provider: NodeProvider
+export class EventSubscription extends Subscription<ContractEvent> {
   readonly contractAddress: string
-  pollingInterval: number
-
   private fromCount: number
-  private eventCallback: EventCallback
-  private errorCallback: ErrorCallback
-  private task: ReturnType<typeof setTimeout> | undefined
-  private cancelled: boolean
-  private eventEmitter: EventEmitter
 
-  constructor(options: SubscribeOptions) {
-    this.provider = options.provider
-    this.contractAddress = options.contractAddress
-    this.fromCount = typeof options.fromCount === 'undefined' ? 0 : options.fromCount
-    this.pollingInterval = options.pollingInterval
-    this.eventCallback = options.eventCallback
-    this.errorCallback = options.errorCallback
-    this.task = undefined
-    this.cancelled = false
+  constructor(options: SubscribeOptions<ContractEvent>, contractAddress: string, fromCount?: number) {
+    super(options)
+    this.contractAddress = contractAddress
+    this.fromCount = typeof fromCount === 'undefined' ? 0 : fromCount
 
-    this.eventEmitter = new EventEmitter()
+    this.startPolling()
+  }
+
+  override startPolling(): void {
     this.eventEmitter.on('tick', async () => {
-      await this.fetchEvents()
+      await this.polling()
     })
     this.eventEmitter.emit('tick')
   }
 
-  unsubscribe(): void {
-    this.eventEmitter.removeAllListeners()
-    this.cancelled = true
-    if (typeof this.task !== 'undefined') {
-      clearTimeout(this.task)
-    }
-  }
-
   currentEventCount(): number {
     return this.fromCount
   }
 
-  private async fetchEvents() {
+  override async polling(): Promise<void> {
     try {
       const events = await this.provider.events.getEventsContractContractaddress(this.contractAddress, {
         start: this.fromCount
@@ -87,16 +56,20 @@ export class Subscription {
         return
       }
 
-      const promises = events.events.map((event) => this.eventCallback(event))
+      const promises = events.events.map((event) => this.messageCallback(event))
       await Promise.all(promises)
       this.fromCount = events.nextStart
-      await this.fetchEvents()
+      await this.polling()
     } catch (err) {
       await this.errorCallback(err, this)
     }
   }
 }
 
-export function subscribe(options: SubscribeOptions): Subscription {
-  return new Subscription(options)
+export function subscribeToEvents(
+  options: SubscribeOptions<ContractEvent>,
+  contractAddress: string,
+  fromCount?: number
+): EventSubscription {
+  return new EventSubscription(options, contractAddress, fromCount)
 }

package/src/{utils/transaction.ts → global.ts}

@@ -16,24 +16,23 @@ 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 { ec as EC } from 'elliptic'
+import { NodeProvider } from './api'
 
-import * as utils from './utils'
+let _currentNodeProvider: NodeProvider | undefined = undefined
 
-const ec = new EC('secp256k1')
-
-export function transactionSign(txHash: string, privateKey: string): string {
-  const keyPair = ec.keyFromPrivate(privateKey)
-  const signature = keyPair.sign(txHash)
-
-  return utils.signatureEncode(signature)
+export function setCurrentNodeProvider(provider: NodeProvider): void
+export function setCurrentNodeProvider(baseUrl: string, apiKey?: string): void
+export function setCurrentNodeProvider(provider: NodeProvider | string, apiKey?: string): void {
+  if (typeof provider == 'string') {
+    _currentNodeProvider = new NodeProvider(provider, apiKey)
+  } else {
+    _currentNodeProvider = provider
+  }
 }
 
-export function transactionVerifySignature(txHash: string, publicKey: string, signature: string): boolean {
-  try {
-    const key = ec.keyFromPublic(publicKey, 'hex')
-    return key.verify(txHash, utils.signatureDecode(ec, signature))
-  } catch (error) {
-    return false
+export function getCurrentNodeProvider(): NodeProvider {
+  if (typeof _currentNodeProvider === 'undefined') {
+    throw Error('No node provider is set.')
   }
+  return _currentNodeProvider
 }

package/src/index.ts

@@ -20,5 +20,9 @@ export * from './api'
 export * from './contract'
 export * from './signer'
 export * from './utils'
+export * from './transaction'
 
 export * from './constants'
+export * as web3 from './global'
+
+export * as utils from './utils'

package/src/signer/index.ts

@@ -17,4 +17,3 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
 export * from './signer'
-export * from './node-wallet'

package/src/signer/signer.ts

@@ -23,6 +23,7 @@ import * as utils from '../utils'
 import { Eq, assertType } from '../utils'
 import blake from 'blakejs'
 import { Token } from '../api/api-alephium'
+import { getCurrentNodeProvider } from '../global'
 
 const ec = new EC('secp256k1')
 
@@ -42,7 +43,7 @@ export interface Account {
 
 export type SubmitTx = { submitTx?: boolean }
 export type SignerAddress = { signerAddress: string }
-type TxBuildParams<T> = Omit<T, 'fromPublicKey'> & SignerAddress & SubmitTx
+type TxBuildParams<T> = Omit<T, 'fromPublicKey' | 'targetBlockHash'> & SignerAddress & SubmitTx
 
 export type GetAccountsParams = undefined
 export type GetAccountsResult = Account[]
@@ -167,8 +168,8 @@ export abstract class SignerWithNodeProvider implements SignerProvider {
     }
   }
 
-  constructor(provider: NodeProvider, alwaysSubmitTx: boolean) {
-    this.provider = provider
+  constructor(alwaysSubmitTx: boolean) {
+    this.provider = getCurrentNodeProvider()
     this.alwaysSubmitTx = alwaysSubmitTx
   }
 

package/src/{utils/password-crypto.test.ts → transaction/index.ts}

@@ -16,12 +16,4 @@ 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 { decrypt } from './password-crypto'
-
-describe('password-crypto', () => {
-  it('should raise an error if payload version is not 1', () => {
-    const password = 'passw0rd'
-    const payloadRaw = '{"version":2}'
-    expect(() => decrypt(password, payloadRaw)).toThrow('Invalid version: got 2, expected: 1')
-  })
-})
+export * from './status'

package/src/transaction/status.ts

@@ -0,0 +1,58 @@
+/*
+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/>.
+*/
+
+import { TxStatus } from '../api/api-alephium'
+import { Subscription, SubscribeOptions } from '../utils'
+
+export class TxStatusSubscription extends Subscription<TxStatus> {
+  readonly txId: string
+  readonly fromGroup?: number
+  readonly toGroup?: number
+
+  constructor(options: SubscribeOptions<TxStatus>, txId: string, fromGroup?: number, toGroup?: number) {
+    super(options)
+    this.txId = txId
+    this.fromGroup = fromGroup
+    this.toGroup = toGroup
+
+    this.startPolling()
+  }
+
+  override async polling(): Promise<void> {
+    try {
+      const txStatus = await this.provider.transactions.getTransactionsStatus({
+        txId: this.txId,
+        fromGroup: this.fromGroup,
+        toGroup: this.toGroup
+      })
+
+      await this.messageCallback(txStatus)
+    } catch (err) {
+      await this.errorCallback(err, this)
+    }
+  }
+}
+
+export function subscribeToTxStatus(
+  options: SubscribeOptions<TxStatus>,
+  txId: string,
+  fromGroup?: number,
+  toGroup?: number
+): TxStatusSubscription {
+  return new TxStatusSubscription(options, txId, fromGroup, toGroup)
+}

package/src/utils/index.ts

@@ -19,6 +19,5 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 export * from './address'
 export * from './bs58'
 export * from './djb2'
-export * from './password-crypto'
-export * from './transaction'
 export * from './utils'
+export * from './subscription'

package/src/utils/subscription.ts

@@ -0,0 +1,72 @@
+/*
+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/>.
+*/
+
+import EventEmitter from 'eventemitter3'
+import { getCurrentNodeProvider } from '../global'
+import { NodeProvider } from '../api'
+
+type MessageCallback<Message> = (message: Message) => Promise<void>
+type ErrorCallback<Message> = (error: any, subscription: Subscription<Message>) => Promise<void>
+
+export interface SubscribeOptions<Message> {
+  pollingInterval: number
+  messageCallback: MessageCallback<Message>
+  errorCallback: ErrorCallback<Message>
+}
+
+export abstract class Subscription<Message> {
+  provider: NodeProvider
+  pollingInterval: number
+
+  protected messageCallback: MessageCallback<Message>
+  protected errorCallback: ErrorCallback<Message>
+  protected task: ReturnType<typeof setTimeout> | undefined
+  protected eventEmitter: EventEmitter
+  protected cancelled: boolean
+
+  constructor(options: SubscribeOptions<Message>) {
+    this.provider = getCurrentNodeProvider()
+    this.pollingInterval = options.pollingInterval
+    this.messageCallback = options.messageCallback
+    this.errorCallback = options.errorCallback
+    this.task = undefined
+    this.cancelled = false
+    this.eventEmitter = new EventEmitter()
+  }
+
+  startPolling(): void {
+    this.eventEmitter.on('tick', async () => {
+      await this.polling()
+
+      if (!this.cancelled) {
+        this.task = setTimeout(() => this.eventEmitter.emit('tick'), this.pollingInterval)
+      }
+    })
+    this.eventEmitter.emit('tick')
+  }
+
+  unsubscribe(): void {
+    this.eventEmitter.removeAllListeners()
+    this.cancelled = true
+    if (typeof this.task !== 'undefined') {
+      clearTimeout(this.task)
+    }
+  }
+
+  abstract polling(): Promise<void>
+}

package/src/utils/utils.ts

@@ -51,7 +51,7 @@ export function signatureEncode(signature: EC.Signature): string {
 }
 
 // the signature should be in hex string format for 64 bytes
-export const signatureDecode = (ec: EC, signature: string): SignatureInput => {
+export function signatureDecode(ec: EC, signature: string): SignatureInput {
   if (signature.length !== 128) {
     throw new Error('Invalid signature length')
   }
@@ -66,7 +66,7 @@ export const signatureDecode = (ec: EC, signature: string): SignatureInput => {
   }
 }
 
-const xorByte = (intValue: number) => {
+export function xorByte(intValue: number): number {
   const byte0 = (intValue >> 24) & 0xff
   const byte1 = (intValue >> 16) & 0xff
   const byte2 = (intValue >> 8) & 0xff
@@ -85,7 +85,7 @@ enum AddressType {
   P2C = 0x03
 }
 
-export const groupOfAddress = (address: string): number => {
+export function groupOfAddress(address: string): number {
   const decoded = bs58.decode(address)
 
   if (decoded.length == 0) throw new Error('Address string is empty')
@@ -103,7 +103,7 @@ export const groupOfAddress = (address: string): number => {
   }
 }
 
-const groupOfAddressBytes = (bytes: Uint8Array): number => {
+function groupOfAddressBytes(bytes: Uint8Array): number {
   const hint = djb2(bytes) | 1
   const hash = xorByte(hint)
   const group = hash % TOTAL_NUMBER_OF_GROUPS
@@ -111,7 +111,7 @@ const groupOfAddressBytes = (bytes: Uint8Array): number => {
 }
 
 // Pay to public key hash address
-const groupOfP2pkhAddress = (address: Uint8Array): number => {
+function groupOfP2pkhAddress(address: Uint8Array): number {
   if (address.length != 32) {
     throw new Error(`Invalid p2pkh address length: ${address.length}`)
   }
@@ -120,7 +120,7 @@ const groupOfP2pkhAddress = (address: Uint8Array): number => {
 }
 
 // Pay to multiple public key hash address
-const groupOfP2mpkhAddress = (address: Uint8Array): number => {
+function groupOfP2mpkhAddress(address: Uint8Array): number {
   if ((address.length - 2) % 32 != 0) {
     throw new Error(`Invalid p2mpkh address length: ${address.length}`)
   }
@@ -129,7 +129,7 @@ const groupOfP2mpkhAddress = (address: Uint8Array): number => {
 }
 
 // Pay to script hash address
-const groupOfP2shAddress = (address: Uint8Array): number => {
+function groupOfP2shAddress(address: Uint8Array): number {
   return groupOfAddressBytes(address)
 }
 
@@ -190,7 +190,7 @@ export function contractIdFromTx(txId: string, outputIndex: number): string {
 }
 
 export function subContractId(parentContractId: string, pathInHex: string): string {
-  const data = Buffer.concat([hexToBinUnsafe(pathInHex), hexToBinUnsafe(parentContractId)])
+  const data = Buffer.concat([hexToBinUnsafe(parentContractId), hexToBinUnsafe(pathInHex)])
 
   return binToHex(blake.blake2b(blake.blake2b(data, undefined, 32), undefined, 32))
 }
@@ -203,6 +203,14 @@ export function stringToHex(str: string): string {
   return hex
 }
 
+export function hexToString(str: string): string {
+  return Buffer.from(str, 'hex').toString()
+}
+
+export function timeout(ms: number): Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, ms))
+}
+
 type _Eq<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false
 export type Eq<X, Y> = _Eq<{ [P in keyof X]: X[P] }, { [P in keyof Y]: Y[P] }>
 // eslint-disable-next-line @typescript-eslint/no-empty-function, @typescript-eslint/no-unused-vars

package/templates/base/package.json

@@ -3,7 +3,7 @@
   "version": "0.1.0",
   "license": "GPL",
   "config": {
-    "alephium_version": "1.4.0-rc2"
+    "alephium_version": "1.5.0-rc7"
   },
   "scripts": {
     "build": "rm -rf dist && npx tsc --build .",
@@ -12,7 +12,7 @@
     "stop-devnet": "node scripts/stop-devnet.js"
   },
   "dependencies": {
-    "@alephium/web3": "0.1.0"
+    "@alephium/web3": "0.2.0-rc.9"
   },
   "devDependencies": {
     "@types/elliptic": "^6.4.13",

package/templates/base/src/greeter.ts

@@ -2,21 +2,22 @@
  * greeter.ts
  */
 
-import { NodeProvider, Contract, Script, TestContractParams } from '@alephium/web3'
-import { testWallet } from '@alephium/web3/test'
+import { TestContractParams, web3, Project } from '@alephium/web3'
+import { testNodeWallet } from '@alephium/web3/test'
 
 async function greet() {
-  const provider = new NodeProvider('http://127.0.0.1:22973')
+  web3.setCurrentNodeProvider('http://127.0.0.1:22973')
+  await Project.build()
 
-  const greeter = await Contract.fromSource(provider, 'greeter.ral')
+  const greeter = Project.contract('greeter/greeter.ral')
 
   const testParams: TestContractParams = {
     initialFields: { btcPrice: 1 }
   }
-  const testResult = await greeter.testPublicMethod(provider, 'greet', testParams)
+  const testResult = await greeter.testPublicMethod('greet', testParams)
   console.log(testResult)
 
-  const signer = await testWallet(provider)
+  const signer = await testNodeWallet()
 
   const deployTx = await greeter.transactionForDeployment(signer, { initialFields: testParams.initialFields })
   const greeterContractId = deployTx.contractId
@@ -26,7 +27,7 @@ async function greet() {
   const submitResult = await signer.submitTransaction(deployTx.unsignedTx, deployTx.txId)
   console.log(submitResult)
 
-  const main = await Script.fromSource(provider, 'greeter_main.ral')
+  const main = Project.script('greeter_main.ral')
 
   const mainScriptTx = await main.transactionForDeployment(signer, {
     initialFields: { greeterContractId: greeterContractId }

package/templates/react/package.json

@@ -2,7 +2,7 @@
   "name": "my-dapp",
   "version": "0.1.0",
   "config": {
-    "alephium_version": "1.4.0-rc2"
+    "alephium_version": "1.5.0-rc7"
   },
   "dependencies": {
     "@testing-library/jest-dom": "^5.16.4",
@@ -12,7 +12,7 @@
     "@types/node": "^16.11.26",
     "@types/react": "^18.0.3",
     "@types/react-dom": "^18.0.0",
-    "@alephium/web3": "0.1.0",
+    "@alephium/web3": "0.2.0-rc.9",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
     "react-scripts": "5.0.1",

package/templates/react/src/App.tsx

@@ -1,12 +1,12 @@
 import React, { useEffect, useState } from 'react'
 import './App.css'
 
-import { explorer, Contract, Script } from '@alephium/web3'
+import { ExplorerProvider, Contract, Script } from '@alephium/web3'
 import contractJson from './artifacts/greeter.ral.json'
 import scriptJson from './artifacts/greeter_main.ral.json'
 
 function Dashboard() {
-  const api = new explorer.Api<null>({ baseUrl: 'https://mainnet-backend.alephium.org' })
+  const api = new ExplorerProvider('https://mainnet-backend.alephium.org')
   const contract = Contract.fromJson(contractJson).toString()
   const script = Script.fromJson(scriptJson).toString()
   const [blocks, setBlocks] = useState('')

package/.eslintrc.json

@@ -1,21 +0,0 @@
-{
-  "plugins": ["security", "header"],
-  "extends": [
-    "prettier",
-    "plugin:prettier/recommended",
-    "plugin:security/recommended",
-    "plugin:@typescript-eslint/recommended"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "rules": {
-    "header/header": [2, "scripts/header.js"]
-  },
-  "overrides": [
-    {
-      "files": ["*.ts"],
-      "rules": {
-        "security/detect-non-literal-fs-filename": "off"
-      }
-    }
-  ]
-}