@super-protocol/sdk-js 1.0.0-beta.4 → 1.0.0

package/build/utils/helper.js

@@ -0,0 +1,157 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeBatchAsync = exports.cleanEventData = exports.isValidBytes32Hex = exports.packSlotInfo = exports.unpackSlotInfo = exports.unpackDeviceId = exports.packDevicId = exports.incrementMethodCall = exports.isNodeJS = exports.createTransactionOptions = exports.multiplyBigIntByNumber = exports.getGasPrice = exports.checkForUsingExternalTxManager = exports.checkIfActionAccountInitialized = void 0;
+const store_1 = __importDefault(require("../store"));
+const Monitoring_1 = require("./Monitoring");
+/**
+ * Function for checking if provider action account initialized (required for set methods)
+ * Used in all set methods
+ */
+const checkIfActionAccountInitialized = (transactionOptions) => {
+    if (!store_1.default.actionAccount && !(transactionOptions === null || transactionOptions === void 0 ? void 0 : transactionOptions.web3))
+        throw new Error("Provider action account is not initialized, needs to run 'BlockchainConnector.getInstance().initializeActionAccount(SECRET_KEY)' first");
+};
+exports.checkIfActionAccountInitialized = checkIfActionAccountInitialized;
+/**
+ * Function for checking if current configuration supposed to use external transaction manager like MetaMask and etc.
+ */
+const checkForUsingExternalTxManager = (transactionOptions) => {
+    // TODO: Agree on more proper way of signaling, that we use an external transaction manager, than just passing a web3 instance.
+    return !!(transactionOptions === null || transactionOptions === void 0 ? void 0 : transactionOptions.web3);
+};
+exports.checkForUsingExternalTxManager = checkForUsingExternalTxManager;
+/**
+ * Updates gas price determined by the last few blocks median
+ */
+const getGasPrice = (web3) => {
+    return web3.eth.getGasPrice();
+};
+exports.getGasPrice = getGasPrice;
+const multiplyBigIntByNumber = (big, num) => {
+    const factor = BigInt(Math.pow(10, (num.toString().split('.')[1] || '').length));
+    const result = big * BigInt(Math.round(num * Number(factor)));
+    return result / factor;
+};
+exports.multiplyBigIntByNumber = multiplyBigIntByNumber;
+/**
+ * Merge transaction options from arguments and from store
+ * Used in all set methods
+ */
+const createTransactionOptions = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!options)
+        options = {};
+    if (!options.from)
+        options.from = store_1.default.actionAccount;
+    if (!options.gas)
+        options.gas = store_1.default.gasLimit;
+    if (!options.gasPriceMultiplier)
+        options.gasPriceMultiplier = store_1.default.gasPriceMultiplier;
+    if (!options.gasPrice) {
+        const web3 = options.web3 || store_1.default.web3Https;
+        if (!web3) {
+            throw Error('web3 is undefined, define it in transaction options or initialize BlockchainConnector with web3 instance.');
+        }
+        try {
+            options.gasPrice = yield (0, exports.getGasPrice)(web3);
+        }
+        catch (e) {
+            options.gasPrice = store_1.default.gasPrice;
+        }
+    }
+    delete options.web3;
+    return options;
+});
+exports.createTransactionOptions = createTransactionOptions;
+const isNodeJS = () => {
+    return typeof window === 'undefined';
+};
+exports.isNodeJS = isNodeJS;
+function incrementMethodCall() {
+    return function (_target, propertyName, propertyDescriptor) {
+        const monitoring = Monitoring_1.Monitoring.getInstance();
+        const method = propertyDescriptor.value;
+        propertyDescriptor.value = function (...args) {
+            monitoring.incrementCall(propertyName);
+            return method.apply(this, args);
+        };
+        return propertyDescriptor;
+    };
+}
+exports.incrementMethodCall = incrementMethodCall;
+function packDevicId(hexedDeviceId) {
+    const hexRegex = /^[0-9a-fA-F]+$/;
+    if (hexedDeviceId.length !== 64) {
+        throw new Error('DeviceId must be equal 64 hex symbols');
+    }
+    if (!hexRegex.test(hexedDeviceId)) {
+        throw new Error('DeviceId must be a hexedecimal');
+    }
+    return '0x' + hexedDeviceId;
+}
+exports.packDevicId = packDevicId;
+function unpackDeviceId(bytes32) {
+    if (bytes32.length !== 66) {
+        throw new Error('DeviceId bytes must be equal 66 symbols');
+    }
+    // removes '0x'
+    return bytes32.slice(2, 66);
+}
+exports.unpackDeviceId = unpackDeviceId;
+function unpackSlotInfo(slotInfo, cpuDenominator) {
+    return {
+        cpuCores: slotInfo.cpuCores / cpuDenominator,
+        ram: slotInfo.ram,
+        diskUsage: slotInfo.diskUsage,
+    };
+}
+exports.unpackSlotInfo = unpackSlotInfo;
+function packSlotInfo(slotInfo, cpuDenominator) {
+    return {
+        cpuCores: slotInfo.cpuCores * cpuDenominator,
+        ram: slotInfo.ram,
+        diskUsage: slotInfo.diskUsage,
+    };
+}
+exports.packSlotInfo = packSlotInfo;
+function isValidBytes32Hex(data) {
+    const regex = /^0x[a-fA-F0-9]{64}$/;
+    return regex.test(data);
+}
+exports.isValidBytes32Hex = isValidBytes32Hex;
+const cleanEventData = (data) => {
+    var _a;
+    const result = Object.assign({}, data);
+    delete result.__length__;
+    for (let i = 0; i < ((_a = data.__length__) !== null && _a !== void 0 ? _a : 0); i++) {
+        delete result[i.toString()];
+    }
+    return result;
+};
+exports.cleanEventData = cleanEventData;
+const executeBatchAsync = (batch) => __awaiter(void 0, void 0, void 0, function* () {
+    const result = [];
+    const responses = yield batch.execute();
+    for (const response of responses) {
+        if ('error' in response) {
+            throw new Error(response.error.message);
+        }
+        else {
+            result.push(response.result);
+        }
+    }
+    return result;
+});
+exports.executeBatchAsync = executeBatchAsync;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3V0aWxzL2hlbHBlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7QUFBQSxxREFBNkI7QUFJN0IsNkNBQTBDO0FBRzFDOzs7R0FHRztBQUNJLE1BQU0sK0JBQStCLEdBQUcsQ0FBQyxrQkFBdUMsRUFBUSxFQUFFO0lBQzdGLElBQUksQ0FBQyxlQUFLLENBQUMsYUFBYSxJQUFJLENBQUMsQ0FBQSxrQkFBa0IsYUFBbEIsa0JBQWtCLHVCQUFsQixrQkFBa0IsQ0FBRSxJQUFJLENBQUE7UUFDakQsTUFBTSxJQUFJLEtBQUssQ0FDWCx3SUFBd0ksQ0FDM0ksQ0FBQztBQUNWLENBQUMsQ0FBQztBQUxXLFFBQUEsK0JBQStCLG1DQUsxQztBQUVGOztHQUVHO0FBQ0ksTUFBTSw4QkFBOEIsR0FBRyxDQUMxQyxrQkFBdUMsRUFDaEMsRUFBRTtJQUNULCtIQUErSDtJQUMvSCxPQUFPLENBQUMsQ0FBQyxDQUFBLGtCQUFrQixhQUFsQixrQkFBa0IsdUJBQWxCLGtCQUFrQixDQUFFLElBQUksQ0FBQSxDQUFDO0FBQ3RDLENBQUMsQ0FBQztBQUxXLFFBQUEsOEJBQThCLGtDQUt6QztBQUVGOztHQUVHO0FBQ0ksTUFBTSxXQUFXLEdBQUcsQ0FBQyxJQUFVLEVBQW1CLEVBQUU7SUFDdkQsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLFdBQVcsRUFBRSxDQUFDO0FBQ2xDLENBQUMsQ0FBQztBQUZXLFFBQUEsV0FBVyxlQUV0QjtBQUVLLE1BQU0sc0JBQXNCLEdBQUcsQ0FBQyxHQUFXLEVBQUUsR0FBVyxFQUFVLEVBQUU7SUFDdkUsTUFBTSxNQUFNLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxFQUFFLENBQUMsR0FBRyxDQUFDLFFBQVEsRUFBRSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO0lBQ2pGLE1BQU0sTUFBTSxHQUFHLEdBQUcsR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUU5RCxPQUFPLE1BQU0sR0FBRyxNQUFNLENBQUM7QUFDM0IsQ0FBQyxDQUFDO0FBTFcsUUFBQSxzQkFBc0IsMEJBS2pDO0FBRUY7OztHQUdHO0FBQ0ksTUFBTSx3QkFBd0IsR0FBRyxDQUNwQyxPQUE0QixFQUNELEVBQUU7SUFDN0IsSUFBSSxDQUFDLE9BQU87UUFBRSxPQUFPLEdBQUcsRUFBRSxDQUFDO0lBQzNCLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSTtRQUFFLE9BQU8sQ0FBQyxJQUFJLEdBQUcsZUFBSyxDQUFDLGFBQWEsQ0FBQztJQUN0RCxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUc7UUFBRSxPQUFPLENBQUMsR0FBRyxHQUFHLGVBQUssQ0FBQyxRQUFRLENBQUM7SUFDL0MsSUFBSSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0I7UUFBRSxPQUFPLENBQUMsa0JBQWtCLEdBQUcsZUFBSyxDQUFDLGtCQUFrQixDQUFDO0lBQ3ZGLElBQUksQ0FBQyxPQUFPLENBQUMsUUFBUSxFQUFFO1FBQ25CLE1BQU0sSUFBSSxHQUFHLE9BQU8sQ0FBQyxJQUFJLElBQUksZUFBSyxDQUFDLFNBQVMsQ0FBQztRQUM3QyxJQUFJLENBQUMsSUFBSSxFQUFFO1lBQ1AsTUFBTSxLQUFLLENBQ1AsMkdBQTJHLENBQzlHLENBQUM7U0FDTDtRQUNELElBQUk7WUFDQSxPQUFPLENBQUMsUUFBUSxHQUFHLE1BQU0sSUFBQSxtQkFBVyxFQUFDLElBQUksQ0FBQyxDQUFDO1NBQzlDO1FBQUMsT0FBTyxDQUFDLEVBQUU7WUFDUixPQUFPLENBQUMsUUFBUSxHQUFHLGVBQUssQ0FBQyxRQUFRLENBQUM7U0FDckM7S0FDSjtJQUNELE9BQU8sT0FBTyxDQUFDLElBQUksQ0FBQztJQUVwQixPQUFPLE9BQU8sQ0FBQztBQUNuQixDQUFDLENBQUEsQ0FBQztBQXZCVyxRQUFBLHdCQUF3Qiw0QkF1Qm5DO0FBRUssTUFBTSxRQUFRLEdBQUcsR0FBWSxFQUFFO0lBQ2xDLE9BQU8sT0FBTyxNQUFNLEtBQUssV0FBVyxDQUFDO0FBQ3pDLENBQUMsQ0FBQztBQUZXLFFBQUEsUUFBUSxZQUVuQjtBQUVGLFNBQWdCLG1CQUFtQjtJQUMvQixPQUFPLFVBQ0gsT0FBZ0IsRUFDaEIsWUFBb0IsRUFDcEIsa0JBQXNDO1FBRXRDLE1BQU0sVUFBVSxHQUFHLHVCQUFVLENBQUMsV0FBVyxFQUFFLENBQUM7UUFDNUMsTUFBTSxNQUFNLEdBQUcsa0JBQWtCLENBQUMsS0FBSyxDQUFDO1FBQ3hDLGtCQUFrQixDQUFDLEtBQUssR0FBRyxVQUFVLEdBQUcsSUFBZTtZQUNuRCxVQUFVLENBQUMsYUFBYSxDQUFDLFlBQVksQ0FBQyxDQUFDO1lBRXZDLE9BQU8sTUFBTSxDQUFDLEtBQUssQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDcEMsQ0FBQyxDQUFDO1FBQ0YsT0FBTyxrQkFBa0IsQ0FBQztJQUM5QixDQUFDLENBQUM7QUFDTixDQUFDO0FBZkQsa0RBZUM7QUFFRCxTQUFnQixXQUFXLENBQUMsYUFBcUI7SUFDN0MsTUFBTSxRQUFRLEdBQUcsZ0JBQWdCLENBQUM7SUFFbEMsSUFBSSxhQUFhLENBQUMsTUFBTSxLQUFLLEVBQUUsRUFBRTtRQUM3QixNQUFNLElBQUksS0FBSyxDQUFDLHVDQUF1QyxDQUFDLENBQUM7S0FDNUQ7SUFFRCxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsRUFBRTtRQUMvQixNQUFNLElBQUksS0FBSyxDQUFDLGdDQUFnQyxDQUFDLENBQUM7S0FDckQ7SUFFRCxPQUFPLElBQUksR0FBRyxhQUFhLENBQUM7QUFDaEMsQ0FBQztBQVpELGtDQVlDO0FBRUQsU0FBZ0IsY0FBYyxDQUFDLE9BQWU7SUFDMUMsSUFBSSxPQUFPLENBQUMsTUFBTSxLQUFLLEVBQUUsRUFBRTtRQUN2QixNQUFNLElBQUksS0FBSyxDQUFDLHlDQUF5QyxDQUFDLENBQUM7S0FDOUQ7SUFFRCxlQUFlO0lBQ2YsT0FBTyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQztBQUNoQyxDQUFDO0FBUEQsd0NBT0M7QUFFRCxTQUFnQixjQUFjLENBQUMsUUFBa0IsRUFBRSxjQUFzQjtJQUNyRSxPQUFPO1FBQ0gsUUFBUSxFQUFFLFFBQVEsQ0FBQyxRQUFRLEdBQUcsY0FBYztRQUM1QyxHQUFHLEVBQUUsUUFBUSxDQUFDLEdBQUc7UUFDakIsU0FBUyxFQUFFLFFBQVEsQ0FBQyxTQUFTO0tBQ2hDLENBQUM7QUFDTixDQUFDO0FBTkQsd0NBTUM7QUFFRCxTQUFnQixZQUFZLENBQUMsUUFBa0IsRUFBRSxjQUFzQjtJQUNuRSxPQUFPO1FBQ0gsUUFBUSxFQUFFLFFBQVEsQ0FBQyxRQUFRLEdBQUcsY0FBYztRQUM1QyxHQUFHLEVBQUUsUUFBUSxDQUFDLEdBQUc7UUFDakIsU0FBUyxFQUFFLFFBQVEsQ0FBQyxTQUFTO0tBQ2hDLENBQUM7QUFDTixDQUFDO0FBTkQsb0NBTUM7QUFFRCxTQUFnQixpQkFBaUIsQ0FBQyxJQUFZO0lBQzFDLE1BQU0sS0FBSyxHQUFHLHFCQUFxQixDQUFDO0lBQ3BDLE9BQU8sS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztBQUM1QixDQUFDO0FBSEQsOENBR0M7QUFFTSxNQUFNLGNBQWMsR0FBRyxDQUFDLElBQW1CLEVBQThCLEVBQUU7O0lBQzlFLE1BQU0sTUFBTSxxQkFBUSxJQUFJLENBQUUsQ0FBQztJQUMzQixPQUFRLE1BQWMsQ0FBQyxVQUFVLENBQUM7SUFFbEMsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxHQUFHLENBQUMsTUFBQSxJQUFJLENBQUMsVUFBVSxtQ0FBSSxDQUFDLENBQUMsRUFBRSxDQUFDLEVBQUUsRUFBRTtRQUM3QyxPQUFPLE1BQU0sQ0FBQyxDQUFDLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztLQUMvQjtJQUVELE9BQU8sTUFBTSxDQUFDO0FBQ2xCLENBQUMsQ0FBQztBQVRXLFFBQUEsY0FBYyxrQkFTekI7QUFFSyxNQUFNLGlCQUFpQixHQUFHLENBQzdCLEtBQXVCLEVBQ0MsRUFBRTtJQUMxQixNQUFNLE1BQU0sR0FBb0IsRUFBRSxDQUFDO0lBQ25DLE1BQU0sU0FBUyxHQUFHLE1BQU0sS0FBSyxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ3hDLEtBQUssTUFBTSxRQUFRLElBQUksU0FBUyxFQUFFO1FBQzlCLElBQUksT0FBTyxJQUFJLFFBQVEsRUFBRTtZQUNyQixNQUFNLElBQUksS0FBSyxDQUFFLFFBQVEsQ0FBQyxLQUFzQixDQUFDLE9BQU8sQ0FBQyxDQUFDO1NBQzdEO2FBQU07WUFDSCxNQUFNLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUF1QixDQUFDLENBQUM7U0FDakQ7S0FDSjtJQUVELE9BQU8sTUFBTSxDQUFDO0FBQ2xCLENBQUMsQ0FBQSxDQUFDO0FBZFcsUUFBQSxpQkFBaUIscUJBYzVCIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@super-protocol/sdk-js",
-  "version": "1.0.0-beta.4",
+  "version": "1.0.0",
   "main": "build/index.js",
   "license": "MIT",
   "files": [
@@ -35,7 +35,7 @@
     "@types/jest": "^27.0.3",
     "@types/lodash": "^4.14.176",
     "@types/lru-cache": "^7.10.10",
-    "@types/node": "^16.18.55",
+    "@types/node": "^16.18.59",
     "@types/node-forge": "^1.3.1",
     "@types/node-gzip": "^1.1.0",
     "@typescript-eslint/eslint-plugin": "^5.8.0",
@@ -52,8 +52,8 @@
     "ts-jest": "^27.0.7",
     "ts-proto": "^1.110.4",
     "ts-protoc-gen": "^0.15.0",
-    "typedoc": "^0.22.11",
-    "typedoc-plugin-markdown": "^3.11.12",
+    "typedoc": "^0.24.0",
+    "typedoc-plugin-markdown": "^3.16.0",
     "typescript": "^4.4.4"
   },
   "dependencies": {
@@ -76,8 +76,11 @@
     "pino": "^7.2.0",
     "pkijs": "^3.0.15",
     "protobufjs": "^6.11.2",
-    "web3": "^1.7.1",
-    "web3-parse-receipt-events": "^1.0.2"
+    "web3": "^4.1.2",
+    "web3-core-requestmanager": "^1.10.0",
+    "web3-eth-contract": "^4.0.4",
+    "web3-parse-receipt-events": "^1.0.2",
+    "web3-types": "^1.1.0"
   },
   "repository": "git://github.com/Super-Protocol/sdk-js.git",
   "resolutions": {

package/readme.md

@@ -3,7 +3,7 @@
 ## Installation
 
 ```
-yarn add @super-protocol/sdk-js
+npm install @super-protocol/sdk-js
 ```
 
 ## Prepare protobuf
@@ -12,25 +12,24 @@ yarn add @super-protocol/sdk-js
 
 2. Install protobuf (http://google.github.io/proto-lens/installing-protoc.html)
 
-3. yarn dto::update
+3. npm run dto::update
 
 ## Local Dev Setup
-1. npm install uplink-nodejs
+1. npm install
 
-2. Just run ```yarn```
+2. Just run ```npm run build```
 
 ## Scripts
 
-`yarn prettier` - run auto code style fixing
+`npm run prettier` - run auto code style fixing
 
-`yarn build` - create production build (in build folder)
+`npm run build` - create production build (in build folder)
 
-`yarn dto:update` - generate TypeScript classes based on DTO submodule
+`npm run dto:update` - generate TypeScript classes based on DTO submodule
 
 ## Dependencies
 - NodeJS v16.8.0
 - NPM v7.21.0
-- yarn v1.22.11
 
 ## Apple M1 instructions
 Some dependencies is not supported arm64 architecture. You can face with error like `dyld[12398]: missing symbol called`. To install everything correctly, do next: