@alephium/web3 0.5.0-rc.1 → 0.5.0-rc.11

package/dist/src/signer/tx-builder.js

@@ -23,25 +23,26 @@ const api_1 = require("../api");
 const utils_1 = require("../utils");
 const signer_1 = require("./signer");
 class TransactionBuilder {
-    static create(baseUrl, apiKey) {
-        const nodeProvider = new api_1.NodeProvider(baseUrl, apiKey);
+    static from(param0, param1) {
+        const nodeProvider = typeof param0 === 'string' ? new api_1.NodeProvider(param0, param1) : param0;
         return new (class extends TransactionBuilder {
             get nodeProvider() {
                 return nodeProvider;
             }
         })();
     }
-    static validatePublicKey(params, publicKey) {
-        const address = (0, utils_1.addressFromPublicKey)(publicKey);
+    static validatePublicKey(params, publicKey, keyType) {
+        const address = (0, utils_1.addressFromPublicKey)(publicKey, keyType);
         if (address !== params.signerAddress) {
             throw new Error('Unmatched public key');
         }
     }
     async buildTransferTx(params, publicKey) {
-        TransactionBuilder.validatePublicKey(params, publicKey);
+        TransactionBuilder.validatePublicKey(params, publicKey, params.signerKeyType);
         const { destinations, gasPrice, ...rest } = params;
         const data = {
             fromPublicKey: publicKey,
+            fromPublicKeyType: params.signerKeyType,
             destinations: (0, signer_1.toApiDestinations)(destinations),
             gasPrice: (0, api_1.toApiNumber256Optional)(gasPrice),
             ...rest
@@ -50,10 +51,11 @@ class TransactionBuilder {
         return { ...response, gasPrice: (0, api_1.fromApiNumber256)(response.gasPrice) };
     }
     async buildDeployContractTx(params, publicKey) {
-        TransactionBuilder.validatePublicKey(params, publicKey);
+        TransactionBuilder.validatePublicKey(params, publicKey, params.signerKeyType);
         const { initialAttoAlphAmount, initialTokenAmounts, issueTokenAmount, gasPrice, ...rest } = params;
         const data = {
             fromPublicKey: publicKey,
+            fromPublicKeyType: params.signerKeyType,
             initialAttoAlphAmount: (0, api_1.toApiNumber256Optional)(initialAttoAlphAmount),
             initialTokenAmounts: (0, api_1.toApiTokens)(initialTokenAmounts),
             issueTokenAmount: (0, api_1.toApiNumber256Optional)(issueTokenAmount),
@@ -65,10 +67,11 @@ class TransactionBuilder {
         return { ...response, groupIndex: response.fromGroup, contractId, gasPrice: (0, api_1.fromApiNumber256)(response.gasPrice) };
     }
     async buildExecuteScriptTx(params, publicKey) {
-        TransactionBuilder.validatePublicKey(params, publicKey);
+        TransactionBuilder.validatePublicKey(params, publicKey, params.signerKeyType);
         const { attoAlphAmount, tokens, gasPrice, ...rest } = params;
         const data = {
             fromPublicKey: publicKey,
+            fromPublicKeyType: params.signerKeyType,
             attoAlphAmount: (0, api_1.toApiNumber256Optional)(attoAlphAmount),
             tokens: (0, api_1.toApiTokens)(tokens),
             gasPrice: (0, api_1.toApiNumber256Optional)(gasPrice),

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

@@ -9,16 +9,20 @@ export interface Destination {
     lockTime?: number;
     message?: string;
 }
+export declare type KeyType = 'default' | 'bip340-schnorr';
 export interface Account {
+    keyType: KeyType;
     address: string;
     group: number;
     publicKey: string;
 }
 export declare type SignerAddress = {
     signerAddress: string;
+    signerKeyType?: KeyType;
 };
 export interface SignTransferTxParams {
     signerAddress: string;
+    signerKeyType?: KeyType;
     destinations: Destination[];
     utxos?: OutputRef[];
     gasAmount?: number;
@@ -35,6 +39,7 @@ export interface SignTransferTxResult {
 }
 export interface SignDeployContractTxParams {
     signerAddress: string;
+    signerKeyType?: KeyType;
     bytecode: string;
     initialAttoAlphAmount?: Number256;
     initialTokenAmounts?: Token[];
@@ -54,6 +59,7 @@ export interface SignDeployContractTxResult {
 }
 export interface SignExecuteScriptTxParams {
     signerAddress: string;
+    signerKeyType?: KeyType;
     bytecode: string;
     attoAlphAmount?: Number256;
     tokens?: Token[];
@@ -70,6 +76,7 @@ export interface SignExecuteScriptTxResult {
 }
 export interface SignUnsignedTxParams {
     signerAddress: string;
+    signerKeyType?: KeyType;
     unsignedTx: string;
 }
 export interface SignUnsignedTxResult {
@@ -83,6 +90,7 @@ export interface SignUnsignedTxResult {
 }
 export interface SignMessageParams {
     signerAddress: string;
+    signerKeyType?: KeyType;
     message: string;
 }
 export interface SignMessageResult {
@@ -102,18 +110,3 @@ export interface EnableOptionsBase {
     networkId: string;
     onDisconnected: () => Promise<void>;
 }
-export declare type ExtSignTransferTxParams = SignTransferTxParams & {
-    networkId: string;
-};
-export declare type ExtSignDeployContractTxParams = SignDeployContractTxParams & {
-    networkId: string;
-};
-export declare type ExtSignExecuteScriptTxParams = SignExecuteScriptTxParams & {
-    networkId: string;
-};
-export declare type ExtSignUnsignedTxParams = SignUnsignedTxParams & {
-    networkId: string;
-};
-export declare type ExtSignMessageParams = SignMessageParams & {
-    networkId: string;
-};

package/dist/src/transaction/sign-verify.d.ts

@@ -1,2 +1,3 @@
-export declare function transactionSign(txHash: string, privateKey: string): string;
-export declare function transactionVerifySignature(txHash: string, publicKey: string, signature: string): boolean;
+import { KeyType } from '../signer';
+export declare function transactionSign(txId: string, privateKey: string, keyType?: KeyType): string;
+export declare function transactionVerifySignature(txId: string, publicKey: string, signature: string, keyType?: KeyType): boolean;

package/dist/src/transaction/sign-verify.js

@@ -42,21 +42,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transactionVerifySignature = exports.transactionSign = void 0;
 const utils = __importStar(require("../utils"));
-const elliptic_1 = require("elliptic");
-const ec = new elliptic_1.ec('secp256k1');
-function transactionSign(txHash, privateKey) {
-    const keyPair = ec.keyFromPrivate(privateKey);
-    const signature = keyPair.sign(txHash);
-    return utils.encodeSignature(signature);
+function transactionSign(txId, privateKey, keyType) {
+    return utils.sign(txId, privateKey, keyType);
 }
 exports.transactionSign = transactionSign;
-function transactionVerifySignature(txHash, publicKey, signature) {
-    try {
-        const key = ec.keyFromPublic(publicKey, 'hex');
-        return key.verify(txHash, utils.signatureDecode(ec, signature));
-    }
-    catch (error) {
-        return false;
-    }
+function transactionVerifySignature(txId, publicKey, signature, keyType) {
+    return utils.verifySignature(txId, publicKey, signature, keyType);
 }
 exports.transactionVerifySignature = transactionVerifySignature;

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

@@ -3,3 +3,4 @@ export * from './bs58';
 export * from './djb2';
 export * from './utils';
 export * from './subscription';
+export * from './sign';

package/dist/src/utils/index.js

@@ -36,3 +36,4 @@ __exportStar(require("./bs58"), exports);
 __exportStar(require("./djb2"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./subscription"), exports);
+__exportStar(require("./sign"), exports);

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

@@ -0,0 +1,3 @@
+import { KeyType } from '../signer';
+export declare function sign(hash: string, privateKey: string, _keyType?: KeyType): string;
+export declare function verifySignature(hash: string, publicKey: string, signature: string, _keyType?: KeyType): boolean;

package/dist/src/utils/sign.js

@@ -0,0 +1,89 @@
+"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/>.
+*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifySignature = exports.sign = void 0;
+const elliptic_1 = require("elliptic");
+const __1 = require("..");
+const necc = __importStar(require("@noble/secp256k1"));
+const crypto_1 = require("crypto");
+const ec = new elliptic_1.ec('secp256k1');
+necc.utils.sha256Sync = (...messages) => {
+    const sha256 = (0, crypto_1.createHash)('sha256');
+    for (const message of messages)
+        sha256.update(message);
+    return sha256.digest();
+};
+necc.utils.hmacSha256Sync = (key, ...messages) => {
+    const hash = (0, crypto_1.createHmac)('sha256', Buffer.from(key));
+    messages.forEach((m) => hash.update(m));
+    return Uint8Array.from(hash.digest());
+};
+// hash has to be 32 bytes
+function sign(hash, privateKey, _keyType) {
+    const keyType = _keyType ?? 'default';
+    if (keyType === 'default') {
+        const key = ec.keyFromPrivate(privateKey);
+        const signature = key.sign(hash);
+        return (0, __1.encodeSignature)(signature);
+    }
+    else {
+        const signature = necc.schnorr.signSync((0, __1.hexToBinUnsafe)(hash), (0, __1.hexToBinUnsafe)(privateKey));
+        return (0, __1.binToHex)(signature);
+    }
+}
+exports.sign = sign;
+function verifySignature(hash, publicKey, signature, _keyType) {
+    const keyType = _keyType ?? 'default';
+    try {
+        if (keyType === 'default') {
+            const key = ec.keyFromPublic(publicKey, 'hex');
+            return key.verify(hash, (0, __1.signatureDecode)(ec, signature));
+        }
+        else {
+            return necc.schnorr.verifySync((0, __1.hexToBinUnsafe)(signature), (0, __1.hexToBinUnsafe)(hash), (0, __1.hexToBinUnsafe)(publicKey));
+        }
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.verifySignature = verifySignature;

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

@@ -1,5 +1,6 @@
 import { ec as EC, SignatureInput } from 'elliptic';
 import BN from 'bn.js';
+import { KeyType } from '../signer';
 export declare function encodeSignature(signature: EC.Signature | {
     r: BN;
     s: BN;
@@ -13,9 +14,9 @@ export declare function contractIdFromAddress(address: string): Uint8Array;
 export declare function tokenIdFromAddress(address: string): Uint8Array;
 export declare function hexToBinUnsafe(hex: string): Uint8Array;
 export declare function binToHex(bin: Uint8Array): string;
-export declare function groupOfPrivateKey(privateKey: string): number;
-export declare function publicKeyFromPrivateKey(privateKey: string): string;
-export declare function addressFromPublicKey(publicKey: string): string;
+export declare function groupOfPrivateKey(privateKey: string, keyType?: KeyType): number;
+export declare function publicKeyFromPrivateKey(privateKey: string, _keyType?: KeyType): string;
+export declare function addressFromPublicKey(publicKey: string, _keyType?: KeyType): string;
 export declare function addressFromContractId(contractId: string): string;
 export declare function contractIdFromTx(txId: string, outputIndex: number): string;
 export declare function subContractId(parentContractId: string, pathInHex: string, group: number): string;

package/dist/src/utils/utils.js

@@ -153,20 +153,35 @@ function binToHex(bin) {
     return buffer_1.Buffer.from(bin).toString('hex');
 }
 exports.binToHex = binToHex;
-function groupOfPrivateKey(privateKey) {
-    return groupOfAddress(addressFromPublicKey(publicKeyFromPrivateKey(privateKey)));
+function groupOfPrivateKey(privateKey, keyType) {
+    return groupOfAddress(addressFromPublicKey(publicKeyFromPrivateKey(privateKey, keyType), keyType));
 }
 exports.groupOfPrivateKey = groupOfPrivateKey;
-function publicKeyFromPrivateKey(privateKey) {
-    const key = ec.keyFromPrivate(privateKey);
-    return key.getPublic(true, 'hex');
+function publicKeyFromPrivateKey(privateKey, _keyType) {
+    const keyType = _keyType ?? 'default';
+    if (keyType === 'default') {
+        const key = ec.keyFromPrivate(privateKey);
+        return key.getPublic(true, 'hex');
+    }
+    else {
+        return ec.g.mul(new bn_js_1.default(privateKey, 16)).encode('hex', true).slice(2);
+    }
 }
 exports.publicKeyFromPrivateKey = publicKeyFromPrivateKey;
-function addressFromPublicKey(publicKey) {
-    const addressType = buffer_1.Buffer.from([AddressType.P2PKH]);
-    const hash = buffer_1.Buffer.from(blakejs_1.default.blake2b(buffer_1.Buffer.from(publicKey, 'hex'), undefined, 32));
-    const bytes = buffer_1.Buffer.concat([addressType, hash]);
-    return bs58_1.default.encode(bytes);
+function addressFromPublicKey(publicKey, _keyType) {
+    const keyType = _keyType ?? 'default';
+    if (keyType === 'default') {
+        const addressType = buffer_1.Buffer.from([AddressType.P2PKH]);
+        const hash = buffer_1.Buffer.from(blakejs_1.default.blake2b(buffer_1.Buffer.from(publicKey, 'hex'), undefined, 32));
+        const bytes = buffer_1.Buffer.concat([addressType, hash]);
+        return bs58_1.default.encode(bytes);
+    }
+    else {
+        const lockupScript = buffer_1.Buffer.from(`0101000000000458144020${publicKey}8685`, 'hex');
+        const lockupScriptHash = blakejs_1.default.blake2b(lockupScript, undefined, 32);
+        const addressType = buffer_1.Buffer.from([AddressType.P2SH]);
+        return bs58_1.default.encode(buffer_1.Buffer.concat([addressType, lockupScriptHash]));
+    }
 }
 exports.addressFromPublicKey = addressFromPublicKey;
 function addressFromContractId(contractId) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.5.0-rc.1",
+  "version": "0.5.0-rc.11",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -40,6 +40,7 @@
   },
   "type": "commonjs",
   "dependencies": {
+    "@noble/secp256k1": "1.7.1",
     "base-x": "4.0.0",
     "blakejs": "1.2.1",
     "buffer": "^6.0.3",

package/src/api/api-alephium.ts

@@ -202,9 +202,12 @@ export interface BrokerInfo {
 }
 
 export interface BuildDeployContractTx {
-  /** @format public-key */
+  /** @format hex-string */
   fromPublicKey: string
 
+  /** @format hex-string */
+  fromPublicKeyType?: string
+
   /** @format hex-string */
   bytecode: string
 
@@ -247,9 +250,12 @@ export interface BuildDeployContractTxResult {
 }
 
 export interface BuildExecuteScriptTx {
-  /** @format public-key */
+  /** @format hex-string */
   fromPublicKey: string
 
+  /** @format hex-string */
+  fromPublicKeyType?: string
+
   /** @format hex-string */
   bytecode: string
 
@@ -346,8 +352,11 @@ export interface BuildSweepAddressTransactionsResult {
 }
 
 export interface BuildTransaction {
-  /** @format public-key */
+  /** @format hex-string */
   fromPublicKey: string
+
+  /** @format hex-string */
+  fromPublicKeyType?: string
   destinations: Destination[]
   utxos?: OutputRef[]
 
@@ -695,6 +704,15 @@ export interface MemPooled {
   type: string
 }
 
+export interface MempoolTransactions {
+  /** @format int32 */
+  fromGroup: number
+
+  /** @format int32 */
+  toGroup: number
+  transactions: TransactionTemplate[]
+}
+
 export interface MinerAddresses {
   addresses: string[]
 }
@@ -1004,15 +1022,6 @@ export interface Unban {
   type: string
 }
 
-export interface UnconfirmedTransactions {
-  /** @format int32 */
-  fromGroup: number
-
-  /** @format int32 */
-  toGroup: number
-  unconfirmedTransactions: TransactionTemplate[]
-}
-
 export interface Unreachable {
   peers: string[]
   type: string
@@ -1334,7 +1343,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 1.7.0
+ * @version 1.7.1
  * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -2070,25 +2079,6 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       }).then(convertHttpResponse)
   }
   transactions = {
-    /**
-     * No description
-     *
-     * @tags Transactions
-     * @name GetTransactionsUnconfirmed
-     * @summary List unconfirmed transactions
-     * @request GET:/transactions/unconfirmed
-     */
-    getTransactionsUnconfirmed: (params: RequestParams = {}) =>
-      this.request<
-        UnconfirmedTransactions[],
-        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
-      >({
-        path: `/transactions/unconfirmed`,
-        method: 'GET',
-        format: 'json',
-        ...params
-      }).then(convertHttpResponse),
-
     /**
      * No description
      *
@@ -2211,6 +2201,72 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params
       }).then(convertHttpResponse)
   }
+  mempool = {
+    /**
+     * No description
+     *
+     * @tags Mempool
+     * @name GetMempoolTransactions
+     * @summary List mempool transactions
+     * @request GET:/mempool/transactions
+     */
+    getMempoolTransactions: (params: RequestParams = {}) =>
+      this.request<
+        MempoolTransactions[],
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/mempool/transactions`,
+        method: 'GET',
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * No description
+     *
+     * @tags Mempool
+     * @name DeleteMempoolTransactions
+     * @summary Remove all transactions from mempool
+     * @request DELETE:/mempool/transactions
+     */
+    deleteMempoolTransactions: (params: RequestParams = {}) =>
+      this.request<void, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/mempool/transactions`,
+        method: 'DELETE',
+        ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * No description
+     *
+     * @tags Mempool
+     * @name PutMempoolTransactionsRebroadcast
+     * @summary Rebroadcase a mempool transaction to the network
+     * @request PUT:/mempool/transactions/rebroadcast
+     */
+    putMempoolTransactionsRebroadcast: (query: { txId: string }, params: RequestParams = {}) =>
+      this.request<void, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/mempool/transactions/rebroadcast`,
+        method: 'PUT',
+        query: query,
+        ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * No description
+     *
+     * @tags Mempool
+     * @name PutMempoolTransactionsValidate
+     * @summary Validate all mempool transactions and remove invalid ones
+     * @request PUT:/mempool/transactions/validate
+     */
+    putMempoolTransactionsValidate: (params: RequestParams = {}) =>
+      this.request<void, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/mempool/transactions/validate`,
+        method: 'PUT',
+        ...params
+      }).then(convertHttpResponse)
+  }
   contracts = {
     /**
      * No description

package/src/api/index.ts

@@ -58,6 +58,7 @@ export class NodeProvider {
   readonly blockflow: NodeApi<string>['blockflow']
   readonly addresses: NodeApi<string>['addresses']
   readonly transactions: NodeApi<string>['transactions']
+  readonly mempool: NodeApi<string>['mempool']
   readonly contracts: NodeApi<string>['contracts']
   readonly multisig: NodeApi<string>['multisig']
   readonly utils: NodeApi<string>['utils']
@@ -83,6 +84,7 @@ export class NodeProvider {
     this.blockflow = { ...nodeApi.blockflow }
     this.addresses = { ...nodeApi.addresses }
     this.transactions = { ...nodeApi.transactions }
+    this.mempool = { ...nodeApi.mempool }
     this.contracts = { ...nodeApi.contracts }
     this.multisig = { ...nodeApi.multisig }
     this.utils = { ...nodeApi.utils }

package/src/api/types.ts

@@ -162,7 +162,13 @@ function _fromApiVal(vals: node.Val[], valIndex: number, tpe: string): [result:
   }
 }
 
-export function fromApiVals(vals: node.Val[], names: string[], types: string[]): NamedVals {
+export function fromApiVals(
+  vals: node.Val[],
+  names: string[],
+  types: string[],
+  optionalNames: string[] = [],
+  optionalTypes: string[] = []
+): NamedVals {
   let valIndex = 0
   const result: NamedVals = {}
   types.forEach((currentType, index) => {
@@ -171,7 +177,11 @@ export function fromApiVals(vals: node.Val[], names: string[], types: string[]):
     valIndex = nextIndex
     result[`${currentName}`] = val
   })
-  return result
+  if (valIndex === vals.length) {
+    return result
+  }
+  const optionalFields = fromApiVals(vals.slice(valIndex), optionalNames, optionalTypes)
+  return { ...result, ...optionalFields }
 }
 
 export function fromApiArray(vals: node.Val[], types: string[]): Val[] {

package/src/constants.ts

@@ -20,3 +20,4 @@ export const TOTAL_NUMBER_OF_GROUPS = 4
 export const MIN_UTXO_SET_AMOUNT = BigInt(1000000000000)
 export const ALPH_TOKEN_ID = ''.padStart(64, '0')
 export const ONE_ALPH = 10n ** 18n
+export const DUST_AMOUNT = 10n ** 15n