@alephium/web3 0.2.0-rc.3 → 0.2.0-rc.31

package/src/contract/events.ts

@@ -16,14 +16,15 @@ 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 { ContractEvent } from '../api/api-alephium'
+import { web3 } from '..'
+import { node } from '../api'
 import { Subscription, SubscribeOptions } from '../utils'
 
-export class EventSubscription extends Subscription<ContractEvent> {
+export class EventSubscription extends Subscription<node.ContractEvent> {
   readonly contractAddress: string
   private fromCount: number
 
-  constructor(options: SubscribeOptions<ContractEvent>, contractAddress: string, fromCount?: number) {
+  constructor(options: SubscribeOptions<node.ContractEvent>, contractAddress: string, fromCount?: number) {
     super(options)
     this.contractAddress = contractAddress
     this.fromCount = typeof fromCount === 'undefined' ? 0 : fromCount
@@ -44,7 +45,7 @@ export class EventSubscription extends Subscription<ContractEvent> {
 
   override async polling(): Promise<void> {
     try {
-      const events = await this.provider.events.getEventsContractContractaddress(this.contractAddress, {
+      const events = await web3.getCurrentNodeProvider().events.getEventsContractContractaddress(this.contractAddress, {
         start: this.fromCount
       })
       if (this.cancelled) {
@@ -67,7 +68,7 @@ export class EventSubscription extends Subscription<ContractEvent> {
 }
 
 export function subscribeToEvents(
-  options: SubscribeOptions<ContractEvent>,
+  options: SubscribeOptions<node.ContractEvent>,
   contractAddress: string,
   fromCount?: number
 ): EventSubscription {

package/src/contract/ralph.ts

@@ -17,9 +17,9 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
 import { Buffer } from 'buffer/'
+import { Val } from '../api'
 import { bs58, isHexString } from '../utils'
-import { node } from '../api'
-import { Fields, Val } from './contract'
+import { Fields, FieldsSig } from './contract'
 
 const bigIntZero = BigInt(0)
 
@@ -236,7 +236,7 @@ export function encodeScriptField(tpe: string, value: Val): Uint8Array {
 
 const scriptFieldRegex = /\{([0-9]*)\}/g
 
-export function buildScriptByteCode(bytecodeTemplate: string, fields: Fields, fieldsSig: node.FieldsSig): string {
+export function buildScriptByteCode(bytecodeTemplate: string, fields: Fields, fieldsSig: FieldsSig): string {
   return bytecodeTemplate.replace(scriptFieldRegex, (_, fieldIndex: string) => {
     const fieldName = fieldsSig.names[`${fieldIndex}`]
     const fieldType = fieldsSig.types[`${fieldIndex}`]
@@ -249,7 +249,7 @@ export function buildScriptByteCode(bytecodeTemplate: string, fields: Fields, fi
   })
 }
 
-export function buildContractByteCode(bytecode: string, fields: Fields, fieldsSig: node.FieldsSig): string {
+export function buildContractByteCode(bytecode: string, fields: Fields, fieldsSig: FieldsSig): string {
   const fieldsEncoded = fieldsSig.names.flatMap((fieldName, fieldIndex) => {
     const fieldType = fieldsSig.types[`${fieldIndex}`]
     if (fieldName in fields) {
@@ -343,6 +343,31 @@ function invalidVal(tpe: string, value: Val): Error {
   return Error(`Invalid API value ${value} for type ${tpe}`)
 }
 
+export function buildDebugBytecode(bytecode: string, bytecodePatch: string): string {
+  if (bytecodePatch === '') {
+    return bytecode
+  }
+
+  const pattern = /[=+-][0-9a-f]*/g
+  let result = ''
+  let index = 0
+  for (const parts of bytecodePatch.matchAll(pattern)) {
+    const part = parts[0]
+    const diffType = part[0]
+    if (diffType === '=') {
+      const length = parseInt(part.substring(1))
+      result = result + bytecode.slice(index, index + length)
+      index = index + length
+    } else if (diffType === '+') {
+      result = result + part.substring(1)
+    } else {
+      const length = parseInt(part.substring(1))
+      index = index + length
+    }
+  }
+  return result
+}
+
 // export function buildContractByteCode(
 //   compiled: node.TemplateContractByteCode,
 //   templateVariables: TemplateVariables

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

@@ -16,6 +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/>.
 */
 
+BigInt.prototype['toJSON'] = function () {
+  return this.toString()
+}
+
 export * from './api'
 export * from './contract'
 export * from './signer'
@@ -23,3 +27,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

@@ -17,12 +17,22 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
 import { ec as EC } from 'elliptic'
-import { NodeProvider } from '../api'
+import {
+  fromApiNumber256,
+  fromApiTokens,
+  NodeProvider,
+  Number256,
+  toApiNumber256,
+  toApiNumber256Optional,
+  toApiTokens,
+  Token
+} from '../api'
 import { node } from '../api'
 import * as utils from '../utils'
 import { Eq, assertType } from '../utils'
 import blake from 'blakejs'
-import { Token } from '../api/api-alephium'
+
+export type OutputRef = node.OutputRef
 
 const ec = new EC('secp256k1')
 
@@ -40,22 +50,20 @@ export interface Account {
   publicKey: string
 }
 
-export type SubmitTx = { submitTx?: boolean }
 export type SignerAddress = { signerAddress: string }
-type TxBuildParams<T> = Omit<T, 'fromPublicKey' | 'targetBlockHash'> & SignerAddress & SubmitTx
+type TxBuildParams<T> = Omit<T, 'fromPublicKey' | 'targetBlockHash'> & SignerAddress
 
 export type GetAccountsParams = undefined
 export type GetAccountsResult = Account[]
 
 export interface SignTransferTxParams {
   signerAddress: string
-  destinations: node.Destination[]
-  utxos?: node.OutputRef[]
+  destinations: Destination[]
+  utxos?: OutputRef[]
   gasAmount?: number
-  gasPrice?: string
-  submitTx?: boolean
+  gasPrice?: Number256
 }
-assertType<Eq<SignTransferTxParams, TxBuildParams<node.BuildTransaction>>>()
+assertType<Eq<keyof SignTransferTxParams, keyof TxBuildParams<node.BuildTransaction>>>()
 export interface SignTransferTxResult {
   fromGroup: number
   toGroup: number
@@ -68,14 +76,13 @@ assertType<Eq<SignTransferTxResult, SignResult>>()
 export interface SignDeployContractTxParams {
   signerAddress: string
   bytecode: string
-  initialAttoAlphAmount?: string
+  initialAttoAlphAmount?: Number256
   initialTokenAmounts?: Token[]
-  issueTokenAmount?: string
+  issueTokenAmount?: Number256
   gasAmount?: number
-  gasPrice?: string
-  submitTx?: boolean
+  gasPrice?: Number256
 }
-assertType<Eq<SignDeployContractTxParams, TxBuildParams<node.BuildDeployContractTx>>>()
+assertType<Eq<keyof SignDeployContractTxParams, keyof TxBuildParams<node.BuildDeployContractTx>>>()
 export interface SignDeployContractTxResult {
   fromGroup: number
   toGroup: number
@@ -91,12 +98,11 @@ export interface SignExecuteScriptTxParams {
   signerAddress: string
   bytecode: string
   attoAlphAmount?: string
-  tokens?: node.Token[]
+  tokens?: Token[]
   gasAmount?: number
   gasPrice?: string
-  submitTx?: boolean
 }
-assertType<Eq<SignExecuteScriptTxParams, TxBuildParams<node.BuildExecuteScriptTx>>>()
+assertType<Eq<keyof SignExecuteScriptTxParams, keyof TxBuildParams<node.BuildExecuteScriptTx>>>()
 export interface SignExecuteScriptTxResult {
   fromGroup: number
   toGroup: number
@@ -109,9 +115,8 @@ assertType<Eq<SignExecuteScriptTxResult, SignResult>>()
 export interface SignUnsignedTxParams {
   signerAddress: string
   unsignedTx: string
-  submitTx?: boolean
 }
-assertType<Eq<SignUnsignedTxParams, { unsignedTx: string } & SubmitTx & SignerAddress>>()
+assertType<Eq<SignUnsignedTxParams, { unsignedTx: string } & SignerAddress>>()
 export interface SignUnsignedTxResult {
   fromGroup: number
   toGroup: number
@@ -141,8 +146,8 @@ export interface SignMessageResult {
 }
 assertType<Eq<SignMessageResult, Pick<SignResult, 'signature'>>>()
 
-export interface SignerProvider {
-  getAccounts(): Promise<Account[]>
+export interface SignerProviderWithoutNodeProvider {
+  getSelectedAccount(): Promise<Account>
   signTransferTx(params: SignTransferTxParams): Promise<SignTransferTxResult>
   signDeployContractTx(params: SignDeployContractTxParams): Promise<SignDeployContractTxResult>
   signExecuteScriptTx(params: SignExecuteScriptTxParams): Promise<SignExecuteScriptTxResult>
@@ -151,117 +156,112 @@ export interface SignerProvider {
   signMessage(params: SignMessageParams): Promise<SignMessageResult>
 }
 
-export abstract class SignerWithNodeProvider implements SignerProvider {
-  readonly provider: NodeProvider
-  alwaysSubmitTx: boolean
+export abstract class SignerProvider implements SignerProviderWithoutNodeProvider {
+  abstract get nodeProvider(): NodeProvider
+  abstract getSelectedAccount(): Promise<Account>
 
-  abstract getAccounts(): Promise<Account[]>
-
-  async getAccount(signerAddress: string): Promise<Account> {
-    const accounts = await this.getAccounts()
-    const account = accounts.find((a) => a.address === signerAddress)
-    if (typeof account === 'undefined') {
-      throw new Error('Unmatched signerAddress')
-    } else {
-      return account
-    }
+  async submitTransaction(unsignedTx: string, signature: string): Promise<SubmissionResult> {
+    const params: node.SubmitTransaction = { unsignedTx: unsignedTx, signature: signature }
+    return this.nodeProvider.transactions.postTransactionsSubmit(params)
   }
 
-  constructor(provider: NodeProvider, alwaysSubmitTx: boolean) {
-    this.provider = provider
-    this.alwaysSubmitTx = alwaysSubmitTx
+  async signAndSubmitTransferTx(params: SignTransferTxParams): Promise<SubmissionResult> {
+    const signResult = await this.signTransferTx(params)
+    return this.submitTransaction(signResult.unsignedTx, signResult.signature)
   }
-
-  private async defaultSignerAddress(): Promise<string> {
-    return (await this.getAccounts())[0].address
+  async signAndSubmitDeployContractTx(params: SignDeployContractTxParams): Promise<SubmissionResult> {
+    const signResult = await this.signDeployContractTx(params)
+    return this.submitTransaction(signResult.unsignedTx, signResult.signature)
   }
-
-  async submitTransaction(unsignedTx: string, txHash: string, signerAddress?: string): Promise<SubmissionResult> {
-    const address = typeof signerAddress !== 'undefined' ? signerAddress : await this.defaultSignerAddress()
-    const signature = await this.signRaw(address, txHash)
-    const params: node.SubmitTransaction = { unsignedTx: unsignedTx, signature: signature }
-    return this.provider.transactions.postTransactionsSubmit(params)
+  async signAndSubmitExecuteScriptTx(params: SignExecuteScriptTxParams): Promise<SubmissionResult> {
+    const signResult = await this.signExecuteScriptTx(params)
+    return this.submitTransaction(signResult.unsignedTx, signResult.signature)
   }
-
-  private shouldSubmitTx(params: SubmitTx): boolean {
-    return this.alwaysSubmitTx || (params.submitTx ? params.submitTx : true)
+  async signAndSubmitUnsignedTx(params: SignUnsignedTxParams): Promise<SubmissionResult> {
+    const signResult = await this.signUnsignedTx(params)
+    return this.submitTransaction(signResult.unsignedTx, signResult.signature)
   }
 
   private async usePublicKey<T extends SignerAddress>(
     params: T
   ): Promise<Omit<T, 'signerAddress'> & { fromPublicKey: string }> {
     const { signerAddress, ...restParams } = params
-    const allAccounts = await this.getAccounts()
-    const signerAccount = allAccounts.find((account) => account.address === signerAddress)
-    if (typeof signerAccount === 'undefined') {
-      throw new Error('Unknown signer address')
+    const selectedAccount = await this.getSelectedAccount()
+    if (signerAddress !== selectedAccount.address) {
+      throw new Error('The signer address is not the selected address')
     } else {
-      return { fromPublicKey: signerAccount.publicKey, ...restParams }
+      return { fromPublicKey: selectedAccount.publicKey, ...restParams }
     }
   }
 
   async signTransferTx(params: SignTransferTxParams): Promise<SignTransferTxResult> {
     const response = await this.buildTransferTx(params)
-    return this.handleSign({ signerAddress: params.signerAddress, ...response }, this.shouldSubmitTx(params))
+    return this.handleSign({ signerAddress: params.signerAddress, ...response })
   }
 
   async buildTransferTx(params: SignTransferTxParams): Promise<node.BuildTransactionResult> {
-    return this.provider.transactions.postTransactionsBuild(await this.usePublicKey(params))
+    const data: node.BuildTransaction = {
+      ...(await this.usePublicKey(params)),
+      destinations: toApiDestinations(params.destinations),
+      gasPrice: toApiNumber256Optional(params.gasPrice)
+    }
+    return this.nodeProvider.transactions.postTransactionsBuild(data)
   }
 
   async signDeployContractTx(params: SignDeployContractTxParams): Promise<SignDeployContractTxResult> {
     const response = await this.buildContractCreationTx(params)
-    const result = await this.handleSign(
-      { signerAddress: params.signerAddress, ...response },
-      this.shouldSubmitTx(params)
-    )
+    const result = await this.handleSign({ signerAddress: params.signerAddress, ...response })
     const contractId = utils.binToHex(utils.contractIdFromAddress(response.contractAddress))
     return { ...result, contractId: contractId, contractAddress: response.contractAddress }
   }
 
   async buildContractCreationTx(params: SignDeployContractTxParams): Promise<node.BuildDeployContractTxResult> {
-    return this.provider.contracts.postContractsUnsignedTxDeployContract(await this.usePublicKey(params))
+    const data: node.BuildDeployContractTx = {
+      ...(await this.usePublicKey(params)),
+      initialAttoAlphAmount: toApiNumber256Optional(params.initialAttoAlphAmount),
+      initialTokenAmounts: toApiTokens(params.initialTokenAmounts),
+      issueTokenAmount: toApiNumber256Optional(params.issueTokenAmount),
+      gasPrice: toApiNumber256Optional(params.gasPrice)
+    }
+    return this.nodeProvider.contracts.postContractsUnsignedTxDeployContract(data)
   }
 
   async signExecuteScriptTx(params: SignExecuteScriptTxParams): Promise<SignExecuteScriptTxResult> {
     const response = await this.buildScriptTx(params)
-    return this.handleSign({ signerAddress: params.signerAddress, ...response }, this.shouldSubmitTx(params))
+    return this.handleSign({ signerAddress: params.signerAddress, ...response })
   }
 
   async buildScriptTx(params: SignExecuteScriptTxParams): Promise<node.BuildExecuteScriptTxResult> {
-    return this.provider.contracts.postContractsUnsignedTxExecuteScript(await this.usePublicKey(params))
+    const data: node.BuildExecuteScriptTx = {
+      ...(await this.usePublicKey(params)),
+      tokens: toApiTokens(params.tokens)
+    }
+    return this.nodeProvider.contracts.postContractsUnsignedTxExecuteScript(data)
   }
 
   // in general, wallet should show the decoded information to user for confirmation
   // please overwrite this function for real wallet
   async signUnsignedTx(params: SignUnsignedTxParams): Promise<SignUnsignedTxResult> {
     const data = { unsignedTx: params.unsignedTx }
-    const decoded = await this.provider.transactions.postTransactionsDecodeUnsignedTx(data)
-    return this.handleSign(
-      {
-        fromGroup: decoded.fromGroup,
-        toGroup: decoded.toGroup,
-        signerAddress: params.signerAddress,
-        unsignedTx: params.unsignedTx,
-        txId: decoded.unsignedTx.txId
-      },
-      params.submitTx ? params.submitTx : true // we don't consider `alwaysSubmitTx` as the tx might needs multiple signatures
-    )
+    const decoded = await this.nodeProvider.transactions.postTransactionsDecodeUnsignedTx(data)
+    return this.handleSign({
+      fromGroup: decoded.fromGroup,
+      toGroup: decoded.toGroup,
+      signerAddress: params.signerAddress,
+      unsignedTx: params.unsignedTx,
+      txId: decoded.unsignedTx.txId
+    })
   }
 
-  protected async handleSign(
-    response: { fromGroup: number; toGroup: number; signerAddress: string; unsignedTx: string; txId: string },
-    submitTx: boolean
-  ): Promise<SignResult> {
+  protected async handleSign(response: {
+    fromGroup: number
+    toGroup: number
+    signerAddress: string
+    unsignedTx: string
+    txId: string
+  }): Promise<SignResult> {
     // sign the tx
     const signature = await this.signRaw(response.signerAddress, response.txId)
-    // submit the tx if required
-    if (submitTx) {
-      await this.provider.transactions.postTransactionsSubmit({
-        unsignedTx: response.unsignedTx,
-        signature: signature
-      })
-    }
     // return the signature back to the provider
     return {
       fromGroup: response.fromGroup,
@@ -287,6 +287,22 @@ export abstract class SignerWithNodeProvider implements SignerProvider {
   abstract signRaw(signerAddress: string, hexString: string): Promise<string>
 }
 
+export abstract class SignerProviderWithMultipleAccounts extends SignerProvider {
+  abstract getAccounts(): Promise<Account[]>
+
+  async getAccount(signerAddress: string): Promise<Account> {
+    const accounts = await this.getAccounts()
+    const account = accounts.find((a) => a.address === signerAddress)
+    if (typeof account === 'undefined') {
+      throw new Error('Unmatched signerAddress')
+    } else {
+      return account
+    }
+  }
+
+  abstract setSelectedAccount(address: string): Promise<void>
+}
+
 export interface SubmissionResult {
   txId: string
   fromGroup: number
@@ -311,3 +327,24 @@ export function verifySignedMessage(message: string, publicKey: string, signatur
   const messageHash = blake.blake2b(extendedMessage, undefined, 32)
   return verifyHexString(utils.binToHex(messageHash), publicKey, signature)
 }
+
+export interface Destination {
+  address: string
+  attoAlphAmount: Number256
+  tokens?: Token[]
+  lockTime?: number
+  message?: string
+}
+assertType<Eq<keyof Destination, keyof node.Destination>>
+
+export function toApiDestination(data: Destination): node.Destination {
+  return { ...data, attoAlphAmount: toApiNumber256(data.attoAlphAmount), tokens: toApiTokens(data.tokens) }
+}
+
+export function toApiDestinations(data: Destination[]): node.Destination[] {
+  return data.map(toApiDestination)
+}
+
+export function fromApiDestination(data: node.Destination): Destination {
+  return { ...data, attoAlphAmount: fromApiNumber256(data.attoAlphAmount), tokens: fromApiTokens(data.tokens) }
+}

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

@@ -16,9 +16,12 @@ 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 { web3 } from '..'
+import { node } from '../api'
 import { Subscription, SubscribeOptions } from '../utils'
 
+export type TxStatus = node.TxStatus
+
 export class TxStatusSubscription extends Subscription<TxStatus> {
   readonly txId: string
   readonly fromGroup?: number
@@ -35,7 +38,7 @@ export class TxStatusSubscription extends Subscription<TxStatus> {
 
   override async polling(): Promise<void> {
     try {
-      const txStatus = await this.provider.transactions.getTransactionsStatus({
+      const txStatus = await web3.getCurrentNodeProvider().transactions.getTransactionsStatus({
         txId: this.txId,
         fromGroup: this.fromGroup,
         toGroup: this.toGroup

package/src/utils/bs58.ts

@@ -23,4 +23,15 @@ const ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
 
 export const bs58 = basex(ALPHABET)
 
+export function isBase58(s: string): boolean {
+  if (s === '' || s.trim() === '') {
+    return false
+  }
+  try {
+    return bs58.encode(bs58.decode(s)) === s
+  } catch (err) {
+    return false
+  }
+}
+
 export default bs58

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,20 +17,17 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
 import EventEmitter from 'eventemitter3'
-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>
 }
 
 export abstract class Subscription<Message> {
-  provider: NodeProvider
   pollingInterval: number
 
   protected messageCallback: MessageCallback<Message>
@@ -40,7 +37,6 @@ export abstract class Subscription<Message> {
   protected cancelled: boolean
 
   constructor(options: SubscribeOptions<Message>) {
-    this.provider = options.provider
     this.pollingInterval = options.pollingInterval
     this.messageCallback = options.messageCallback
     this.errorCallback = options.errorCallback