@super-protocol/sdk-js 0.6.0

package/build/models/Ballot.js

@@ -0,0 +1,76 @@
+"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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var logger_1 = __importDefault(require("../logger"));
+// import BallotJSON from "../contracts/Ballot.json";
+var Offers_json_1 = __importDefault(require("../contracts/Offers.json"));
+var store_1 = __importDefault(require("../store"));
+var utils_1 = require("../utils");
+var Ballot_1 = require("../types/Ballot");
+var Superpro_1 = __importDefault(require("../staticModels/Superpro"));
+var Ballot = /** @class */ (function () {
+    function Ballot(address) {
+        (0, utils_1.checkIfInitialized)();
+        this.address = address;
+        // this.contract = new store.web3!.eth.Contract(<AbiItem[]>BallotJSON.abi, address);
+        // TODO: stub
+        this.contract = new store_1.default.web3.eth.Contract(Offers_json_1.default.abi, Superpro_1.default.address);
+        this.logger = logger_1.default.child({ className: "Ballot", address: address });
+    }
+    /**
+     * Function for fetching order info from blockchain
+     */
+    Ballot.prototype.getBallotInfo = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var ballotInfoParams;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.contract.methods.getInfo().call()];
+                    case 1:
+                        ballotInfoParams = _a.sent();
+                        return [2 /*return*/, (this.ballotInfo = (0, utils_1.tupleToObject)(ballotInfoParams, Ballot_1.BallotInfoStructure))];
+                }
+            });
+        });
+    };
+    return Ballot;
+}());
+exports.default = Ballot;

package/build/models/Offer.d.ts

@@ -0,0 +1,70 @@
+import { OfferInfo, OfferType } from "../types/Offer";
+import { TransactionOptions } from "../types/Web3";
+import { Origins } from "../types/Origins";
+declare class Offer {
+    private static contract;
+    private logger;
+    offerInfo?: OfferInfo;
+    provider?: string;
+    type?: OfferType;
+    providerAuthority?: string;
+    origins?: Origins;
+    id: string;
+    disabledAfter?: number;
+    closingPrice?: string;
+    constructor(offerId: string);
+    /**
+     * Checks if contract has been initialized, if not - initialize contract
+     */
+    private checkInitOffer;
+    /**
+     * Function for fetching offer info from blockchain
+     */
+    getInfo(): Promise<OfferInfo>;
+    /**
+     * Function for fetching offer provider from blockchain (works for TEE and Value offers)
+     */
+    getProvider(): Promise<string>;
+    /**
+     * Fetch offer type from blockchain (works for TEE and Value offers)
+     */
+    getOfferType(): Promise<OfferType>;
+    /**
+     * Function for fetching TEE offer provider authority account from blockchain
+     */
+    getProviderAuthority(): Promise<string>;
+    /**
+     * Fetch new Origins (createdDate, createdBy, modifiedDate and modifiedBy)
+     */
+    getOrigins(): Promise<Origins>;
+    /**
+     * Function for offer closing price calculation
+     */
+    getClosingPrice(startDate: number, orderPrice: string): Promise<string>;
+    isOfferExists(): Promise<boolean>;
+    /**
+     * Function for disabling offer
+     * @param transactionOptions - object what contains alternative action account or gas limit (optional)
+     */
+    disable(transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Function for enabling offer
+     * @param transactionOptions - object what contains alternative action account or gas limit (optional)
+     */
+    enable(transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Checks if offer (offerAddress) match restrictions in this offer
+     * @param offerAddress - address of offer what needs to be checked
+     */
+    isRestrictionsPermitThatOffer(offerAddress: string): Promise<any>;
+    /**
+     * Checks if this offer contains restrictions of a certain type
+     * @param type - address of offer what needs to be checked
+     */
+    isRestrictedByOfferType(type: OfferType): Promise<any>;
+    /**
+     * Function for fetching offer provider from blockchain
+     */
+    getDisabledAfter(): Promise<number>;
+}
+export default Offer;

package/build/models/Offer.js

@@ -0,0 +1,273 @@
+"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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var logger_1 = __importDefault(require("../logger"));
+var Offers_json_1 = __importDefault(require("../contracts/Offers.json"));
+var store_1 = __importDefault(require("../store"));
+var utils_1 = require("../utils");
+var Offer_1 = require("../types/Offer");
+var Origins_1 = require("../types/Origins");
+var Superpro_1 = __importDefault(require("../staticModels/Superpro"));
+var TxManager_1 = __importDefault(require("../utils/TxManager"));
+var Offer = /** @class */ (function () {
+    function Offer(offerId) {
+        (0, utils_1.checkIfInitialized)();
+        this.id = offerId;
+        if (!Offer.contract) {
+            Offer.contract = new store_1.default.web3.eth.Contract(Offers_json_1.default.abi, Superpro_1.default.address);
+        }
+        this.logger = logger_1.default.child({ className: "Offer", offerId: this.id });
+    }
+    /**
+     * Checks if contract has been initialized, if not - initialize contract
+     */
+    Offer.prototype.checkInitOffer = function (transactionOptions) {
+        if (transactionOptions === null || transactionOptions === void 0 ? void 0 : transactionOptions.web3) {
+            (0, utils_1.checkIfInitialized)();
+            return new transactionOptions.web3.eth.Contract(Offers_json_1.default.abi, Superpro_1.default.address);
+        }
+    };
+    /**
+     * Function for fetching offer info from blockchain
+     */
+    Offer.prototype.getInfo = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, orderInfoParams;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, Offer.contract.methods.getValueOffer(this.id).call()];
+                    case 1:
+                        _a = _b.sent(), orderInfoParams = _a[2];
+                        return [2 /*return*/, (this.offerInfo = (0, utils_1.tupleToObject)(orderInfoParams, Offer_1.OfferInfoStructure))];
+                }
+            });
+        });
+    };
+    /**
+     * Function for fetching offer provider from blockchain (works for TEE and Value offers)
+     */
+    Offer.prototype.getProvider = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = this;
+                        return [4 /*yield*/, Offer.contract.methods.getOfferProviderAuthority(this.id).call()];
+                    case 1:
+                        _a.provider = _b.sent();
+                        return [2 /*return*/, this.provider];
+                }
+            });
+        });
+    };
+    /**
+     * Fetch offer type from blockchain (works for TEE and Value offers)
+     */
+    Offer.prototype.getOfferType = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = this;
+                        return [4 /*yield*/, Offer.contract.methods.getOfferType(this.id).call()];
+                    case 1:
+                        _a.type = _b.sent();
+                        return [2 /*return*/, this.type];
+                }
+            });
+        });
+    };
+    /**
+     * Function for fetching TEE offer provider authority account from blockchain
+     */
+    Offer.prototype.getProviderAuthority = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = this;
+                        return [4 /*yield*/, Offer.contract.methods.getOfferProviderAuthority(this.id).call()];
+                    case 1:
+                        _a.providerAuthority = _b.sent();
+                        return [2 /*return*/, this.providerAuthority];
+                }
+            });
+        });
+    };
+    /**
+     * Fetch new Origins (createdDate, createdBy, modifiedDate and modifiedBy)
+     */
+    Offer.prototype.getOrigins = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var origins;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, Offer.contract.methods.getOfferOrigins(this.id).call()];
+                    case 1:
+                        origins = _a.sent();
+                        // Converts blockchain array into object
+                        origins = (0, utils_1.tupleToObject)(origins, Origins_1.OriginsStructure);
+                        // Convert blockchain time seconds to js time milliseconds
+                        origins.createdDate = +origins.createdDate * 1000;
+                        origins.modifiedDate = +origins.modifiedDate * 1000;
+                        return [2 /*return*/, (this.origins = origins)];
+                }
+            });
+        });
+    };
+    /**
+     * Function for offer closing price calculation
+     */
+    Offer.prototype.getClosingPrice = function (startDate, orderPrice) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = this;
+                        return [4 /*yield*/, Offer.contract.methods.getOfferClosingPrice(this.id, startDate, orderPrice).call()];
+                    case 1:
+                        _a.closingPrice = _b.sent();
+                        return [2 /*return*/, this.closingPrice];
+                }
+            });
+        });
+    };
+    Offer.prototype.isOfferExists = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, Offer.contract.methods.isOfferExists(this.id).call()];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Function for disabling offer
+     * @param transactionOptions - object what contains alternative action account or gas limit (optional)
+     */
+    Offer.prototype.disable = function (transactionOptions) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        transactionOptions !== null && transactionOptions !== void 0 ? transactionOptions : this.checkInitOffer(transactionOptions);
+                        (0, utils_1.checkIfActionAccountInitialized)(transactionOptions);
+                        return [4 /*yield*/, TxManager_1.default.execute(Offer.contract.methods.disableOffer, [this.id], transactionOptions)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Function for enabling offer
+     * @param transactionOptions - object what contains alternative action account or gas limit (optional)
+     */
+    Offer.prototype.enable = function (transactionOptions) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        transactionOptions !== null && transactionOptions !== void 0 ? transactionOptions : this.checkInitOffer(transactionOptions);
+                        (0, utils_1.checkIfActionAccountInitialized)(transactionOptions);
+                        return [4 /*yield*/, TxManager_1.default.execute(Offer.contract.methods.enableOffer, [this.id], transactionOptions)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Checks if offer (offerAddress) match restrictions in this offer
+     * @param offerAddress - address of offer what needs to be checked
+     */
+    Offer.prototype.isRestrictionsPermitThatOffer = function (offerAddress) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, Offer.contract.methods.isOfferRestrictionsPermitOtherOffer(this.id, +offerAddress).call()];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Checks if this offer contains restrictions of a certain type
+     * @param type - address of offer what needs to be checked
+     */
+    Offer.prototype.isRestrictedByOfferType = function (type) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, Offer.contract.methods.isOfferRestrictedByOfferType(this.id, type).call()];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Function for fetching offer provider from blockchain
+     */
+    Offer.prototype.getDisabledAfter = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = this;
+                        return [4 /*yield*/, Offer.contract.methods.getOfferDisabledAfter(this.id).call()];
+                    case 1:
+                        _a.disabledAfter = +(_b.sent());
+                        return [2 /*return*/, this.disabledAfter];
+                }
+            });
+        });
+    };
+    return Offer;
+}());
+exports.default = Offer;

package/build/models/Order.d.ts

@@ -0,0 +1,125 @@
+import { OrderInfo, OrderResult, ExtendedOrderInfo, OrderStatus } from "../types/Order";
+import { TransactionOptions } from "../types/Web3";
+import { Origins } from "../types/Origins";
+import { SubOrderCreatedEvent } from "../types/Events";
+declare class Order {
+    private static contract;
+    private logger;
+    orderInfo?: OrderInfo;
+    orderResult?: OrderResult;
+    subOrders?: string[];
+    parentOrder?: string;
+    consumer?: string;
+    origins?: Origins;
+    startDate?: number;
+    id: string;
+    constructor(orderId: string);
+    /**
+     * Checks if contract has been initialized, if not - initialize contract
+     */
+    private checkInitOrder;
+    /**
+     * Check if order exist
+     */
+    isExist(): Promise<boolean>;
+    /**
+     * Function for fetching order info from blockchain
+     */
+    getOrderInfo(): Promise<OrderInfo>;
+    getConsumer(): Promise<string>;
+    /**
+     * Function for fetching order result from blockchain
+     */
+    getOrderResult(): Promise<OrderResult>;
+    /**
+     * Function for fetching sub orders from blockchain
+     */
+    getSubOrders(): Promise<string[]>;
+    /**
+     * Function for fetching parent order from blockchain
+     */
+    getParentOrder(): Promise<string>;
+    /**
+     * Function for fetching order deposit spent from blockchain
+     */
+    getDepositSpent(): Promise<string>;
+    /**
+     * Fetch new Origins (createdDate, createdBy, modifiedDate and modifiedBy)
+     */
+    getOrigins(): Promise<Origins>;
+    /**
+     * Function for fetching parent order from blockchain
+     */
+    getAwaitingPayment(): Promise<boolean>;
+    /**
+     * Function for fetching start of processing date
+     */
+    getStartDate(): Promise<number>;
+    /**
+     * Function for fetching parent order from blockchain
+     */
+    setAwaitingPayment(value: boolean, transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Updates order price
+     */
+    updateOrderPrice(price: string, transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Sets deposit spent
+     */
+    setDepositSpent(value: string, transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Function for updating status of contract
+     */
+    updateStatus(status: OrderStatus, price?: number, transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Function for updating status of contract
+     */
+    cancelOrder(transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Starts suspended order
+     */
+    start(transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Updates order result
+     */
+    updateOrderResult(encryptedResult?: string, transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Completes order
+     */
+    complete(status: OrderStatus, encryptedResult?: string, encryptedError?: string, // for SDK compatibility
+    transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Function for creating sub orders for current order
+     * @param subOrderInfo - order info for new subOrder
+     * @param blocking - is sub order blocking
+     * @param transactionOptions - object what contains alternative action account or gas limit (optional)
+     * @returns {Promise<void>} - Does not return address of created contract!
+     */
+    createSubOrder(subOrderInfo: OrderInfo, blocking: boolean, externalId?: string, holdSum?: string, transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Function for creating pack of sub orders (wokflow) for current order
+     * @param {Array<subOrderInfo>} - orders info for new subOrders
+     * @param transactionOptions - object what contains action account and web3 instance
+     * @returns {Promise<string[]>} - tx hashes
+     */
+    createSubOrders(subOrdersInfo: ExtendedOrderInfo[], transactionOptions: TransactionOptions): Promise<string[]>;
+    getSubOrder(consumer: string, externalId: string): Promise<SubOrderCreatedEvent>;
+    /**
+     * Function for withdrawing profit from order
+     * @param transactionOptions - object what contains alternative action account or gas limit (optional)
+     */
+    withdrawProfit(transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Function for withdrawing change from order
+     * @param transactionOptions - object what contains alternative action account or gas limit (optional)
+     */
+    withdrawChange(transactionOptions?: TransactionOptions): Promise<void>;
+    /**
+     * Function for adding event listeners to contract events
+     * @param callback - function for processing each order related with event
+     * @return unsubscribe - function unsubscribing from event
+     */
+    onOrderStatusUpdated(callback: onOrderStatusUpdatedCallback): () => void;
+}
+export declare type onOrderStatusUpdatedCallback = (status: OrderStatus) => void;
+export default Order;