@alephium/web3 0.3.0-rc.4 → 0.3.0-rc.5

package/dist/src/signer/signer.d.ts

@@ -1,100 +1,10 @@
-import { ExplorerProvider, NodeProvider, Number256, Token } from '../api';
+import { ExplorerProvider, NodeProvider } from '../api';
 import { node } from '../api';
-export declare type OutputRef = node.OutputRef;
-export interface Account {
-    address: string;
-    group: number;
-    publicKey: string;
-}
-export declare type SignerAddress = {
-    signerAddress: string;
-};
-export interface SignTransferTxParams {
-    signerAddress: string;
-    destinations: Destination[];
-    utxos?: OutputRef[];
-    gasAmount?: number;
-    gasPrice?: Number256;
-}
-export interface SignTransferTxResult {
-    fromGroup: number;
-    toGroup: number;
-    unsignedTx: string;
-    txId: string;
-    signature: string;
-    gasAmount: number;
-    gasPrice: Number256;
-}
-export interface SignDeployContractTxParams {
-    signerAddress: string;
-    bytecode: string;
-    initialAttoAlphAmount?: Number256;
-    initialTokenAmounts?: Token[];
-    issueTokenAmount?: Number256;
-    gasAmount?: number;
-    gasPrice?: Number256;
-}
-export interface SignDeployContractTxResult {
-    fromGroup: number;
-    toGroup: number;
-    unsignedTx: string;
-    txId: string;
-    signature: string;
-    contractId: string;
-    contractAddress: string;
-    gasAmount: number;
-    gasPrice: Number256;
-}
-export interface SignExecuteScriptTxParams {
-    signerAddress: string;
-    bytecode: string;
-    attoAlphAmount?: Number256;
-    tokens?: Token[];
-    gasAmount?: number;
-    gasPrice?: Number256;
-}
-export interface SignExecuteScriptTxResult {
-    fromGroup: number;
-    toGroup: number;
-    unsignedTx: string;
-    txId: string;
-    signature: string;
-    gasAmount: number;
-    gasPrice: Number256;
-}
-export interface SignUnsignedTxParams {
-    signerAddress: string;
-    unsignedTx: string;
-}
-export interface SignUnsignedTxResult {
-    fromGroup: number;
-    toGroup: number;
-    unsignedTx: string;
-    txId: string;
-    signature: string;
-    gasAmount: number;
-    gasPrice: Number256;
-}
-export interface SignMessageParams {
-    signerAddress: string;
-    message: string;
-}
-export interface SignMessageResult {
-    signature: string;
-}
-export interface SubmitTransactionParams {
-    unsignedTx: string;
-    signature: string;
-}
-export interface SubmissionResult {
-    txId: string;
-    fromGroup: number;
-    toGroup: number;
-}
+import { Account, Address, EnableOptionsBase, Destination, SignDeployContractTxParams, SignDeployContractTxResult, SignExecuteScriptTxParams, SignExecuteScriptTxResult, SignMessageParams, SignMessageResult, SignTransferTxParams, SignTransferTxResult, SignUnsignedTxParams, SignUnsignedTxResult, SubmissionResult, SubmitTransactionParams } from './types';
 export interface SignerProvider {
     get nodeProvider(): NodeProvider | undefined;
     get explorerProvider(): ExplorerProvider | undefined;
-    getSelectedAccount(): Promise<Account>;
+    getSelectedAddress(): Promise<Address>;
     signAndSubmitTransferTx(params: SignTransferTxParams): Promise<SignTransferTxResult>;
     signAndSubmitDeployContractTx(params: SignDeployContractTxParams): Promise<SignDeployContractTxResult>;
     signAndSubmitExecuteScriptTx(params: SignExecuteScriptTxParams): Promise<SignExecuteScriptTxResult>;
@@ -102,16 +12,22 @@ export interface SignerProvider {
     signUnsignedTx(params: SignUnsignedTxParams): Promise<SignUnsignedTxResult>;
     signMessage(params: SignMessageParams): Promise<SignMessageResult>;
 }
+export interface InteractiveSignerProvider<EnableOptions extends EnableOptionsBase = EnableOptionsBase> extends SignerProvider {
+    enable(opt?: EnableOptions): Promise<void>;
+    disconnect(): Promise<void>;
+}
 export declare abstract class SignerProviderSimple implements SignerProvider {
     abstract get nodeProvider(): NodeProvider | undefined;
     abstract get explorerProvider(): ExplorerProvider | undefined;
     abstract getSelectedAccount(): Promise<Account>;
+    getSelectedAddress(): Promise<Address>;
     private getNodeProvider;
     submitTransaction(params: SubmitTransactionParams): Promise<SubmissionResult>;
     signAndSubmitTransferTx(params: SignTransferTxParams): Promise<SignTransferTxResult>;
     signAndSubmitDeployContractTx(params: SignDeployContractTxParams): Promise<SignDeployContractTxResult>;
     signAndSubmitExecuteScriptTx(params: SignExecuteScriptTxParams): Promise<SignExecuteScriptTxResult>;
     signAndSubmitUnsignedTx(params: SignUnsignedTxParams): Promise<SignUnsignedTxResult>;
+    protected abstract getPublicKey(address: string): Promise<string>;
     private usePublicKey;
     signTransferTx(params: SignTransferTxParams): Promise<SignTransferTxResult>;
     buildTransferTx(params: SignTransferTxParams): Promise<node.BuildTransactionResult>;
@@ -124,19 +40,21 @@ export declare abstract class SignerProviderSimple implements SignerProvider {
     abstract signRaw(signerAddress: string, hexString: string): Promise<string>;
 }
 export declare abstract class SignerProviderWithMultipleAccounts extends SignerProviderSimple {
+    abstract setSelectedAddress(address: string): Promise<void>;
     abstract getAccounts(): Promise<Account[]>;
     getAccount(signerAddress: string): Promise<Account>;
-    abstract setSelectedAccount(address: string): Promise<void>;
+    getPublicKey(signerAddress: string): Promise<string>;
+}
+export declare abstract class SignerProviderWithCachedAccounts<T extends Account> extends SignerProviderWithMultipleAccounts {
+    private _selectedAccount;
+    protected readonly _accounts: Map<string, T>;
+    getSelectedAccount(): Promise<T>;
+    setSelectedAddress(address: string): Promise<void>;
+    getAccounts(): Promise<T[]>;
+    getAccount(address: string): Promise<T>;
 }
 export declare function verifyHexString(hexString: string, publicKey: string, signature: string): boolean;
 export declare function verifySignedMessage(message: string, publicKey: string, signature: string): boolean;
-export interface Destination {
-    address: string;
-    attoAlphAmount: Number256;
-    tokens?: Token[];
-    lockTime?: number;
-    message?: string;
-}
 export declare function toApiDestination(data: Destination): node.Destination;
 export declare function toApiDestinations(data: Destination[]): node.Destination[];
 export declare function fromApiDestination(data: node.Destination): Destination;

package/dist/src/signer/signer.js

@@ -43,23 +43,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromApiDestination = exports.toApiDestinations = exports.toApiDestination = exports.verifySignedMessage = exports.verifyHexString = exports.SignerProviderWithMultipleAccounts = exports.SignerProviderSimple = void 0;
+exports.fromApiDestination = exports.toApiDestinations = exports.toApiDestination = exports.verifySignedMessage = exports.verifyHexString = exports.SignerProviderWithCachedAccounts = exports.SignerProviderWithMultipleAccounts = exports.SignerProviderSimple = void 0;
 const elliptic_1 = require("elliptic");
 const api_1 = require("../api");
 const utils = __importStar(require("../utils"));
-const utils_1 = require("../utils");
 const blakejs_1 = __importDefault(require("blakejs"));
 const ec = new elliptic_1.ec('secp256k1');
-(0, utils_1.assertType)();
-(0, utils_1.assertType)();
-(0, utils_1.assertType)();
-(0, utils_1.assertType)();
-(0, utils_1.assertType)();
-(0, utils_1.assertType)();
-(0, utils_1.assertType)();
-utils_1.assertType;
-(0, utils_1.assertType)();
 class SignerProviderSimple {
+    async getSelectedAddress() {
+        const account = await this.getSelectedAccount();
+        return account.address;
+    }
     getNodeProvider() {
         if (this.nodeProvider === undefined) {
             throw Error('The signer does not contain a node provider');
@@ -92,13 +86,8 @@ class SignerProviderSimple {
     }
     async usePublicKey(params) {
         const { signerAddress, ...restParams } = params;
-        const selectedAccount = await this.getSelectedAccount();
-        if (signerAddress !== selectedAccount.address) {
-            throw new Error('The signer address is not the selected address');
-        }
-        else {
-            return { fromPublicKey: selectedAccount.publicKey, ...restParams };
-        }
+        const publicKey = await this.getPublicKey(signerAddress);
+        return { fromPublicKey: publicKey, ...restParams };
     }
     async signTransferTx(params) {
         const response = await this.buildTransferTx(params);
@@ -178,8 +167,48 @@ class SignerProviderWithMultipleAccounts extends SignerProviderSimple {
             return account;
         }
     }
+    async getPublicKey(signerAddress) {
+        const account = await this.getAccount(signerAddress);
+        return account.publicKey;
+    }
 }
 exports.SignerProviderWithMultipleAccounts = SignerProviderWithMultipleAccounts;
+class SignerProviderWithCachedAccounts extends SignerProviderWithMultipleAccounts {
+    constructor() {
+        super(...arguments);
+        this._selectedAccount = undefined;
+        this._accounts = new Map();
+    }
+    getSelectedAccount() {
+        if (this._selectedAccount === undefined) {
+            throw Error('No account is selected yet');
+        }
+        else {
+            return Promise.resolve(this._selectedAccount);
+        }
+    }
+    setSelectedAddress(address) {
+        const accountOpt = this._accounts.get(address);
+        if (accountOpt === undefined) {
+            throw Error('The address is not in the accounts');
+        }
+        else {
+            this._selectedAccount = accountOpt;
+            return Promise.resolve();
+        }
+    }
+    getAccounts() {
+        return Promise.resolve(Array.from(this._accounts.values()));
+    }
+    async getAccount(address) {
+        const account = this._accounts.get(address);
+        if (account === undefined) {
+            throw Error('The address is not in the accounts');
+        }
+        return Promise.resolve(account);
+    }
+}
+exports.SignerProviderWithCachedAccounts = SignerProviderWithCachedAccounts;
 function verifyHexString(hexString, publicKey, signature) {
     try {
         const key = ec.keyFromPublic(publicKey, 'hex');
@@ -199,7 +228,6 @@ function verifySignedMessage(message, publicKey, signature) {
     return verifyHexString(utils.binToHex(messageHash), publicKey, signature);
 }
 exports.verifySignedMessage = verifySignedMessage;
-utils_1.assertType;
 function toApiDestination(data) {
     return { ...data, attoAlphAmount: (0, api_1.toApiNumber256)(data.attoAlphAmount), tokens: (0, api_1.toApiTokens)(data.tokens) };
 }

package/dist/src/signer/types.d.ts

@@ -0,0 +1,109 @@
+import { Number256, Token } from '../api';
+import { node } from '../api';
+export declare type Address = string;
+export declare type OutputRef = node.OutputRef;
+export interface Destination {
+    address: string;
+    attoAlphAmount: Number256;
+    tokens?: Token[];
+    lockTime?: number;
+    message?: string;
+}
+export interface Account {
+    address: string;
+    group: number;
+    publicKey: string;
+}
+export declare type SignerAddress = {
+    signerAddress: string;
+};
+export interface SignTransferTxParams {
+    signerAddress: string;
+    destinations: Destination[];
+    utxos?: OutputRef[];
+    gasAmount?: number;
+    gasPrice?: Number256;
+}
+export interface SignTransferTxResult {
+    fromGroup: number;
+    toGroup: number;
+    unsignedTx: string;
+    txId: string;
+    signature: string;
+    gasAmount: number;
+    gasPrice: Number256;
+}
+export interface SignDeployContractTxParams {
+    signerAddress: string;
+    bytecode: string;
+    initialAttoAlphAmount?: Number256;
+    initialTokenAmounts?: Token[];
+    issueTokenAmount?: Number256;
+    gasAmount?: number;
+    gasPrice?: Number256;
+}
+export interface SignDeployContractTxResult {
+    fromGroup: number;
+    toGroup: number;
+    unsignedTx: string;
+    txId: string;
+    signature: string;
+    contractId: string;
+    contractAddress: string;
+    gasAmount: number;
+    gasPrice: Number256;
+}
+export interface SignExecuteScriptTxParams {
+    signerAddress: string;
+    bytecode: string;
+    attoAlphAmount?: Number256;
+    tokens?: Token[];
+    gasAmount?: number;
+    gasPrice?: Number256;
+}
+export interface SignExecuteScriptTxResult {
+    fromGroup: number;
+    toGroup: number;
+    unsignedTx: string;
+    txId: string;
+    signature: string;
+    gasAmount: number;
+    gasPrice: Number256;
+}
+export interface SignUnsignedTxParams {
+    signerAddress: string;
+    unsignedTx: string;
+}
+export interface SignUnsignedTxResult {
+    fromGroup: number;
+    toGroup: number;
+    unsignedTx: string;
+    txId: string;
+    signature: string;
+    gasAmount: number;
+    gasPrice: Number256;
+}
+export interface SignMessageParams {
+    signerAddress: string;
+    message: string;
+}
+export interface SignMessageResult {
+    signature: string;
+}
+export interface SubmitTransactionParams {
+    unsignedTx: string;
+    signature: string;
+}
+export interface SubmissionResult {
+    txId: string;
+    fromGroup: number;
+    toGroup: number;
+}
+export interface EnableOptionsBase {
+    chainGroup?: number;
+    onDisconnected: () => Promise<void>;
+    onNetworkChanged: (network: {
+        networkName: string;
+        networkId: number;
+    }) => Promise<void>;
+}

package/dist/src/signer/types.js

@@ -0,0 +1,30 @@
+"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 });
+const utils_1 = require("../utils");
+utils_1.assertType;
+(0, utils_1.assertType)();
+(0, utils_1.assertType)();
+(0, utils_1.assertType)();
+(0, utils_1.assertType)();
+(0, utils_1.assertType)();
+(0, utils_1.assertType)();
+(0, utils_1.assertType)();
+utils_1.assertType;
+(0, utils_1.assertType)();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.3.0-rc.4",
+  "version": "0.3.0-rc.5",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -27,7 +27,7 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "1.6.0-rc5",
+    "alephium_version": "1.6.1",
     "explorer_backend_version": "1.11.2"
   },
   "scripts": {
@@ -71,6 +71,7 @@
     "jest-websocket-mock": "^2.2.1",
     "mock-fs": "^5.1.2",
     "mock-socket": "^9.0.8",
+    "path-browserify": "^1.0.1",
     "prettier": "^2.3.2",
     "process": "^0.11.10",
     "rewire": "^6.0.0",

package/src/api/api-alephium.ts

@@ -1332,7 +1332,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 1.6.0
+ * @version 1.6.1
  * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {