@polymeshassociation/polymesh-sdk 14.0.0-beta.11

package/api/entities/Portfolio/index.js

@@ -0,0 +1,246 @@
+"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.Portfolio = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const lodash_1 = require("lodash");
+const internal_1 = require("../../../internal");
+const queries_1 = require("../../../middleware/queries");
+const types_1 = require("../../../types");
+const conversion_1 = require("../../../utils/conversion");
+const internal_2 = require("../../../utils/internal");
+const notExistsMessage = "The Portfolio doesn't exist or was removed by its owner";
+/**
+ * Represents a base Portfolio for a specific Identity in the Polymesh blockchain
+ */
+class Portfolio extends internal_1.Entity {
+    /**
+     * @hidden
+     */
+    constructor(identifiers, context) {
+        super(identifiers, context);
+        const { did, id } = identifiers;
+        this.owner = new internal_1.Identity({ did }, context);
+        this._id = id;
+        this.setCustodian = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.setCustodian, Object.assign(Object.assign({}, args), { did, id })] }, context);
+        this.moveFunds = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.moveFunds, Object.assign(Object.assign({}, args), { from: this })] }, context);
+        this.quitCustody = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: () => [internal_1.quitCustody, { portfolio: this }], voidArgs: true }, context);
+    }
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier) {
+        const { did, id } = identifier;
+        return typeof did === 'string' && (id === undefined || id instanceof bignumber_js_1.default);
+    }
+    /**
+     * Return whether an Identity is the Portfolio owner
+     *
+     * @param args.identity - defaults to the signing Identity
+     */
+    isOwnedBy(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { owner, context } = this;
+            const identity = yield (0, internal_2.getIdentity)(args === null || args === void 0 ? void 0 : args.identity, context);
+            return owner.isEqual(identity);
+        });
+    }
+    /**
+     * Return whether an Identity is the Portfolio custodian
+     *
+     * @param args.identity - optional, defaults to the signing Identity
+     */
+    isCustodiedBy(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context } = this;
+            const [portfolioCustodian, targetIdentity] = yield Promise.all([
+                this.getCustodian(),
+                (0, internal_2.getIdentity)(args === null || args === void 0 ? void 0 : args.identity, context),
+            ]);
+            return portfolioCustodian.isEqual(targetIdentity);
+        });
+    }
+    /**
+     * Retrieve the balances of all Assets in this Portfolio
+     *
+     * @param args.assets - array of Assets (or tickers) for which to fetch balances (optional, all balances are retrieved if not passed)
+     */
+    getAssetBalances(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { owner: { did }, _id: portfolioId, context: { polymeshApi: { query: { portfolio }, }, }, context, } = this;
+            const rawPortfolioId = (0, conversion_1.portfolioIdToMeshPortfolioId)({ did, number: portfolioId }, context);
+            const [exists, totalBalanceEntries, lockedBalanceEntries] = yield Promise.all([
+                this.exists(),
+                portfolio.portfolioAssetBalances.entries(rawPortfolioId),
+                portfolio.portfolioLockedAssets.entries(rawPortfolioId),
+            ]);
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: notExistsMessage,
+                });
+            }
+            const assetBalances = {};
+            totalBalanceEntries.forEach(([key, balance]) => {
+                const ticker = (0, conversion_1.tickerToString)(key.args[1]);
+                const total = (0, conversion_1.balanceToBigNumber)(balance);
+                assetBalances[ticker] = {
+                    asset: new internal_1.Asset({ ticker }, context),
+                    total,
+                    locked: new bignumber_js_1.default(0),
+                    free: total,
+                };
+            });
+            lockedBalanceEntries.forEach(([key, balance]) => {
+                const ticker = (0, conversion_1.tickerToString)(key.args[1]);
+                const locked = (0, conversion_1.balanceToBigNumber)(balance);
+                const tickerBalance = assetBalances[ticker];
+                /*
+                 * this avoids the edge case where an asset holder creates an instruction with a leg
+                 *   that transfers 0 tokens, while not holding any tokens. This causes the portfolio to list
+                 *   a locked balance of 0, while not listing any unlocked balance. This will be addressed by a
+                 *   chain update, but until then this is necessary
+                 */
+                if (!tickerBalance) {
+                    return;
+                }
+                tickerBalance.locked = locked;
+                tickerBalance.free = assetBalances[ticker].total.minus(locked);
+            });
+            const mask = args === null || args === void 0 ? void 0 : args.assets.map(asset => ({
+                total: new bignumber_js_1.default(0),
+                locked: new bignumber_js_1.default(0),
+                free: new bignumber_js_1.default(0),
+                asset: (0, internal_2.asAsset)(asset, context),
+            }));
+            if (mask) {
+                return mask.map(portfolioBalance => {
+                    var _a;
+                    const { asset: { ticker }, } = portfolioBalance;
+                    return (_a = assetBalances[ticker]) !== null && _a !== void 0 ? _a : portfolioBalance;
+                });
+            }
+            return (0, lodash_1.values)(assetBalances);
+        });
+    }
+    /**
+     * Retrieve the custodian Identity of this Portfolio
+     *
+     * @note if no custodian is set, the owner Identity is returned
+     */
+    getCustodian() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { owner, owner: { did }, _id: portfolioId, context: { polymeshApi: { query: { portfolio }, }, }, context, } = this;
+            const rawPortfolioId = (0, conversion_1.portfolioIdToMeshPortfolioId)({ did, number: portfolioId }, context);
+            const [portfolioCustodian, exists] = yield Promise.all([
+                portfolio.portfolioCustodian(rawPortfolioId),
+                this.exists(),
+            ]);
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: notExistsMessage,
+                });
+            }
+            try {
+                const rawIdentityId = portfolioCustodian.unwrap();
+                return new internal_1.Identity({ did: (0, conversion_1.identityIdToString)(rawIdentityId) }, context);
+            }
+            catch (_) {
+                return owner;
+            }
+        });
+    }
+    /**
+     * Retrieve a list of transactions where this portfolio was involved. Can be filtered using parameters
+     *
+     * @param filters.account - Account involved in the settlement
+     * @param filters.ticker - ticker involved in the transaction
+     * @param filters.size - page size
+     * @param filters.start - page offset
+     *
+     * @note supports pagination
+     * @note uses the middleware
+     */
+    getTransactionHistory(filters = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { system }, }, }, context, owner: { did }, _id: portfolioId, } = this;
+            const { account, ticker, size, start } = filters;
+            const settlementsPromise = context.queryMiddleware((0, queries_1.settlements)({
+                identityId: did,
+                portfolioNumber: portfolioId ? portfolioId.toString() : null,
+                addressFilter: account ? (0, conversion_1.addressToKey)(account, context) : undefined,
+                tickerFilter: ticker,
+                count: size === null || size === void 0 ? void 0 : size.toNumber(),
+                skip: start === null || start === void 0 ? void 0 : start.toNumber(),
+            }));
+            const [result, exists] = yield Promise.all([settlementsPromise, this.exists()]);
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: notExistsMessage,
+                });
+            }
+            const { data: { settlements: settlementsResult }, } = result;
+            /* eslint-disable @typescript-eslint/no-non-null-assertion */
+            const { items, totalCount } = settlementsResult;
+            const multiParams = [];
+            const data = [];
+            items.forEach(item => {
+                const { block_id: blockId, result: status, addresses, legs: settlementLegs } = item;
+                const blockNumber = new bignumber_js_1.default(blockId);
+                multiParams.push((0, conversion_1.bigNumberToU32)(blockNumber, context));
+                data.push({
+                    blockNumber,
+                    status,
+                    accounts: addresses.map(address => new internal_1.Account({ address: (0, conversion_1.keyToAddress)('0x' + address, context) }, context)),
+                    legs: settlementLegs.map(leg => {
+                        return {
+                            asset: new internal_1.Asset({ ticker: leg.ticker }, context),
+                            amount: new bignumber_js_1.default(leg.amount).shiftedBy(-6),
+                            direction: leg.direction,
+                            from: (0, conversion_1.middlewarePortfolioToPortfolio)(leg.from, context),
+                            to: (0, conversion_1.middlewarePortfolioToPortfolio)(leg.to, context),
+                        };
+                    }),
+                });
+            });
+            const count = new bignumber_js_1.default(totalCount);
+            /* eslint-enable @typescript-eslint/no-non-null-assertion */
+            const next = (0, internal_2.calculateNextKey)(count, size, start);
+            let hashes = [];
+            if (multiParams.length) {
+                hashes = yield system.blockHash.multi(multiParams);
+            }
+            return {
+                data: data.map((settlement, index) => (Object.assign(Object.assign({}, settlement), { blockHash: (0, conversion_1.hashToString)(hashes[index]) }))),
+                next,
+                count,
+            };
+        });
+    }
+    /**
+     * Return the Portfolio ID and owner DID
+     */
+    toHuman() {
+        const { _id: id, owner: { did }, } = this;
+        const result = {
+            did,
+        };
+        return id ? (0, internal_2.toHumanReadable)(Object.assign(Object.assign({}, result), { id })) : result;
+    }
+}
+exports.Portfolio = Portfolio;
+//# sourceMappingURL=index.js.map

package/api/entities/Portfolio/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/entities/Portfolio/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,gEAAqC;AACrC,mCAAgC;AAEhC,gDAaoB;AACpB,yDAAmD;AAEnD,0CAAuF;AAEvF,0DAU4B;AAC5B,sDAM0B;AAc1B,MAAM,gBAAgB,GAAG,yDAAyD,CAAC;AAEnF;;GAEG;AACH,MAAsB,SAAU,SAAQ,iBAAwC;IAqB9E;;OAEG;IACH,YAAmB,WAA8B,EAAE,OAAgB;QACjE,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE5B,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,WAAW,CAAC;QAEhC,IAAI,CAAC,KAAK,GAAG,IAAI,mBAAQ,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QAEd,IAAI,CAAC,YAAY,GAAG,IAAA,gCAAqB,EACvC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,uBAAY,kCAAO,IAAI,KAAE,GAAG,EAAE,EAAE,IAAG,EAAE,EACrE,OAAO,CACR,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,IAAA,gCAAqB,EACpC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,oBAAS,kCAAO,IAAI,KAAE,IAAI,EAAE,IAAI,IAAG,EAAE,EACrE,OAAO,CACR,CAAC;QACF,IAAI,CAAC,WAAW,GAAG,IAAA,gCAAqB,EACtC,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,sBAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EACjF,OAAO,CACR,CAAC;IACJ,CAAC;IA3CD;;;OAGG;IACI,MAAM,CAAU,mBAAmB,CAAC,UAAmB;QAC5D,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,UAA+B,CAAC;QAEpD,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,EAAE,KAAK,SAAS,IAAI,EAAE,YAAY,sBAAS,CAAC,CAAC;IAClF,CAAC;IAqCD;;;;OAIG;IACU,SAAS,CAAC,IAAsC;;YAC3D,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YAEhC,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAW,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAE5D,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;KAAA;IAED;;;;OAIG;IACU,aAAa,CAAC,IAAsC;;YAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YAEzB,MAAM,CAAC,kBAAkB,EAAE,cAAc,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAC7D,IAAI,CAAC,YAAY,EAAE;gBACnB,IAAA,sBAAW,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE,OAAO,CAAC;aACrC,CAAC,CAAC;YAEH,OAAO,kBAAkB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC;KAAA;IAED;;;;OAIG;IACU,gBAAgB,CAAC,IAE7B;;YACC,MAAM,EACJ,KAAK,EAAE,EAAE,GAAG,EAAE,EACd,GAAG,EAAE,WAAW,EAChB,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,SAAS,EAAE,GACrB,GACF,EACD,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,cAAc,GAAG,IAAA,yCAA4B,EAAC,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;YAC3F,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,oBAAoB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAC5E,IAAI,CAAC,MAAM,EAAE;gBACb,SAAS,CAAC,sBAAsB,CAAC,OAAO,CAAC,cAAc,CAAC;gBACxD,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,cAAc,CAAC;aACxD,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,gBAAgB;iBAC1B,CAAC,CAAC;aACJ;YAED,MAAM,aAAa,GAAqC,EAAE,CAAC;YAE3D,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,EAAE;gBAC7C,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC3C,MAAM,KAAK,GAAG,IAAA,+BAAkB,EAAC,OAAO,CAAC,CAAC;gBAE1C,aAAa,CAAC,MAAM,CAAC,GAAG;oBACtB,KAAK,EAAE,IAAI,gBAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC;oBACrC,KAAK;oBACL,MAAM,EAAE,IAAI,sBAAS,CAAC,CAAC,CAAC;oBACxB,IAAI,EAAE,KAAK;iBACZ,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,EAAE;gBAC9C,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC3C,MAAM,MAAM,GAAG,IAAA,+BAAkB,EAAC,OAAO,CAAC,CAAC;gBAE3C,MAAM,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;gBAE5C;;;;;mBAKG;gBACH,IAAI,CAAC,aAAa,EAAE;oBAClB,OAAO;iBACR;gBAED,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC;gBAC9B,aAAa,CAAC,IAAI,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;YAEH,MAAM,IAAI,GAAmC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACtE,KAAK,EAAE,IAAI,sBAAS,CAAC,CAAC,CAAC;gBACvB,MAAM,EAAE,IAAI,sBAAS,CAAC,CAAC,CAAC;gBACxB,IAAI,EAAE,IAAI,sBAAS,CAAC,CAAC,CAAC;gBACtB,KAAK,EAAE,IAAA,kBAAO,EAAC,KAAK,EAAE,OAAO,CAAC;aAC/B,CAAC,CAAC,CAAC;YAEJ,IAAI,IAAI,EAAE;gBACR,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE;;oBACjC,MAAM,EACJ,KAAK,EAAE,EAAE,MAAM,EAAE,GAClB,GAAG,gBAAgB,CAAC;oBAErB,OAAO,MAAA,aAAa,CAAC,MAAM,CAAC,mCAAI,gBAAgB,CAAC;gBACnD,CAAC,CAAC,CAAC;aACJ;YAED,OAAO,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC;QAC/B,CAAC;KAAA;IA8BD;;;;OAIG;IACU,YAAY;;YACvB,MAAM,EACJ,KAAK,EACL,KAAK,EAAE,EAAE,GAAG,EAAE,EACd,GAAG,EAAE,WAAW,EAChB,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,SAAS,EAAE,GACrB,GACF,EACD,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,cAAc,GAAG,IAAA,yCAA4B,EAAC,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;YAC3F,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACrD,SAAS,CAAC,kBAAkB,CAAC,cAAc,CAAC;gBAC5C,IAAI,CAAC,MAAM,EAAE;aACd,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,gBAAgB;iBAC1B,CAAC,CAAC;aACJ;YAED,IAAI;gBACF,MAAM,aAAa,GAAG,kBAAkB,CAAC,MAAM,EAAE,CAAC;gBAClD,OAAO,IAAI,mBAAQ,CAAC,EAAE,GAAG,EAAE,IAAA,+BAAkB,EAAC,aAAa,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;aAC1E;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,KAAK,CAAC;aACd;QACH,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACU,qBAAqB,CAChC,UAKI,EAAE;;YAEN,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,MAAM,EAAE,GAClB,GACF,EACD,OAAO,EACP,KAAK,EAAE,EAAE,GAAG,EAAE,EACd,GAAG,EAAE,WAAW,GACjB,GAAG,IAAI,CAAC;YAET,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;YAEjD,MAAM,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAChD,IAAA,qBAAW,EAAC;gBACV,UAAU,EAAE,GAAG;gBACf,eAAe,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI;gBAC5D,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC,IAAA,yBAAY,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;gBACnE,YAAY,EAAE,MAAM;gBACpB,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE;gBACvB,IAAI,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,EAAE;aACxB,CAAC,CACH,CAAC;YAEF,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,kBAAkB,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAEhF,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,gBAAgB;iBAC1B,CAAC,CAAC;aACJ;YAED,MAAM,EACJ,IAAI,EAAE,EAAE,WAAW,EAAE,iBAAiB,EAAE,GACzC,GAAG,MAAM,CAAC;YAEX,6DAA6D;YAC7D,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,iBAAkB,CAAC;YAEjD,MAAM,WAAW,GAAkB,EAAE,CAAC;YACtC,MAAM,IAAI,GAA4C,EAAE,CAAC;YAEzD,KAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBACpB,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAK,CAAC;gBAErF,MAAM,WAAW,GAAG,IAAI,sBAAS,CAAC,OAAO,CAAC,CAAC;gBAC3C,WAAW,CAAC,IAAI,CAAC,IAAA,2BAAc,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;gBACvD,IAAI,CAAC,IAAI,CAAC;oBACR,WAAW;oBACX,MAAM;oBACN,QAAQ,EAAE,SAAU,CAAC,GAAG,CACtB,OAAO,CAAC,EAAE,CAAC,IAAI,kBAAO,CAAC,EAAE,OAAO,EAAE,IAAA,yBAAY,EAAC,IAAI,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CACpF;oBACD,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;wBAC7B,OAAO;4BACL,KAAK,EAAE,IAAI,gBAAK,CAAC,EAAE,MAAM,EAAE,GAAI,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC;4BAClD,MAAM,EAAE,IAAI,sBAAS,CAAC,GAAI,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;4BAChD,SAAS,EAAE,GAAI,CAAC,SAAS;4BACzB,IAAI,EAAE,IAAA,2CAA8B,EAAC,GAAI,CAAC,IAAI,EAAE,OAAO,CAAC;4BACxD,EAAE,EAAE,IAAA,2CAA8B,EAAC,GAAI,CAAC,EAAE,EAAE,OAAO,CAAC;yBACrD,CAAC;oBACJ,CAAC,CAAC;iBACH,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,sBAAS,CAAC,UAAU,CAAC,CAAC;YACxC,4DAA4D;YAE5D,MAAM,IAAI,GAAG,IAAA,2BAAgB,EAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAElD,IAAI,MAAM,GAAW,EAAE,CAAC;YAExB,IAAI,WAAW,CAAC,MAAM,EAAE;gBACtB,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,KAAK,CAA2C,WAAW,CAAC,CAAC;aAC9F;YAED,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,CAAC,iCACjC,UAAU,KACb,SAAS,EAAE,IAAA,yBAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IACtC,CAAC;gBACH,IAAI;gBACJ,KAAK;aACN,CAAC;QACJ,CAAC;KAAA;IAED;;OAEG;IACI,OAAO;QACZ,MAAM,EACJ,GAAG,EAAE,EAAE,EACP,KAAK,EAAE,EAAE,GAAG,EAAE,GACf,GAAG,IAAI,CAAC;QAET,MAAM,MAAM,GAAG;YACb,GAAG;SACJ,CAAC;QAEF,OAAO,EAAE,CAAC,CAAC,CAAC,IAAA,0BAAe,kCAAM,MAAM,KAAE,EAAE,IAAG,CAAC,CAAC,CAAC,MAAM,CAAC;IAC1D,CAAC;CACF;AA7VD,8BA6VC"}

package/api/entities/Portfolio/types.d.ts

@@ -0,0 +1,21 @@
+import BigNumber from 'bignumber.js';
+import { Account, Asset } from "../../../internal";
+import { SettlementDirectionEnum as SettlementDirection, SettlementResultEnum as SettlementResult } from "../../../middleware/types";
+import { Balance, Leg } from "../../../types";
+export interface PortfolioBalance extends Balance {
+    asset: Asset;
+}
+export interface SettlementLeg extends Leg {
+    direction: SettlementDirection;
+}
+export interface HistoricSettlement {
+    blockNumber: BigNumber;
+    blockHash: string;
+    status: SettlementResult;
+    /**
+     * Array of Accounts that participated by affirming the settlement
+     */
+    accounts: Account[];
+    legs: SettlementLeg[];
+}
+//# sourceMappingURL=types.d.ts.map

package/api/entities/Portfolio/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Portfolio/types.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,0BAAmB;AAC5C,OAAO,EACL,uBAAuB,IAAI,mBAAmB,EAC9C,oBAAoB,IAAI,gBAAgB,EACzC,kCAA2B;AAC5B,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,uBAAgB;AAEvC,MAAM,WAAW,gBAAiB,SAAQ,OAAO;IAC/C,KAAK,EAAE,KAAK,CAAC;CACd;AAED,MAAM,WAAW,aAAc,SAAQ,GAAG;IACxC,SAAS,EAAE,mBAAmB,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,SAAS,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,gBAAgB,CAAC;IACzB;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,IAAI,EAAE,aAAa,EAAE,CAAC;CACvB"}

package/api/entities/Portfolio/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/api/entities/Portfolio/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/api/entities/Portfolio/types.ts"],"names":[],"mappings":""}

package/api/entities/Subsidy/index.d.ts

@@ -0,0 +1,80 @@
+import BigNumber from 'bignumber.js';
+import { Account, Context, DecreaseAllowanceParams, Entity, IncreaseAllowanceParams, SetAllowanceParams } from "../../../internal";
+import { NoArgsProcedureMethod, ProcedureMethod } from "../../../types";
+export interface UniqueIdentifiers {
+    /**
+     * beneficiary address
+     */
+    beneficiary: string;
+    /**
+     * subsidizer address
+     */
+    subsidizer: string;
+}
+declare type HumanReadable = UniqueIdentifiers;
+/**
+ * Represents a Subsidy relationship on chain
+ */
+export declare class Subsidy extends Entity<UniqueIdentifiers, HumanReadable> {
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier: unknown): identifier is UniqueIdentifiers;
+    /**
+     * Account whose transactions are being paid for
+     */
+    beneficiary: Account;
+    /**
+     * Account that is paying for the transactions
+     */
+    subsidizer: Account;
+    /**
+     * @hidden
+     */
+    constructor(identifiers: UniqueIdentifiers, context: Context);
+    /**
+     * Terminate this Subsidy relationship. The beneficiary Account will be forced to pay for their own transactions
+     *
+     * @note both the beneficiary and the subsidizer are allowed to unilaterally quit the Subsidy
+     */
+    quit: NoArgsProcedureMethod<void>;
+    /**
+     * Set allowance for this Subsidy relationship
+     *
+     * @note Only the subsidizer is allowed to set the allowance
+     *
+     * @throws if the allowance to set is equal to the current allowance
+     */
+    setAllowance: ProcedureMethod<Pick<SetAllowanceParams, 'allowance'>, void>;
+    /**
+     * Increase allowance for this Subsidy relationship
+     *
+     * @note Only the subsidizer is allowed to increase the allowance
+     */
+    increaseAllowance: ProcedureMethod<Pick<IncreaseAllowanceParams, 'allowance'>, void>;
+    /**
+     * Decrease allowance for this Subsidy relationship
+     *
+     * @note Only the subsidizer is allowed to decrease the allowance
+     *
+     * @throws if the amount to decrease by is more than the existing allowance
+     */
+    decreaseAllowance: ProcedureMethod<Pick<DecreaseAllowanceParams, 'allowance'>, void>;
+    /**
+     * Determine whether this Subsidy relationship exists on chain
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Get amount of POLYX subsidized for this Subsidy relationship
+     *
+     * @throws if the Subsidy does not exist
+     */
+    getAllowance(): Promise<BigNumber>;
+    /**
+     * Return the Subsidy's static data
+     */
+    toHuman(): HumanReadable;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/api/entities/Subsidy/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Subsidy/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EACL,OAAO,EACP,OAAO,EACP,uBAAuB,EACvB,MAAM,EACN,uBAAuB,EAKvB,kBAAkB,EACnB,0BAAmB;AACpB,OAAO,EAAa,qBAAqB,EAAE,eAAe,EAAE,uBAAgB;AAI5E,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,aAAK,aAAa,GAAG,iBAAiB,CAAC;AAEvC;;GAEG;AACH,qBAAa,OAAQ,SAAQ,MAAM,CAAC,iBAAiB,EAAE,aAAa,CAAC;IACnE;;;OAGG;WACoB,mBAAmB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI,iBAAiB;IAMhG;;OAEG;IACI,WAAW,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACI,UAAU,EAAE,OAAO,CAAC;IAE3B;;OAEG;gBACgB,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,OAAO;IAoEnE;;;;OAIG;IACI,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;OAMG;IACI,YAAY,EAAE,eAAe,CAAC,IAAI,CAAC,kBAAkB,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC;IAElF;;;;OAIG;IACI,iBAAiB,EAAE,eAAe,CAAC,IAAI,CAAC,uBAAuB,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC;IAE5F;;;;;;OAMG;IACI,iBAAiB,EAAE,eAAe,CAAC,IAAI,CAAC,uBAAuB,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC;IAE5F;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAcvC;;;;OAIG;IACU,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;IAmB/C;;OAEG;IACI,OAAO,IAAI,aAAa;CAQhC"}

package/api/entities/Subsidy/index.js

@@ -0,0 +1,97 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subsidy = void 0;
+const internal_1 = require("../../../internal");
+const types_1 = require("../../../types");
+const internal_2 = require("../../../types/internal");
+const internal_3 = require("../../../utils/internal");
+/**
+ * Represents a Subsidy relationship on chain
+ */
+class Subsidy extends internal_1.Entity {
+    /**
+     * @hidden
+     */
+    constructor(identifiers, context) {
+        const { beneficiary, subsidizer } = identifiers;
+        super(identifiers, context);
+        this.beneficiary = new internal_1.Account({ address: beneficiary }, context);
+        this.subsidizer = new internal_1.Account({ address: subsidizer }, context);
+        this.quit = (0, internal_3.createProcedureMethod)({ getProcedureAndArgs: () => [internal_1.quitSubsidy, { subsidy: this }], voidArgs: true }, context);
+        this.setAllowance = (0, internal_3.createProcedureMethod)({
+            getProcedureAndArgs: args => [
+                internal_1.modifyAllowance,
+                Object.assign(Object.assign({}, args), { subsidy: this, operation: internal_2.AllowanceOperation.Set }),
+            ],
+        }, context);
+        this.increaseAllowance = (0, internal_3.createProcedureMethod)({
+            getProcedureAndArgs: args => [
+                internal_1.modifyAllowance,
+                Object.assign(Object.assign({}, args), { subsidy: this, operation: internal_2.AllowanceOperation.Increase }),
+            ],
+        }, context);
+        this.decreaseAllowance = (0, internal_3.createProcedureMethod)({
+            getProcedureAndArgs: args => [
+                internal_1.modifyAllowance,
+                Object.assign(Object.assign({}, args), { subsidy: this, operation: internal_2.AllowanceOperation.Decrease }),
+            ],
+        }, context);
+    }
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier) {
+        const { beneficiary, subsidizer } = identifier;
+        return typeof beneficiary === 'string' && typeof subsidizer === 'string';
+    }
+    /**
+     * Determine whether this Subsidy relationship exists on chain
+     */
+    exists() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { beneficiary: { address: beneficiaryAddress }, subsidizer, context, } = this;
+            const subsidyWithAllowance = yield context.accountSubsidy(beneficiaryAddress);
+            return (subsidyWithAllowance !== null && subsidyWithAllowance.subsidy.subsidizer.isEqual(subsidizer));
+        });
+    }
+    /**
+     * Get amount of POLYX subsidized for this Subsidy relationship
+     *
+     * @throws if the Subsidy does not exist
+     */
+    getAllowance() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { beneficiary: { address: beneficiaryAddress }, subsidizer, context, } = this;
+            const subsidyWithAllowance = yield context.accountSubsidy(beneficiaryAddress);
+            if (!subsidyWithAllowance || !subsidyWithAllowance.subsidy.subsidizer.isEqual(subsidizer)) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: 'The Subsidy no longer exists',
+                });
+            }
+            return subsidyWithAllowance.allowance;
+        });
+    }
+    /**
+     * Return the Subsidy's static data
+     */
+    toHuman() {
+        const { beneficiary, subsidizer } = this;
+        return (0, internal_3.toHumanReadable)({
+            beneficiary,
+            subsidizer,
+        });
+    }
+}
+exports.Subsidy = Subsidy;
+//# sourceMappingURL=index.js.map

package/api/entities/Subsidy/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/entities/Subsidy/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,gDAWoB;AACpB,0CAA4E;AAC5E,sDAAsD;AACtD,sDAA0E;AAe1E;;GAEG;AACH,MAAa,OAAQ,SAAQ,iBAAwC;IAoBnE;;OAEG;IACH,YAAmB,WAA8B,EAAE,OAAgB;QACjE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;QAEhD,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE5B,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAO,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;QAClE,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAO,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;QAEhE,IAAI,CAAC,IAAI,GAAG,IAAA,gCAAqB,EAC/B,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,sBAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EAC/E,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG,IAAA,gCAAqB,EAKvC;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,0BAAe;gBACf,gCACK,IAAI,KACP,OAAO,EAAE,IAAI,EACb,SAAS,EAAE,6BAAkB,CAAC,GAAG,GACT;aAC3B;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,iBAAiB,GAAG,IAAA,gCAAqB,EAK5C;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,0BAAe;gBACf,gCACK,IAAI,KACP,OAAO,EAAE,IAAI,EACb,SAAS,EAAE,6BAAkB,CAAC,QAAQ,GACd;aAC3B;SACF,EACD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,iBAAiB,GAAG,IAAA,gCAAqB,EAK5C;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3B,0BAAe;gBACf,gCACK,IAAI,KACP,OAAO,EAAE,IAAI,EACb,SAAS,EAAE,6BAAkB,CAAC,QAAQ,GACd;aAC3B;SACF,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAxFD;;;OAGG;IACI,MAAM,CAAU,mBAAmB,CAAC,UAAmB;QAC5D,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,UAA+B,CAAC;QAEpE,OAAO,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,UAAU,KAAK,QAAQ,CAAC;IAC3E,CAAC;IAkHD;;OAEG;IACU,MAAM;;YACjB,MAAM,EACJ,WAAW,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,EAC5C,UAAU,EACV,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;YAE9E,OAAO,CACL,oBAAoB,KAAK,IAAI,IAAI,oBAAoB,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAC7F,CAAC;QACJ,CAAC;KAAA;IAED;;;;OAIG;IACU,YAAY;;YACvB,MAAM,EACJ,WAAW,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,EAC5C,UAAU,EACV,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;YAE9E,IAAI,CAAC,oBAAoB,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;gBACzF,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,8BAA8B;iBACxC,CAAC,CAAC;aACJ;YAED,OAAO,oBAAoB,CAAC,SAAS,CAAC;QACxC,CAAC;KAAA;IAED;;OAEG;IACI,OAAO;QACZ,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAEzC,OAAO,IAAA,0BAAe,EAAC;YACrB,WAAW;YACX,UAAU;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA/KD,0BA+KC"}

package/api/entities/Subsidy/types.d.ts

@@ -0,0 +1,21 @@
+import BigNumber from 'bignumber.js';
+import { Account, Subsidy } from "../../../internal";
+export interface SubsidyData {
+    /**
+     * Account whose transactions are being paid for
+     */
+    beneficiary: Account;
+    /**
+     * Account that is paying for the transactions
+     */
+    subsidizer: Account;
+    /**
+     * amount of POLYX to be subsidized. This can be increased/decreased later on
+     */
+    allowance: BigNumber;
+}
+export interface SubsidyWithAllowance {
+    subsidy: Subsidy;
+    allowance: BigNumber;
+}
+//# sourceMappingURL=types.d.ts.map

package/api/entities/Subsidy/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Subsidy/types.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,0BAAmB;AAE9C,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;CACtB"}

package/api/entities/Subsidy/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/api/entities/Subsidy/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/api/entities/Subsidy/types.ts"],"names":[],"mappings":""}

package/api/entities/TickerReservation/index.d.ts

@@ -0,0 +1,72 @@
+import { Asset, AuthorizationRequest, Context, CreateAssetParams, Entity, TransferTickerOwnershipParams } from "../../../internal";
+import { NoArgsProcedureMethod, ProcedureMethod, SubCallback, UnsubCallback } from "../../../types";
+import { TickerReservationDetails } from './types';
+/**
+ * Properties that uniquely identify a TickerReservation
+ */
+export interface UniqueIdentifiers {
+    ticker: string;
+}
+/**
+ * Represents a reserved Asset symbol in the Polymesh blockchain. Ticker reservations expire
+ *   after a set length of time, after which they can be reserved by another Identity.
+ *   A Ticker must be previously reserved by an Identity for that Identity to be able create an Asset with it
+ */
+export declare class TickerReservation extends Entity<UniqueIdentifiers, string> {
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier: unknown): identifier is UniqueIdentifiers;
+    /**
+     * reserved ticker
+     */
+    ticker: string;
+    /**
+     * @hidden
+     */
+    constructor(identifiers: UniqueIdentifiers, context: Context);
+    /**
+     * Retrieve the Reservation's owner, expiry date and status
+     *
+     * @note can be subscribed to
+     */
+    details(): Promise<TickerReservationDetails>;
+    details(callback: SubCallback<TickerReservationDetails>): Promise<UnsubCallback>;
+    /**
+     * Extend the Reservation time period of the ticker for 60 days from now
+     * to later use it in the creation of an Asset.
+     *
+     * @note required role:
+     *   - Ticker Owner
+     */
+    extend: NoArgsProcedureMethod<TickerReservation>;
+    /**
+     * Create an Asset using the reserved ticker
+     *
+     * @note required role:
+     *   - Ticker Owner
+     */
+    createAsset: ProcedureMethod<CreateAssetParams, Asset>;
+    /**
+     * Transfer ownership of the Ticker Reservation to another Identity. This generates an authorization request that must be accepted
+     *   by the target
+     *
+     * @note this will create {@link AuthorizationRequest | Authorization Request} which has to be accepted by the `target` Identity.
+     *   An {@link Account} or {@link Identity} can fetch its pending Authorization Requests by calling {@link Authorizations.getReceived | authorizations.getReceived}.
+     *   Also, an Account or Identity can directly fetch the details of an Authorization Request by calling {@link Authorizations.getOne | authorizations.getOne}
+     *
+     * @note required role:
+     *   - Ticker Owner
+     */
+    transferOwnership: ProcedureMethod<TransferTickerOwnershipParams, AuthorizationRequest>;
+    /**
+     * Determine whether this Ticker Reservation exists on chain
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Return the Reservation's ticker
+     */
+    toHuman(): string;
+}
+//# sourceMappingURL=index.d.ts.map

package/api/entities/TickerReservation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/TickerReservation/index.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,EACL,oBAAoB,EACpB,OAAO,EAEP,iBAAiB,EACjB,MAAM,EAIN,6BAA6B,EAC9B,0BAAmB;AACpB,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,WAAW,EAAE,aAAa,EAAE,uBAAgB;AAK7F,OAAO,EAAE,wBAAwB,EAA2B,MAAM,SAAS,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACtE;;;OAGG;WACoB,mBAAmB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI,iBAAiB;IAMhG;;OAEG;IACI,MAAM,EAAE,MAAM,CAAC;IAEtB;;OAEG;gBACS,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,OAAO;IA8B5D;;;;OAIG;IACI,OAAO,IAAI,OAAO,CAAC,wBAAwB,CAAC;IAC5C,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IAiFvF;;;;;;OAMG;IACI,MAAM,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;IAExD;;;;;OAKG;IACI,WAAW,EAAE,eAAe,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;IAE9D;;;;;;;;;;OAUG;IACI,iBAAiB,EAAE,eAAe,CAAC,6BAA6B,EAAE,oBAAoB,CAAC,CAAC;IAE/F;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAUvC;;OAEG;IACI,OAAO,IAAI,MAAM;CAGzB"}