@alephium/web3 0.2.0-rc.8 → 0.2.0-test.1

package/dist/src/test/privatekey-wallet.d.ts

@@ -0,0 +1,11 @@
+import { Account, SignerWithNodeProvider } from '../signer';
+export declare class PrivateKeyWallet extends SignerWithNodeProvider {
+    readonly privateKey: string;
+    readonly publicKey: string;
+    readonly address: string;
+    readonly group: number;
+    constructor(privateKey: string, alwaysSubmitTx?: boolean);
+    static Random(alwaysSubmitTx?: boolean): PrivateKeyWallet;
+    getAccounts(): Promise<Account[]>;
+    signRaw(signerAddress: string, hexString: string): Promise<string>;
+}

package/dist/src/test/privatekey-wallet.js

@@ -0,0 +1,68 @@
+"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;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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.PrivateKeyWallet = void 0;
+const elliptic_1 = require("elliptic");
+const signer_1 = require("../signer");
+const utils = __importStar(require("../utils"));
+const ec = new elliptic_1.ec('secp256k1');
+class PrivateKeyWallet extends signer_1.SignerWithNodeProvider {
+    constructor(privateKey, alwaysSubmitTx = true) {
+        super(alwaysSubmitTx);
+        this.privateKey = privateKey;
+        this.publicKey = utils.publicKeyFromPrivateKey(privateKey);
+        this.address = utils.addressFromPublicKey(this.publicKey);
+        this.group = utils.groupOfAddress(this.address);
+    }
+    static Random(alwaysSubmitTx = true) {
+        const keyPair = ec.genKeyPair();
+        return new PrivateKeyWallet(keyPair.getPrivate().toString('hex'), alwaysSubmitTx);
+    }
+    async getAccounts() {
+        return [{ address: this.address, publicKey: this.publicKey, group: this.group }];
+    }
+    async signRaw(signerAddress, hexString) {
+        if (signerAddress !== this.address) {
+            throw Error('Unmatched signer address');
+        }
+        const key = ec.keyFromPrivate(this.privateKey);
+        const signature = key.sign(hexString);
+        return utils.signatureEncode(signature);
+    }
+}
+exports.PrivateKeyWallet = PrivateKeyWallet;

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

@@ -1 +1,2 @@
+export * from './sign-verify';
 export * from './status';

package/dist/src/transaction/index.js

@@ -18,11 +18,7 @@ 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);
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -31,4 +27,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./sign-verify"), exports);
 __exportStar(require("./status"), exports);

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

@@ -0,0 +1,2 @@
+export declare function transactionSign(txHash: string, privateKey: string): string;
+export declare function transactionVerifySignature(txHash: string, publicKey: string, signature: string): boolean;

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

@@ -0,0 +1,58 @@
+"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;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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.transactionVerifySignature = exports.transactionSign = void 0;
+const elliptic_1 = require("elliptic");
+const utils = __importStar(require("../utils"));
+const ec = new elliptic_1.ec('secp256k1');
+function transactionSign(txHash, privateKey) {
+    const keyPair = ec.keyFromPrivate(privateKey);
+    const signature = keyPair.sign(txHash);
+    return utils.signatureEncode(signature);
+}
+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;
+    }
+}
+exports.transactionVerifySignature = transactionVerifySignature;

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

@@ -1,5 +1,6 @@
 export * from './address';
 export * from './bs58';
 export * from './djb2';
+export * from './password-crypto';
 export * from './utils';
 export * from './subscription';

package/dist/src/utils/index.js

@@ -18,11 +18,7 @@ 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);
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -34,5 +30,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./address"), exports);
 __exportStar(require("./bs58"), exports);
 __exportStar(require("./djb2"), exports);
+__exportStar(require("./password-crypto"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./subscription"), exports);

package/dist/src/utils/password-crypto.d.ts

@@ -0,0 +1,2 @@
+export declare const encrypt: (password: string, dataRaw: string) => string;
+export declare const decrypt: (password: string, payloadRaw: string) => string;

package/dist/src/utils/password-crypto.js

@@ -0,0 +1,69 @@
+"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.decrypt = exports.encrypt = void 0;
+const buffer_1 = require("buffer/");
+const crypto_1 = require("crypto");
+const saltByteLength = 64;
+const ivByteLength = 64;
+const authTagLength = 16;
+const encrypt = (password, dataRaw) => {
+    const data = buffer_1.Buffer.from(dataRaw, 'utf8');
+    const salt = (0, crypto_1.randomBytes)(saltByteLength);
+    const derivedKey = keyFromPassword(password, salt);
+    const iv = (0, crypto_1.randomBytes)(ivByteLength);
+    const cipher = createCipher(derivedKey, iv);
+    const encrypted = buffer_1.Buffer.concat([cipher.update(data), cipher.final()]);
+    const authTag = cipher.getAuthTag();
+    const payload = {
+        salt: salt.toString('hex'),
+        iv: iv.toString('hex'),
+        encrypted: buffer_1.Buffer.concat([encrypted, authTag]).toString('hex'),
+        version: 1
+    };
+    return JSON.stringify(payload);
+};
+exports.encrypt = encrypt;
+const decrypt = (password, payloadRaw) => {
+    const payload = JSON.parse(payloadRaw);
+    const version = payload.version;
+    if (version !== 1) {
+        throw new Error(`Invalid version: got ${version}, expected: 1`);
+    }
+    const salt = buffer_1.Buffer.from(payload.salt, 'hex');
+    const iv = buffer_1.Buffer.from(payload.iv, 'hex');
+    const encrypted = buffer_1.Buffer.from(payload.encrypted, 'hex');
+    const derivedKey = keyFromPassword(password, salt);
+    const decipher = createDecipher(derivedKey, iv);
+    const data = encrypted.slice(0, encrypted.length - authTagLength);
+    const authTag = encrypted.slice(encrypted.length - authTagLength, encrypted.length);
+    decipher.setAuthTag(authTag);
+    const decrypted = buffer_1.Buffer.concat([decipher.update(data), decipher.final()]);
+    return decrypted.toString('utf8');
+};
+exports.decrypt = decrypt;
+const createCipher = (key, iv) => {
+    return (0, crypto_1.createCipheriv)('aes-256-gcm', key, iv);
+};
+const createDecipher = (key, iv) => {
+    return (0, crypto_1.createDecipheriv)('aes-256-gcm', key, iv);
+};
+const keyFromPassword = (password, salt) => {
+    return (0, crypto_1.pbkdf2Sync)(password, salt, 10000, 32, 'sha256');
+};

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

@@ -7,10 +7,9 @@ export declare function convertHttpResponse<T>(response: node.HttpResponse<T, {
     detail: string;
 }>): T;
 export declare function signatureEncode(signature: EC.Signature): string;
-export declare function signatureDecode(ec: EC, signature: string): SignatureInput;
-export declare function xorByte(intValue: number): number;
+export declare const signatureDecode: (ec: EC, signature: string) => SignatureInput;
 export declare function isHexString(input: string): boolean;
-export declare function groupOfAddress(address: string): number;
+export declare const groupOfAddress: (address: string) => number;
 export declare function contractIdFromAddress(address: string): Uint8Array;
 export declare function tokenIdFromAddress(address: string): Uint8Array;
 export declare function hexToBinUnsafe(hex: string): Uint8Array;

package/dist/src/utils/utils.js

@@ -20,7 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertType = exports.timeout = exports.hexToString = exports.stringToHex = exports.subContractId = exports.contractIdFromTx = exports.addressFromContractId = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.isHexString = exports.xorByte = exports.signatureDecode = exports.signatureEncode = exports.convertHttpResponse = void 0;
+exports.assertType = exports.timeout = exports.hexToString = exports.stringToHex = exports.subContractId = exports.contractIdFromTx = exports.addressFromContractId = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.isHexString = exports.signatureDecode = exports.signatureEncode = exports.convertHttpResponse = void 0;
 const elliptic_1 = require("elliptic");
 const bn_js_1 = __importDefault(require("bn.js"));
 const blakejs_1 = __importDefault(require("blakejs"));
@@ -49,7 +49,7 @@ function signatureEncode(signature) {
 }
 exports.signatureEncode = signatureEncode;
 // the signature should be in hex string format for 64 bytes
-function signatureDecode(ec, signature) {
+const signatureDecode = (ec, signature) => {
     if (signature.length !== 128) {
         throw new Error('Invalid signature length');
     }
@@ -62,16 +62,15 @@ function signatureDecode(ec, signature) {
     else {
         throw new Error('The signature is not normalized');
     }
-}
+};
 exports.signatureDecode = signatureDecode;
-function xorByte(intValue) {
+const xorByte = (intValue) => {
     const byte0 = (intValue >> 24) & 0xff;
     const byte1 = (intValue >> 16) & 0xff;
     const byte2 = (intValue >> 8) & 0xff;
     const byte3 = intValue & 0xff;
     return (byte0 ^ byte1 ^ byte2 ^ byte3) & 0xff;
-}
-exports.xorByte = xorByte;
+};
 function isHexString(input) {
     return input.length % 2 === 0 && /[0-9a-f]*$/.test(input);
 }
@@ -83,7 +82,7 @@ var AddressType;
     AddressType[AddressType["P2SH"] = 2] = "P2SH";
     AddressType[AddressType["P2C"] = 3] = "P2C";
 })(AddressType || (AddressType = {}));
-function groupOfAddress(address) {
+const groupOfAddress = (address) => {
     const decoded = bs58_1.default.decode(address);
     if (decoded.length == 0)
         throw new Error('Address string is empty');
@@ -101,32 +100,32 @@ function groupOfAddress(address) {
     else {
         throw new Error(`Invalid asset address type: ${addressType}`);
     }
-}
+};
 exports.groupOfAddress = groupOfAddress;
-function groupOfAddressBytes(bytes) {
+const groupOfAddressBytes = (bytes) => {
     const hint = (0, djb2_1.default)(bytes) | 1;
     const hash = xorByte(hint);
     const group = hash % constants_1.TOTAL_NUMBER_OF_GROUPS;
     return group;
-}
+};
 // Pay to public key hash address
-function groupOfP2pkhAddress(address) {
+const groupOfP2pkhAddress = (address) => {
     if (address.length != 32) {
         throw new Error(`Invalid p2pkh address length: ${address.length}`);
     }
     return groupOfAddressBytes(address);
-}
+};
 // Pay to multiple public key hash address
-function groupOfP2mpkhAddress(address) {
+const groupOfP2mpkhAddress = (address) => {
     if ((address.length - 2) % 32 != 0) {
         throw new Error(`Invalid p2mpkh address length: ${address.length}`);
     }
     return groupOfAddressBytes(address.slice(1, 33));
-}
+};
 // Pay to script hash address
-function groupOfP2shAddress(address) {
+const groupOfP2shAddress = (address) => {
     return groupOfAddressBytes(address);
-}
+};
 function contractIdFromAddress(address) {
     return idFromAddress(address);
 }

package/gitignore

@@ -0,0 +1,9 @@
+node_modules/
+dist/
+build/
+web/
+.vscode
+.DS_Store
+coverage/
+/dev/
+!dev/user.conf

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.2.0-rc.8",
+  "version": "0.2.0-test.1",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -27,16 +27,29 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "1.5.0-rc7",
+    "alephium_version": "1.5.0-rc6",
     "explorer_backend_version": "1.7.1"
   },
   "scripts": {
     "build": "rm -rf dist/* && npx tsc --build . && webpack",
-    "test": "jest -i --config ./jest-config.json",
+    "bundle": "webpack",
     "update-schemas": "npm run update-schema:alephium && npm run update-schema:explorer",
     "update-schema:alephium": "npx swagger-typescript-api -t ./configs -o ./src/api -n api-alephium.ts -p https://raw.githubusercontent.com/alephium/alephium/v${npm_package_config_alephium_version}/api/src/main/resources/openapi.json",
     "update-schema:explorer": "npx swagger-typescript-api -t ./configs -o ./src/api -n api-explorer.ts -p https://raw.githubusercontent.com/alephium/explorer-backend/v${npm_package_config_explorer_backend_version}/app/src/main/resources/explorer-backend-openapi.json",
     "check-versions": "node scripts/check-versions.js ${npm_package_config_alephium_version} ${npm_package_config_explorer_backend_version}",
+    "dev": "tsnd --respawn lib/index.ts",
+    "lint": "eslint . --ext ts",
+    "lint:fix": "eslint . --fix --ext ts",
+    "test": "jest -i --config ./configs/jest.config.ts",
+    "test:client": "jest -i --config ./configs/jest-client.config.ts",
+    "test:unit": "jest -i --config ./configs/jest-unit.config.ts",
+    "test:watch": "npm run test -- --watch --coverage=false",
+    "test:watch:unit": "npm run test:unit -- --watch --coverage=false",
+    "test:watch:client": "npm run test:client -- --watch --coverage=false",
+    "prepublishOnly": "npm run build",
+    "prepack": "node scripts/rename-gitignore.js .gitignore gitignore",
+    "postpack": "node scripts/rename-gitignore.js gitignore .gitignore",
+    "prettier": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
     "start-devnet": "node scripts/start-devnet.js ${npm_package_config_alephium_version}",
     "restart-devnet": "npm run start-devnet",
     "stop-devnet": "node scripts/stop-devnet.js"
@@ -51,12 +64,15 @@
     "buffer": "^6.0.3",
     "commander": "^9.1.0",
     "cross-fetch": "^3.1.5",
+    "crypto-js": "4.1.1",
+    "elliptic": "6.5.4",
     "eventemitter3": "^4.0.7",
     "find-up": "^2.1.0",
     "fs-extra": "^10.0.1"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "^7.18.9",
+    "@types/crypto-js": "^4.1.1",
+    "@types/elliptic": "^6.4.13",
     "@types/find-up": "^2.1.0",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.5.1",
@@ -65,6 +81,7 @@
     "@types/rewire": "^2.5.28",
     "@typescript-eslint/eslint-plugin": "^4.30.0",
     "@typescript-eslint/parser": "^4.30.0",
+    "babel-eslint": "^10.1.0",
     "clean-webpack-plugin": "4.0.0",
     "crypto-browserify": "^3.12.0",
     "eslint": "^7.32.0",
@@ -88,12 +105,21 @@
     "ts-jest": "^28.0.2",
     "ts-node": "^10.7.0",
     "tslib": "^2.3.1",
-    "typescript": "4.7.4",
+    "typescript": "^4.4.2",
     "webpack": "^5.72.0",
     "webpack-cli": "^4.9.2"
   },
   "engines": {
-    "node": ">=16.0.0",
+    "node": ">=14.0.0",
     "npm": ">=7.0.0"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "tabWidth": 2,
+    "useTabs": false,
+    "semi": false,
+    "singleQuote": true,
+    "bracketSameLine": false,
+    "trailingComma": "none"
   }
 }

package/scripts/create-project.ts

@@ -73,7 +73,7 @@ function prepareShared(packageRoot: string, projectRoot: string) {
   console.log('...')
 
   fsExtra.copySync(path.join(packageRoot, 'templates/shared'), projectRoot)
-  copy('', ['.editorconfig', '.eslintignore', '.gitattributes'])
+  copy('', ['.editorconfig', '.eslintignore', '.gitattributes', 'LICENSE'])
   copy('dev', ['user.conf'])
   copy('scripts', ['start-devnet.js', 'stop-devnet.js'])
   if (fsExtra.existsSync(path.join(packageRoot, 'gitignore'))) {

package/src/api/api-alephium.ts

@@ -422,7 +422,6 @@ export interface ChangeActiveAddress {
 }
 
 export interface CompileContractResult {
-  name: string
   bytecode: string
 
   /** @format 32-byte-hash */
@@ -439,22 +438,12 @@ export interface CompileProjectResult {
 }
 
 export interface CompileScriptResult {
-  name: string
   bytecodeTemplate: string
   fields: FieldsSig
   functions: FunctionSig[]
   warnings: string[]
 }
 
-export interface CompilerOptions {
-  ignoreUnusedConstantsWarnings?: boolean
-  ignoreUnusedVariablesWarnings?: boolean
-  ignoreUnusedFieldsWarnings?: boolean
-  ignoreUnusedPrivateFunctionsWarnings?: boolean
-  ignoreReadonlyCheckWarnings?: boolean
-  ignoreExternalCallCheckWarnings?: boolean
-}
-
 export interface Confirmed {
   /** @format block-hash */
   blockHash: string
@@ -475,7 +464,6 @@ export interface Confirmed {
 
 export interface Contract {
   code: string
-  compilerOptions?: CompilerOptions
 }
 
 export interface ContractEvent {
@@ -726,7 +714,6 @@ export interface Penalty {
 
 export interface Project {
   code: string
-  compilerOptions?: CompilerOptions
 }
 
 export interface Reachable {
@@ -755,7 +742,6 @@ export interface RevealMnemonicResult {
 
 export interface Script {
   code: string
-  compilerOptions?: CompilerOptions
 }
 
 export interface SelfClique {