@alephium/web3 0.2.0-rc.1 → 0.2.0-rc.10

package/src/contract/events.ts

@@ -31,7 +31,7 @@ export class EventSubscription extends Subscription<ContractEvent> {
     this.startPolling()
   }
 
-  override startPolling() {
+  override startPolling(): void {
     this.eventEmitter.on('tick', async () => {
       await this.polling()
     })
@@ -42,7 +42,7 @@ export class EventSubscription extends Subscription<ContractEvent> {
     return this.fromCount
   }
 
-  override async polling() {
+  override async polling(): Promise<void> {
     try {
       const events = await this.provider.events.getEventsContractContractaddress(this.contractAddress, {
         start: this.fromCount

package/src/{transaction/sign-verify.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

@@ -23,3 +23,6 @@ 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')
 
@@ -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/transaction/index.ts

@@ -16,5 +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/>.
 */
 
-export * from './sign-verify'
 export * from './status'

package/src/transaction/status.ts

@@ -33,7 +33,7 @@ export class TxStatusSubscription extends Subscription<TxStatus> {
     this.startPolling()
   }
 
-  override async polling() {
+  override async polling(): Promise<void> {
     try {
       const txStatus = await this.provider.transactions.getTransactionsStatus({
         txId: this.txId,

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 './utils'
 export * from './subscription'

package/src/utils/subscription.ts

@@ -17,13 +17,13 @@ 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> {
-  provider: NodeProvider
   pollingInterval: number
   messageCallback: MessageCallback<Message>
   errorCallback: ErrorCallback<Message>
@@ -40,7 +40,7 @@ export abstract class Subscription<Message> {
   protected cancelled: boolean
 
   constructor(options: SubscribeOptions<Message>) {
-    this.provider = options.provider
+    this.provider = getCurrentNodeProvider()
     this.pollingInterval = options.pollingInterval
     this.messageCallback = options.messageCallback
     this.errorCallback = options.errorCallback
@@ -49,7 +49,7 @@ export abstract class Subscription<Message> {
     this.eventEmitter = new EventEmitter()
   }
 
-  startPolling() {
+  startPolling(): void {
     this.eventEmitter.on('tick', async () => {
       await this.polling()
 

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)
 }
 
@@ -203,11 +203,11 @@ export function stringToHex(str: string): string {
   return hex
 }
 
-export function hexToString(str: any): string {
-  return Buffer.from(str.toString(), 'hex').toString()
+export function hexToString(str: string): string {
+  return Buffer.from(str, 'hex').toString()
 }
 
-export function timeout(ms: number) {
+export function timeout(ms: number): Promise<void> {
   return new Promise((resolve) => setTimeout(resolve, ms))
 }
 

package/templates/base/package.json

@@ -3,7 +3,7 @@
   "version": "0.1.0",
   "license": "GPL",
   "config": {
-    "alephium_version": "1.5.0-rc0"
+    "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.2.0-rc.1"
+    "@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.5.0-rc0"
+    "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.2.0-rc.1",
+    "@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"
-      }
-    }
-  ]
-}

package/LICENSE

@@ -1,165 +0,0 @@
-                   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.

package/contracts/add/add.ral

@@ -1,16 +0,0 @@
-import "../sub/sub.ral"
-
-Contract Add(subContractId: ByteVec, mut result : U256) {
-    event Add(x: U256, y: U256)
-
-    pub fn add(array: [U256; 2]) -> ([U256; 2]) {
-        emit Add(array[0], array[1])
-        let sub = Sub(subContractId)
-        result = result + array[0] + array[1]
-        return [result, sub.sub(array)]
-    }
-
-    fn addPrivate(array: [U256; 2]) -> ([U256; 2]) {
-        return add(array)
-    }
-}

package/contracts/main.ral

@@ -1,6 +0,0 @@
-import "./add/add.ral"
-
-TxScript Main(addContractId: ByteVec) {
-    let add = Add(addContractId)
-    add.add([2, 1])
-}

package/contracts/sub/sub.ral

@@ -1,9 +0,0 @@
-Contract Sub(mut result : U256) {
-    event Sub(x: U256, y: U256)
-
-    pub fn sub(array: [U256; 2]) -> U256 {
-        emit Sub(array[0], array[1])
-        result = result + array[0] - array[1]
-        return result
-    }
-}

package/dist/src/signer/node-wallet.d.ts

@@ -1,13 +0,0 @@
-import { NodeProvider } from '../api';
-import { Account, SignerWithNodeProvider } from '../signer';
-export declare class NodeWallet extends SignerWithNodeProvider {
-    walletName: string;
-    accounts: Account[] | undefined;
-    constructor(provider: NodeProvider, walletName: string, alwaysSubmitTx?: boolean);
-    getAccounts(): Promise<Account[]>;
-    private getAllAccounts;
-    static FromCliqueClient(provider: NodeProvider, walletName: string, alwaysSubmitTx?: boolean): Promise<NodeWallet>;
-    signRaw(signerAddress: string, hexString: string): Promise<string>;
-    unlock(password: string): Promise<void>;
-    lock(): Promise<void>;
-}

package/dist/src/signer/node-wallet.js

@@ -1,60 +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.NodeWallet = void 0;
-const signer_1 = require("../signer");
-class NodeWallet extends signer_1.SignerWithNodeProvider {
-    constructor(provider, walletName, alwaysSubmitTx = true) {
-        super(provider, alwaysSubmitTx);
-        this.walletName = walletName;
-    }
-    async getAccounts() {
-        if (typeof this.accounts === 'undefined') {
-            this.accounts = await this.getAllAccounts();
-        }
-        return this.accounts;
-    }
-    async getAllAccounts() {
-        const walletAddresses = await this.provider.wallets.getWalletsWalletNameAddresses(this.walletName);
-        const accounts = walletAddresses.addresses.map((acc) => ({
-            publicKey: acc.publicKey,
-            address: acc.address,
-            group: acc.group
-        }));
-        return accounts;
-    }
-    static async FromCliqueClient(provider, walletName, alwaysSubmitTx = true) {
-        return new NodeWallet(provider, walletName, alwaysSubmitTx);
-    }
-    async signRaw(signerAddress, hexString) {
-        const currentActiveAddressResponse = await this.provider.wallets.getWalletsWalletNameAddresses(this.walletName);
-        const { activeAddress } = currentActiveAddressResponse;
-        await this.provider.wallets.postWalletsWalletNameChangeActiveAddress(this.walletName, { address: signerAddress });
-        const { signature } = await this.provider.wallets.postWalletsWalletNameSign(this.walletName, { data: hexString });
-        await this.provider.wallets.postWalletsWalletNameChangeActiveAddress(this.walletName, { address: activeAddress }); // set the address that's active back to previous state
-        return signature;
-    }
-    async unlock(password) {
-        return await this.provider.wallets.postWalletsWalletNameUnlock(this.walletName, { password });
-    }
-    async lock() {
-        return await this.provider.wallets.postWalletsWalletNameLock(this.walletName);
-    }
-}
-exports.NodeWallet = NodeWallet;

package/dist/src/test/index.d.ts

@@ -1,7 +0,0 @@
-import { NodeProvider } from '../api';
-import { NodeWallet } from '../signer';
-export declare const testWalletName = "alephium-web3-test-only-wallet";
-export declare const testAddress = "1DrDyTr9RpRsQnDnXo2YRiPzPW4ooHX5LLoqXrqfMrpQH";
-export declare const testPassword = "alph";
-export declare function testWallet(provider: NodeProvider): Promise<NodeWallet>;
-export * from './privatekey-wallet';