@alephium/web3 0.40.0 → 0.42.0

package/src/contract/events.ts

@@ -16,33 +16,24 @@ 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 { web3 } from '..'
+import * as web3 from '../global'
 import { node } from '../api'
 import { Subscription, SubscribeOptions } from '../utils'
 
 export interface EventSubscribeOptions<Message> extends SubscribeOptions<Message> {
-  onEventCountChanged?: (eventCount: number) => Promise<void>
+  onEventCountChanged?: (eventCount: number) => Promise<void> | void
 }
 
 export class EventSubscription extends Subscription<node.ContractEvent> {
   readonly contractAddress: string
   private fromCount: number
-  private onEventCountChanged?: (eventCount: number) => Promise<void>
+  private onEventCountChanged?: (eventCount: number) => Promise<void> | void
 
   constructor(options: EventSubscribeOptions<node.ContractEvent>, contractAddress: string, fromCount?: number) {
     super(options)
     this.contractAddress = contractAddress
     this.fromCount = typeof fromCount === 'undefined' ? 0 : fromCount
     this.onEventCountChanged = options.onEventCountChanged
-
-    this.startPolling()
-  }
-
-  override startPolling(): void {
-    this.eventEmitter.on('tick', async () => {
-      await this.polling()
-    })
-    this.eventEmitter.emit('tick')
   }
 
   currentEventCount(): number {
@@ -54,12 +45,7 @@ export class EventSubscription extends Subscription<node.ContractEvent> {
       const events = await web3.getCurrentNodeProvider().events.getEventsContractContractaddress(this.contractAddress, {
         start: this.fromCount
       })
-      if (this.cancelled) {
-        return
-      }
-
       if (this.fromCount === events.nextStart) {
-        this.task = setTimeout(() => this.eventEmitter.emit('tick'), this.pollingInterval)
         return
       }
 
@@ -83,5 +69,7 @@ export function subscribeToEvents(
   contractAddress: string,
   fromCount?: number
 ): EventSubscription {
-  return new EventSubscription(options, contractAddress, fromCount)
+  const subscription = new EventSubscription(options, contractAddress, fromCount)
+  subscription.subscribe()
+  return subscription
 }

package/src/index.ts

@@ -32,3 +32,4 @@ export * as web3 from './global'
 export * as codec from './codec'
 export * as utils from './utils'
 export * from './debug'
+export * from './block'

package/src/signer/tx-builder.ts

@@ -16,7 +16,7 @@ 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 { utils } from '..'
+import { binToHex, contractIdFromAddress } from '../utils'
 import { fromApiNumber256, node, NodeProvider, toApiNumber256Optional, toApiTokens } from '../api'
 import { addressFromPublicKey } from '../utils'
 import { toApiDestinations } from './signer'
@@ -90,7 +90,7 @@ export abstract class TransactionBuilder {
       ...rest
     }
     const response = await this.nodeProvider.contracts.postContractsUnsignedTxDeployContract(data)
-    const contractId = utils.binToHex(utils.contractIdFromAddress(response.contractAddress))
+    const contractId = binToHex(contractIdFromAddress(response.contractAddress))
     return { ...response, groupIndex: response.fromGroup, contractId, gasPrice: fromApiNumber256(response.gasPrice) }
   }
 

package/src/transaction/index.ts

@@ -18,3 +18,4 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 
 export * from './status'
 export * from './sign-verify'
+export * from './utils'

package/src/transaction/status.ts

@@ -16,7 +16,7 @@ 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 { web3 } from '..'
+import * as web3 from '../global'
 import { node } from '../api'
 import { Subscription, SubscribeOptions } from '../utils'
 
@@ -40,8 +40,6 @@ export class TxStatusSubscription extends Subscription<TxStatus> {
     this.fromGroup = fromGroup
     this.toGroup = toGroup
     this.confirmations = confirmations ?? 1
-
-    this.startPolling()
   }
 
   override async polling(): Promise<void> {
@@ -69,5 +67,7 @@ export function subscribeToTxStatus(
   toGroup?: number,
   confirmations?: number
 ): TxStatusSubscription {
-  return new TxStatusSubscription(options, txId, fromGroup, toGroup, confirmations)
+  const subscription = new TxStatusSubscription(options, txId, fromGroup, toGroup, confirmations)
+  subscription.subscribe()
+  return subscription
 }

package/src/transaction/utils.ts

@@ -0,0 +1,38 @@
+/*
+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 { node } from '../api'
+import { getCurrentNodeProvider } from '../global'
+
+function isConfirmed(txStatus: node.TxStatus): txStatus is node.Confirmed {
+  return txStatus.type === 'Confirmed'
+}
+
+export async function waitForTxConfirmation(
+  txId: string,
+  confirmations: number,
+  requestInterval: number
+): Promise<node.Confirmed> {
+  const provider = getCurrentNodeProvider()
+  const status = await provider.transactions.getTransactionsStatus({ txId: txId })
+  if (isConfirmed(status) && status.chainConfirmations >= confirmations) {
+    return status
+  }
+  await new Promise((r) => setTimeout(r, requestInterval))
+  return waitForTxConfirmation(txId, confirmations, requestInterval)
+}

package/src/utils/address.ts

@@ -24,6 +24,9 @@ import bs58 from './bs58'
 import djb2 from './djb2'
 import { binToHex, hexToBinUnsafe } from './utils'
 import { KeyType } from '../signer'
+import { MultiSig, lockupScriptCodec } from '../codec/lockup-script-codec'
+import { Buffer } from 'buffer/'
+import { compactSignedIntCodec } from '../codec'
 
 const ec = new EC('secp256k1')
 
@@ -49,8 +52,18 @@ function decodeAndValidateAddress(address: string): Uint8Array {
   if (decoded.length === 0) throw new Error('Address is empty')
   const addressType = decoded[0]
   if (addressType === AddressType.P2MPKH) {
-    // [1, n, ...hashes, m]
-    if ((decoded.length - 3) % 32 === 0) return decoded
+    let multisig: MultiSig
+    try {
+      multisig = lockupScriptCodec.decode(Buffer.from(decoded)).script as MultiSig
+    } catch (_) {
+      throw new Error(`Invalid multisig address: ${address}`)
+    }
+    const n = multisig.publicKeyHashes.value.length
+    const m = compactSignedIntCodec.toI32(multisig.m)
+    if (n < m) {
+      throw new Error(`Invalid multisig address, n: ${n}, m: ${m}`)
+    }
+    return decoded
   } else if (addressType === AddressType.P2PKH || addressType === AddressType.P2SH || addressType === AddressType.P2C) {
     // [type, ...hash]
     if (decoded.length === 33) return decoded

package/src/utils/exchange.ts

@@ -16,9 +16,20 @@ 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 { AddressType, addressFromPublicKey, addressFromScript, binToHex, bs58, hexToBinUnsafe } from '..'
+import {
+  AddressType,
+  addressFromPublicKey,
+  addressFromScript,
+  binToHex,
+  bs58,
+  hexToBinUnsafe,
+  isHexString
+} from '../utils'
 import { Transaction } from '../api/api-alephium'
 import { Address } from '../signer'
+import { P2SH, unlockScriptCodec } from '../codec/unlock-script-codec'
+import { Buffer } from 'buffer/'
+import { scriptCodec } from '../codec/script-codec'
 
 export function validateExchangeAddress(address: string) {
   let decoded: Uint8Array
@@ -80,24 +91,35 @@ enum UnlockScriptType {
 }
 
 export function getAddressFromUnlockScript(unlockScript: string): Address {
+  if (!isHexString(unlockScript)) {
+    throw new Error(`Invalid unlock script ${unlockScript}, expected a hex string`)
+  }
   const decoded = hexToBinUnsafe(unlockScript)
   if (decoded.length === 0) throw new Error('UnlockScript is empty')
   const unlockScriptType = decoded[0]
   const unlockScriptBody = decoded.slice(1)
 
   if (unlockScriptType === UnlockScriptType.P2PKH) {
+    if (unlockScriptBody.length !== 33) {
+      throw new Error(`Invalid p2pkh unlock script: ${unlockScript}`)
+    }
     return addressFromPublicKey(binToHex(unlockScriptBody))
-  } else if (unlockScriptType === UnlockScriptType.P2MPKH) {
+  }
+
+  if (unlockScriptType === UnlockScriptType.P2MPKH) {
     throw new Error('Naive multi-sig address is not supported for exchanges as it will be replaced by P2SH')
-  } else if (unlockScriptType === UnlockScriptType.P2SH) {
-    // FIXEME: for now we assume that the params is empty, so we need to
-    // remove the last byte from the `unlockScriptBody`, we can decode
-    // the unlock script once the codec PR is merged
-    const script = unlockScriptBody.slice(0, -1)
-    return addressFromScript(script)
-  } else {
-    throw new Error('Invalid unlock script type')
   }
+
+  if (unlockScriptType === UnlockScriptType.P2SH) {
+    let p2sh: P2SH
+    try {
+      p2sh = unlockScriptCodec.decode(Buffer.from(decoded)).script as P2SH
+    } catch (_) {
+      throw new Error(`Invalid p2sh unlock script: ${unlockScript}`)
+    }
+    return addressFromScript(scriptCodec.encode(p2sh.script))
+  }
+  throw new Error('Invalid unlock script type')
 }
 
 function checkALPHOutput(tx: Transaction): boolean {

package/src/utils/number.ts

@@ -21,7 +21,7 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 // 2. https://github.com/ethers-io/ethers.js/blob/724881f34d428406488a1c9f9dbebe54b6edecda/src.ts/utils/fixednumber.ts
 
 import BigNumber from 'bignumber.js'
-import { Number256 } from '..'
+import { Number256 } from '../api/types'
 
 export const isNumeric = (numToCheck: any): boolean => !isNaN(parseFloat(numToCheck)) && isFinite(numToCheck)
 

package/src/utils/sign.ts

@@ -17,7 +17,7 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
 import { ec as EC } from 'elliptic'
-import { binToHex, encodeSignature, hexToBinUnsafe, signatureDecode } from '..'
+import { binToHex, encodeSignature, hexToBinUnsafe, signatureDecode } from '../utils'
 import { KeyType } from '../signer'
 import * as necc from '@noble/secp256k1'
 import { createHash, createHmac } from 'crypto'

package/src/utils/subscription.ts

@@ -18,8 +18,8 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 
 import EventEmitter from 'eventemitter3'
 
-type MessageCallback<Message> = (message: Message) => Promise<void>
-type ErrorCallback<Message> = (error: any, subscription: Subscription<Message>) => Promise<void>
+type MessageCallback<Message> = (message: Message) => Promise<void> | void
+type ErrorCallback<Message> = (error: any, subscription: Subscription<Message>) => Promise<void> | void
 
 export interface SubscribeOptions<Message> {
   pollingInterval: number
@@ -45,7 +45,7 @@ export abstract class Subscription<Message> {
     this.eventEmitter = new EventEmitter()
   }
 
-  startPolling(): void {
+  subscribe(): void {
     this.eventEmitter.on('tick', async () => {
       await this.polling()
 
@@ -68,5 +68,5 @@ export abstract class Subscription<Message> {
     return this.cancelled
   }
 
-  abstract polling(): Promise<void>
+  protected abstract polling(): Promise<void>
 }

package/std/fungible_token_interface.ral

@@ -1,4 +1,5 @@
 @std(id = #0001)
+@using(methodSelector = false)
 Interface IFungibleToken {
   pub fn getSymbol() -> ByteVec
 

package/std/nft_collection_interface.ral

@@ -1,6 +1,7 @@
 import "std/nft_interface"
 
 @std(id = #0002)
+@using(methodSelector = false)
 Interface INFTCollection {
    // Collection Uri points to a json file containing metadata for the NFT collection.
    //

package/std/nft_collection_with_royalty_interface.ral

@@ -1,6 +1,7 @@
 import "std/nft_collection_interface"
 
 @std(id = #000201)
+@using(methodSelector = false)
 Interface INFTCollectionWithRoyalty extends INFTCollection {
     pub fn royaltyAmount(tokenId: ByteVec, salePrice: U256) -> (U256)
 

package/std/nft_interface.ral

@@ -1,4 +1,5 @@
 @std(id = #0003)
+@using(methodSelector = false)
 Interface INFT {
    // Token Uri points to a json file containing metadata for the NFT.
    //

package/webpack.config.js

@@ -41,7 +41,6 @@ module.exports = {
       fs: false,
       stream: require.resolve('stream-browserify'),
       crypto: require.resolve('crypto-browserify'),
-      path: require.resolve('path-browserify'),
       buffer: require.resolve('buffer/')
     }
   },

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

@@ -1,15 +0,0 @@
-declare class CompilationError {
-    lineStart: number;
-    column: number;
-    errorType: string;
-    line: number;
-    codeLine: string;
-    errorIndicator: string;
-    message: string;
-    additionalLine1?: string | undefined;
-    additionalLine2?: string | undefined;
-    constructor(lineStart: number, column: number, errorType: string, line: number, codeLine: string, errorIndicator: string, message: string, additionalLine1?: string | undefined, additionalLine2?: string | undefined);
-    reformat(line: number, file: string): string;
-}
-export declare function parseError(error: string): CompilationError | undefined;
-export {};

package/dist/src/utils/error.js

@@ -1,66 +0,0 @@
-"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.parseError = void 0;
-class CompilationError {
-    constructor(lineStart, column, errorType, line, codeLine, errorIndicator, message, additionalLine1, additionalLine2) {
-        this.lineStart = lineStart;
-        this.column = column;
-        this.errorType = errorType;
-        this.line = line;
-        this.codeLine = codeLine;
-        this.errorIndicator = errorIndicator;
-        this.message = message;
-        this.additionalLine1 = additionalLine1;
-        this.additionalLine2 = additionalLine2;
-    }
-    reformat(line, file) {
-        const spaces = `${line}`.replace(/\d/g, ' ');
-        const newError = `${file} (${line}:${this.column}): ${this.errorType}
-${line} |${this.codeLine}
-${spaces} |${this.errorIndicator}
-${spaces} |${this.message}`;
-        if (this.additionalLine1 && this.additionalLine2) {
-            return `${newError}\n${spaces} |${this.additionalLine1}\n${spaces} |${this.additionalLine2}`;
-        }
-        else {
-            return newError;
-        }
-    }
-}
-const errorRegex = /error \((\d+):(\d+)\):\s*(.*)\n\s*(\d+)\s*\|(.*)\n.*\|(.*)\n\s*\|(.*)(?:\n\s*\|(.*)\n\s*\|(.*))?/;
-function parseError(error) {
-    const match = error.match(errorRegex);
-    if (match) {
-        const lineStart = parseInt(match[1]);
-        const column = parseInt(match[2]);
-        const errorType = match[3];
-        const line = parseInt(match[4]);
-        const codeLine = match[5];
-        const errorIndicator = match[6];
-        const message = match[7];
-        const additionalLine1 = match[8];
-        const additionalLine2 = match[9];
-        return new CompilationError(lineStart, column, errorType, line, codeLine, errorIndicator, message, additionalLine1, additionalLine2);
-    }
-    else {
-        undefined;
-    }
-}
-exports.parseError = parseError;

package/src/utils/error.ts

@@ -1,77 +0,0 @@
-/*
-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/>.
-*/
-
-class CompilationError {
-  constructor(
-    public lineStart: number,
-    public column: number,
-    public errorType: string,
-    public line: number,
-    public codeLine: string,
-    public errorIndicator: string,
-    public message: string,
-    public additionalLine1?: string,
-    public additionalLine2?: string
-  ) {}
-
-  reformat(line: number, file: string): string {
-    const spaces = `${line}`.replace(/\d/g, ' ')
-    const newError = `${file} (${line}:${this.column}): ${this.errorType}
-${line} |${this.codeLine}
-${spaces} |${this.errorIndicator}
-${spaces} |${this.message}`
-
-    if (this.additionalLine1 && this.additionalLine2) {
-      return `${newError}\n${spaces} |${this.additionalLine1}\n${spaces} |${this.additionalLine2}`
-    } else {
-      return newError
-    }
-  }
-}
-
-const errorRegex = /error \((\d+):(\d+)\):\s*(.*)\n\s*(\d+)\s*\|(.*)\n.*\|(.*)\n\s*\|(.*)(?:\n\s*\|(.*)\n\s*\|(.*))?/
-
-export function parseError(error: string): CompilationError | undefined {
-  const match = error.match(errorRegex)
-
-  if (match) {
-    const lineStart = parseInt(match[1])
-    const column = parseInt(match[2])
-    const errorType = match[3]
-    const line = parseInt(match[4])
-    const codeLine = match[5]
-    const errorIndicator = match[6]
-    const message = match[7]
-    const additionalLine1 = match[8]
-    const additionalLine2 = match[9]
-
-    return new CompilationError(
-      lineStart,
-      column,
-      errorType,
-      line,
-      codeLine,
-      errorIndicator,
-      message,
-      additionalLine1,
-      additionalLine2
-    )
-  } else {
-    undefined
-  }
-}