@polymeshassociation/polymesh-sdk 23.0.0-alpha.3 → 23.0.0-alpha.31

package/api/entities/Asset/Fungible/index.js

@@ -0,0 +1,159 @@
+"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.FungibleAsset = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const lodash_1 = require("lodash");
+const Base_1 = require("../Base");
+const internal_1 = require("../../../../internal");
+const queries_1 = require("../../../../middleware/queries");
+const conversion_1 = require("../../../../utils/conversion");
+const internal_2 = require("../../../../utils/internal");
+const Settlements_1 = require("../Base/Settlements");
+const AssetHolders_1 = require("./AssetHolders");
+const Checkpoints_1 = require("./Checkpoints");
+const CorporateActions_1 = require("./CorporateActions");
+const Issuance_1 = require("./Issuance");
+const Offerings_1 = require("./Offerings");
+const TransferRestrictions_1 = require("./TransferRestrictions");
+/**
+ * Class used to manage all Fungible Asset functionality
+ */
+class FungibleAsset extends Base_1.BaseAsset {
+    /**
+     * @hidden
+     */
+    constructor(identifiers, context) {
+        super(identifiers, context);
+        const { ticker } = identifiers;
+        this.ticker = ticker;
+        this.did = (0, conversion_1.tickerToDid)(ticker);
+        this.settlements = new Settlements_1.FungibleSettlements(this, context);
+        this.assetHolders = new AssetHolders_1.AssetHolders(this, context);
+        this.issuance = new Issuance_1.Issuance(this, context);
+        this.transferRestrictions = new TransferRestrictions_1.TransferRestrictions(this, context);
+        this.offerings = new Offerings_1.Offerings(this, context);
+        this.checkpoints = new Checkpoints_1.Checkpoints(this, context);
+        this.corporateActions = new CorporateActions_1.CorporateActions(this, context);
+        this.modify = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.modifyAsset, Object.assign({ ticker }, args)] }, context);
+        this.redeem = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.redeemTokens, Object.assign({ ticker }, args)] }, context);
+        this.controllerTransfer = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.controllerTransfer, Object.assign({ ticker }, args)] }, context);
+        this.setVenueFiltering = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.setVenueFiltering, Object.assign({ ticker }, args)] }, context);
+    }
+    // eslint-disable-next-line require-jsdoc
+    currentFundingRound(callback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { asset }, }, }, ticker, context, } = this;
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const assembleResult = (roundName) => (0, conversion_1.bytesToString)(roundName) || null;
+            if (callback) {
+                return asset.fundingRound(rawTicker, round => {
+                    // eslint-disable-next-line @typescript-eslint/no-floating-promises -- callback errors should be handled by the caller
+                    callback(assembleResult(round));
+                });
+            }
+            const fundingRound = yield asset.fundingRound(rawTicker);
+            return assembleResult(fundingRound);
+        });
+    }
+    /**
+     * Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created
+     *
+     * @note uses the middlewareV2
+     * @note there is a possibility that the data is not ready by the time it is requested. In that case, `null` is returned
+     */
+    createdAt() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { ticker, context } = this;
+            const { data: { assets: { nodes: [asset], }, }, } = yield context.queryMiddleware((0, queries_1.assetQuery)({
+                ticker,
+            }));
+            return (0, internal_2.optionize)(conversion_1.middlewareEventDetailsToEventIdentifier)(asset === null || asset === void 0 ? void 0 : asset.createdBlock, asset === null || asset === void 0 ? void 0 : asset.eventIdx);
+        });
+    }
+    /**
+     * Retrieve the amount of unique investors that hold this Asset
+     */
+    investorCount() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query: { asset: { balanceOf }, }, }, }, context, ticker, } = this;
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const balanceEntries = yield balanceOf.entries(rawTicker);
+            const assetBalances = balanceEntries.filter(([, balance]) => !(0, conversion_1.balanceToBigNumber)(balance).isZero());
+            return new bignumber_js_1.default(assetBalances.length);
+        });
+    }
+    /**
+     * Retrieve this Asset's Operation History
+     *
+     * @note Operations are grouped by the agent Identity who performed them
+     *
+     * @note uses the middlewareV2
+     */
+    getOperationHistory() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, ticker: assetId } = this;
+            const { data: { tickerExternalAgentHistories: { nodes }, }, } = yield context.queryMiddleware((0, queries_1.tickerExternalAgentHistoryQuery)({
+                assetId,
+            }));
+            const groupedData = (0, lodash_1.groupBy)(nodes, 'identityId');
+            return (0, lodash_1.map)(groupedData, (history, did) => ({
+                identity: new internal_1.Identity({ did }, context),
+                history: history.map(({ createdBlock, eventIdx }) => 
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                (0, conversion_1.middlewareEventDetailsToEventIdentifier)(createdBlock, eventIdx)),
+            }));
+        });
+    }
+    /**
+     * Retrieve this Asset's transaction History
+     *
+     * @note uses the middlewareV2
+     */
+    getTransactionHistory(opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, ticker } = this;
+            const { size, start } = opts;
+            const { data: { assetTransactions: { nodes, totalCount }, }, } = yield context.queryMiddleware((0, queries_1.assetTransactionQuery)({
+                assetId: ticker,
+            }, size, start));
+            const data = nodes.map(({ assetId, amount, fromPortfolio, toPortfolio, createdBlock, eventId, eventIdx, extrinsicIdx, }) => (Object.assign({ asset: new FungibleAsset({ ticker: assetId }, context), amount: new bignumber_js_1.default(amount).shiftedBy(-6), event: eventId, from: (0, internal_2.optionize)(conversion_1.middlewarePortfolioToPortfolio)(fromPortfolio, context), to: (0, internal_2.optionize)(conversion_1.middlewarePortfolioToPortfolio)(toPortfolio, context), 
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                extrinsicIndex: new bignumber_js_1.default(extrinsicIdx) }, (0, conversion_1.middlewareEventDetailsToEventIdentifier)(createdBlock, eventIdx))));
+            const count = new bignumber_js_1.default(totalCount);
+            const next = (0, internal_2.calculateNextKey)(count, data.length, start);
+            return {
+                data,
+                next,
+                count,
+            };
+        });
+    }
+    /**
+     * Determine whether this FungibleAsset exists on chain
+     */
+    exists() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { ticker, context, context: { polymeshApi: { query }, }, } = this;
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const [tokenSize, nftId] = yield Promise.all([
+                query.asset.tokens.size(rawTicker),
+                query.nft.collectionTicker(rawTicker),
+            ]);
+            return !tokenSize.isZero() && nftId.isZero();
+        });
+    }
+}
+exports.FungibleAsset = FungibleAsset;
+//# sourceMappingURL=index.js.map

package/api/entities/Asset/Fungible/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/Fungible/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,gEAAqC;AACrC,mCAAsC;AAEtC,kCAAsD;AACtD,mDAOoB;AACpB,4DAI8B;AAgB9B,6DAO4B;AAC5B,yDAAsF;AAEtF,qDAA0D;AAE1D,iDAA8C;AAC9C,+CAA4C;AAC5C,yDAAsD;AACtD,yCAAsC;AACtC,2CAAwC;AACxC,iEAA8D;AAE9D;;GAEG;AACH,MAAa,aAAc,SAAQ,gBAAS;IAS1C;;OAEG;IACH,YAAY,WAA8B,EAAE,OAAgB;QAC1D,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE5B,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;QAE/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,IAAA,wBAAW,EAAC,MAAM,CAAC,CAAC;QAE/B,IAAI,CAAC,WAAW,GAAG,IAAI,iCAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,YAAY,GAAG,IAAI,2BAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,oBAAoB,GAAG,IAAI,2CAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpE,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,gBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE5D,IAAI,CAAC,MAAM,GAAG,IAAA,gCAAqB,EACjC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,sBAAW,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EACnE,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,IAAA,gCAAqB,EACjC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,uBAAY,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EACpE,OAAO,CACR,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,IAAA,gCAAqB,EAC7C,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,6BAAkB,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EAC1E,OAAO,CACR,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG,IAAA,gCAAqB,EAC5C,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,4BAAiB,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EACzE,OAAO,CACR,CAAC;IACJ,CAAC;IAiBD,yCAAyC;IAC5B,mBAAmB,CAC9B,QAAqC;;YAErC,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EAAE,KAAK,EAAE,GACjB,GACF,EACD,MAAM,EACN,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAElD,MAAM,cAAc,GAAG,CAAC,SAAgB,EAAiB,EAAE,CAAC,IAAA,0BAAa,EAAC,SAAS,CAAC,IAAI,IAAI,CAAC;YAE7F,IAAI,QAAQ,EAAE;gBACZ,OAAO,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE;oBAC3C,sHAAsH;oBACtH,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;gBAClC,CAAC,CAAC,CAAC;aACJ;YAED,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YACzD,OAAO,cAAc,CAAC,YAAY,CAAC,CAAC;QACtC,CAAC;KAAA;IAED;;;;;OAKG;IACU,SAAS;;YACpB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YAEjC,MAAM,EACJ,IAAI,EAAE,EACJ,MAAM,EAAE,EACN,KAAK,EAAE,CAAC,KAAK,CAAC,GACf,GACF,GACF,GAAG,MAAM,OAAO,CAAC,eAAe,CAC/B,IAAA,oBAAU,EAAC;gBACT,MAAM;aACP,CAAC,CACH,CAAC;YAEF,OAAO,IAAA,oBAAS,EAAC,oDAAuC,CAAC,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,CAAC,CAAC;QAClG,CAAC;KAAA;IASD;;OAEG;IACU,aAAa;;YACxB,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EACX,KAAK,EAAE,EACL,KAAK,EAAE,EAAE,SAAS,EAAE,GACrB,GACF,GACF,EACD,OAAO,EACP,MAAM,GACP,GAAG,IAAI,CAAC;YAET,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAElD,MAAM,cAAc,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAE1D,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,CACzC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,IAAA,+BAAkB,EAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CACvD,CAAC;YAEF,OAAO,IAAI,sBAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;KAAA;IAOD;;;;;;OAMG;IACU,mBAAmB;;YAC9B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YAE1C,MAAM,EACJ,IAAI,EAAE,EACJ,4BAA4B,EAAE,EAAE,KAAK,EAAE,GACxC,GACF,GAAG,MAAM,OAAO,CAAC,eAAe,CAC/B,IAAA,yCAA+B,EAAC;gBAC9B,OAAO;aACR,CAAC,CACH,CAAC;YAEF,MAAM,WAAW,GAAG,IAAA,gBAAO,EAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YAEjD,OAAO,IAAA,YAAG,EAAC,WAAW,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;gBACzC,QAAQ,EAAE,IAAI,mBAAQ,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC;gBACxC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE;gBAClD,oEAAoE;gBACpE,IAAA,oDAAuC,EAAC,YAAa,EAAE,QAAQ,CAAC,CACjE;aACF,CAAC,CAAC,CAAC;QACN,CAAC;KAAA;IAED;;;;OAIG;IACU,qBAAqB,CAAC,IAGlC;;YACC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;YACjC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;YAE7B,MAAM,EACJ,IAAI,EAAE,EACJ,iBAAiB,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,GACzC,GACF,GAAG,MAAM,OAAO,CAAC,eAAe,CAC/B,IAAA,+BAAqB,EACnB;gBACE,OAAO,EAAE,MAAM;aAChB,EACD,IAAI,EACJ,KAAK,CACN,CACF,CAAC;YAEF,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CACpB,CAAC,EACC,OAAO,EACP,MAAM,EACN,aAAa,EACb,WAAW,EACX,YAAY,EACZ,OAAO,EACP,QAAQ,EACR,YAAY,GACb,EAAE,EAAE,CAAC,iBACJ,KAAK,EAAE,IAAI,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EACtD,MAAM,EAAE,IAAI,sBAAS,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAC3C,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,IAAA,oBAAS,EAAC,2CAA8B,CAAC,CAAC,aAAa,EAAE,OAAO,CAAC,EACvE,EAAE,EAAE,IAAA,oBAAS,EAAC,2CAA8B,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC;gBACnE,oEAAoE;gBACpE,cAAc,EAAE,IAAI,sBAAS,CAAC,YAAa,CAAC,IAEzC,IAAA,oDAAuC,EAAC,YAAa,EAAE,QAAQ,CAAC,EACnE,CACH,CAAC;YAEF,MAAM,KAAK,GAAG,IAAI,sBAAS,CAAC,UAAU,CAAC,CAAC;YACxC,MAAM,IAAI,GAAG,IAAA,2BAAgB,EAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAEzD,OAAO;gBACL,IAAI;gBACJ,IAAI;gBACJ,KAAK;aACN,CAAC;QACJ,CAAC;KAAA;IAED;;OAEG;IACmB,MAAM;;YAC1B,MAAM,EACJ,MAAM,EACN,OAAO,EACP,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,GACF,GAAG,IAAI,CAAC;YACT,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAElD,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAC3C,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;gBAClC,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,SAAS,CAAC;aACtC,CAAC,CAAC;YAEH,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QAC/C,CAAC;KAAA;CAMF;AA7QD,sCA6QC"}

package/api/entities/Asset/NonFungible/Nft.d.ts

@@ -0,0 +1,110 @@
+import BigNumber from 'bignumber.js';
+import { Context, Entity, NftCollection } from "../../../../internal";
+import { NftMetadata, OptionalArgsProcedureMethod, RedeemNftParams } from "../../../../types";
+export declare type NftUniqueIdentifiers = {
+    ticker: string;
+    id: BigNumber;
+};
+export interface HumanReadable {
+    id: string;
+    collection: string;
+}
+/**
+ * Class used to manage Nft functionality. Each NFT belongs to an NftCollection, which specifies the expected metadata values for each NFT
+ */
+export declare class Nft extends Entity<NftUniqueIdentifiers, HumanReadable> {
+    id: BigNumber;
+    /**
+     * The {@link api/entities/Asset/NonFungible/NftCollection | NftCollection} this NFT belongs to
+     */
+    collection: NftCollection;
+    /**
+     * Redeem (or "burns") the NFT, removing it from circulation
+     */
+    redeem: OptionalArgsProcedureMethod<RedeemNftParams, void>;
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier: unknown): identifier is NftUniqueIdentifiers;
+    /**
+     * @hidden
+     */
+    constructor(identifiers: NftUniqueIdentifiers, context: Context);
+    /**
+     * Get metadata associated with this token
+     */
+    getMetadata(): Promise<NftMetadata[]>;
+    /**
+     * Determine if the NFT exists on chain
+     *
+     * @note This method returns true, even if the token has been redeemed/burned
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Get the conventional image URI for the NFT
+     *
+     * This function will check for a token level value and a collection level value. Token level values take precedence over base values in case of a conflict.
+     *
+     * When creating a collection an issuer can either require per token images by specifying global metadata key `imageUri` as a collection key or by
+     * setting a collection base image URL by setting a value on the collection corresponding to the global metadata key `baseImageUri`.
+     *
+     * This method will return `null` if the NFT issuer did not configure the collection according to the convention.
+     *
+     * Per token URIs provide the most flexibility, but require more chain space to store, increasing the POLYX fee to issue each token.
+     *
+     * The URI values can include `{tokenId}` that will be replaced with the NFTs ID. If a base URI does not specify this the ID will be appended onto the URL. Examples:
+     *  - `https://example.com/nfts/{tokenId}/image.png` becomes `https://example.com/nfts/1/image.png`
+     *  - `https://example.com/nfts` becomes `https://example.com/nfts/1` if used a base value, but remain unchanged as a local value
+     */
+    getImageUri(): Promise<string | null>;
+    /**
+     * Get the conventional token URI for the NFT
+     *
+     * This function will check for a token level value and a collection level value. Token level values take precedence over base values in case of a conflict.
+     *
+     * When creating a collection an issuer can either require per token URL by specifying global metadata key `tokenURI` as a collection key or by
+     * setting a collection base URL by setting a value on the collection corresponding to the global metadata key `baseTokenUri` on the collection.
+     *
+     * This method will return `null` if the NFT issuer did not configure the collection according to the convention.
+     *
+     * Per token URIs provide the most flexibility, but require more chain space to store, increasing the POLYX fee to issue each token.
+     *
+     * The URI values can include `{tokenId}` that will be replaced with the NFTs ID. If a base URI does not specify this the ID will be appended onto the URL. Examples:
+     *  - `https://example.com/nfts/{tokenId}/info.json` becomes `https://example.com/nfts/1/info.json`
+     *  - `https://example.com/nfts` becomes `https://example.com/nfts/1` if used a base value, but remain unchanged as a local value
+     */
+    getTokenUri(): Promise<string | null>;
+    /**
+     * @hidden
+     */
+    toHuman(): HumanReadable;
+    /**
+     * given a global metadata ID fetches a local URI value
+     *
+     * @hidden
+     */
+    private getLocalUri;
+    /**
+     *
+     * given a global metadata ID fetches a base URI value
+     *
+     * @hidden
+     */
+    private getBaseUri;
+    /**
+     * @hidden
+     */
+    private templateId;
+    /**
+     * @hidden
+     */
+    private templateBaseUri;
+    /**
+     * helper to lookup global metadata ID by name
+     *
+     * @hidden
+     */
+    private getGlobalMetadataId;
+}
+//# sourceMappingURL=Nft.d.ts.map

package/api/entities/Asset/NonFungible/Nft.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Nft.d.ts","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/NonFungible/Nft.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAa,6BAAmB;AACvE,OAAO,EAAE,WAAW,EAAE,2BAA2B,EAAE,eAAe,EAAE,0BAAgB;AAgBpF,oBAAY,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,SAAS,CAAC;CACf,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,GAAI,SAAQ,MAAM,CAAC,oBAAoB,EAAE,aAAa,CAAC;IAC3D,EAAE,EAAE,SAAS,CAAC;IAErB;;OAEG;IACI,UAAU,EAAE,aAAa,CAAC;IAEjC;;OAEG;IACI,MAAM,EAAE,2BAA2B,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAElE;;;OAGG;WACoB,mBAAmB,CACxC,UAAU,EAAE,OAAO,GAClB,UAAU,IAAI,oBAAoB;IAMrC;;OAEG;gBACS,WAAW,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO;IAe/D;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IA0BlD;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAmBvC;;;;;;;;;;;;;;;OAeG;IACU,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAoBlD;;;;;;;;;;;;;;;OAeG;IACU,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAoBlD;;OAEG;IACI,OAAO,IAAI,aAAa;IAY/B;;;;OAIG;YACW,WAAW;IA+BzB;;;;;OAKG;YACW,UAAU;IAyBxB;;OAEG;IACH,OAAO,CAAC,UAAU;IAMlB;;OAEG;IACH,OAAO,CAAC,eAAe;IAcvB;;;;OAIG;YACW,mBAAmB;CAclC"}

package/api/entities/Asset/NonFungible/Nft.js

@@ -0,0 +1,243 @@
+"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.Nft = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const internal_1 = require("../../../../internal");
+const constants_1 = require("../../../../utils/constants");
+const conversion_1 = require("../../../../utils/conversion");
+const internal_2 = require("../../../../utils/internal");
+/**
+ * Class used to manage Nft functionality. Each NFT belongs to an NftCollection, which specifies the expected metadata values for each NFT
+ */
+class Nft extends internal_1.Entity {
+    /**
+     * @hidden
+     */
+    constructor(identifiers, context) {
+        super(identifiers, context);
+        const { ticker, id } = identifiers;
+        this.id = id;
+        this.collection = new internal_1.NftCollection({ ticker }, context);
+        this.redeem = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.redeemNft, Object.assign({ ticker, id }, args)], optionalArgs: true }, context);
+    }
+    /**
+     * @hidden
+     * Check if a value is of type {@link UniqueIdentifiers}
+     */
+    static isUniqueIdentifiers(identifier) {
+        const { ticker, id } = identifier;
+        return typeof ticker === 'string' && id instanceof bignumber_js_1.default;
+    }
+    /**
+     * Get metadata associated with this token
+     */
+    getMetadata() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { id, context, collection, context: { polymeshApi: { query }, }, } = this;
+            const collectionId = yield collection.getCollectionId();
+            const rawCollectionId = (0, conversion_1.bigNumberToU64)(collectionId, context);
+            const rawId = (0, conversion_1.bigNumberToU64)(id, context);
+            const entries = yield query.nft.metadataValue.entries([rawCollectionId, rawId]);
+            return entries.map(([storageKey, rawValue]) => {
+                const rawMetadataKey = storageKey.args[1];
+                const key = (0, conversion_1.meshMetadataKeyToMetadataKey)(rawMetadataKey, collection.ticker);
+                const value = (0, conversion_1.bytesToString)(rawValue);
+                return { key, value };
+            });
+        });
+    }
+    /**
+     * Determine if the NFT exists on chain
+     *
+     * @note This method returns true, even if the token has been redeemed/burned
+     */
+    exists() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, context: { polymeshApi: { query }, }, collection, id, } = this;
+            const collectionId = yield collection.getCollectionId();
+            const rawCollectionId = (0, conversion_1.bigNumberToU64)(collectionId, context);
+            // note: "nextId" is actually the last used id
+            const rawNextId = yield query.nft.nextNFTId(rawCollectionId);
+            const nextId = (0, conversion_1.u64ToBigNumber)(rawNextId);
+            return id.lte(nextId);
+        });
+    }
+    /**
+     * Get the conventional image URI for the NFT
+     *
+     * This function will check for a token level value and a collection level value. Token level values take precedence over base values in case of a conflict.
+     *
+     * When creating a collection an issuer can either require per token images by specifying global metadata key `imageUri` as a collection key or by
+     * setting a collection base image URL by setting a value on the collection corresponding to the global metadata key `baseImageUri`.
+     *
+     * This method will return `null` if the NFT issuer did not configure the collection according to the convention.
+     *
+     * Per token URIs provide the most flexibility, but require more chain space to store, increasing the POLYX fee to issue each token.
+     *
+     * The URI values can include `{tokenId}` that will be replaced with the NFTs ID. If a base URI does not specify this the ID will be appended onto the URL. Examples:
+     *  - `https://example.com/nfts/{tokenId}/image.png` becomes `https://example.com/nfts/1/image.png`
+     *  - `https://example.com/nfts` becomes `https://example.com/nfts/1` if used a base value, but remain unchanged as a local value
+     */
+    getImageUri() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [localId, collectionId] = yield Promise.all([
+                this.getGlobalMetadataId(constants_1.GLOBAL_IMAGE_URI_NAME),
+                this.getGlobalMetadataId(constants_1.GLOBAL_BASE_IMAGE_URI_NAME),
+            ]);
+            const [localImageUrl, collectionBaseImageUrl] = yield Promise.all([
+                this.getLocalUri(localId),
+                this.getBaseUri(collectionId),
+            ]);
+            if (localImageUrl) {
+                return localImageUrl;
+            }
+            else if (collectionBaseImageUrl) {
+                return collectionBaseImageUrl;
+            }
+            return null;
+        });
+    }
+    /**
+     * Get the conventional token URI for the NFT
+     *
+     * This function will check for a token level value and a collection level value. Token level values take precedence over base values in case of a conflict.
+     *
+     * When creating a collection an issuer can either require per token URL by specifying global metadata key `tokenURI` as a collection key or by
+     * setting a collection base URL by setting a value on the collection corresponding to the global metadata key `baseTokenUri` on the collection.
+     *
+     * This method will return `null` if the NFT issuer did not configure the collection according to the convention.
+     *
+     * Per token URIs provide the most flexibility, but require more chain space to store, increasing the POLYX fee to issue each token.
+     *
+     * The URI values can include `{tokenId}` that will be replaced with the NFTs ID. If a base URI does not specify this the ID will be appended onto the URL. Examples:
+     *  - `https://example.com/nfts/{tokenId}/info.json` becomes `https://example.com/nfts/1/info.json`
+     *  - `https://example.com/nfts` becomes `https://example.com/nfts/1` if used a base value, but remain unchanged as a local value
+     */
+    getTokenUri() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [localId, baseId] = yield Promise.all([
+                this.getGlobalMetadataId(constants_1.GLOBAL_TOKEN_URI_NAME),
+                this.getGlobalMetadataId(constants_1.GLOBAL_BASE_TOKEN_URI_NAME),
+            ]);
+            const [localTokenUri, baseUri] = yield Promise.all([
+                this.getLocalUri(localId),
+                this.getBaseUri(baseId),
+            ]);
+            if (localTokenUri) {
+                return localTokenUri;
+            }
+            else if (baseUri) {
+                return baseUri;
+            }
+            return null;
+        });
+    }
+    /**
+     * @hidden
+     */
+    toHuman() {
+        const { collection: { ticker }, id, } = this;
+        return {
+            collection: ticker,
+            id: id.toString(),
+        };
+    }
+    /**
+     * given a global metadata ID fetches a local URI value
+     *
+     * @hidden
+     */
+    getLocalUri(metadataId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { id, context, collection, context: { polymeshApi: { query }, }, } = this;
+            if (!metadataId) {
+                return null;
+            }
+            const collectionId = yield collection.getCollectionId();
+            const rawCollectionId = (0, conversion_1.bigNumberToU64)(collectionId, context);
+            const rawNftId = (0, conversion_1.bigNumberToU64)(id, context);
+            const rawNftValue = yield query.nft.metadataValue([rawCollectionId, rawNftId], {
+                Global: (0, conversion_1.bigNumberToU64)(metadataId, context),
+            });
+            const nftValue = (0, conversion_1.bytesToString)(rawNftValue);
+            if (nftValue === '') {
+                return null;
+            }
+            return this.templateId(nftValue);
+        });
+    }
+    /**
+     *
+     * given a global metadata ID fetches a base URI value
+     *
+     * @hidden
+     */
+    getBaseUri(metadataId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { collection: { ticker }, context, context: { polymeshApi: { query }, }, } = this;
+            if (!metadataId) {
+                return null;
+            }
+            const rawId = (0, conversion_1.bigNumberToU64)(metadataId, context);
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const rawValue = yield query.asset.assetMetadataValues(rawTicker, { Global: rawId });
+            if (rawValue.isNone) {
+                return null;
+            }
+            const baseUrl = (0, conversion_1.bytesToString)(rawValue.unwrap());
+            return this.templateBaseUri(baseUrl);
+        });
+    }
+    /**
+     * @hidden
+     */
+    templateId(input) {
+        const { id } = this;
+        return input.replace('{tokenId}', id.toString());
+    }
+    /**
+     * @hidden
+     */
+    templateBaseUri(input) {
+        const { id } = this;
+        const templatedPath = this.templateId(input);
+        if (input !== templatedPath) {
+            return templatedPath;
+        }
+        else if (input.endsWith('/')) {
+            return `${input}${id.toString()}`;
+        }
+        else {
+            return `${input}/${id.toString()}`;
+        }
+    }
+    /**
+     * helper to lookup global metadata ID by name
+     *
+     * @hidden
+     */
+    getGlobalMetadataId(keyName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query }, }, } = this;
+            const metadataId = yield query.asset.assetMetadataGlobalNameToKey(keyName);
+            if (metadataId.isSome) {
+                return (0, conversion_1.u64ToBigNumber)(metadataId.unwrap());
+            }
+            return null;
+        });
+    }
+}
+exports.Nft = Nft;
+//# sourceMappingURL=Nft.js.map

package/api/entities/Asset/NonFungible/Nft.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Nft.js","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/NonFungible/Nft.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gEAAqC;AAErC,mDAAuE;AAEvE,2DAK2B;AAC3B,6DAM4B;AAC5B,yDAAyD;AAYzD;;GAEG;AACH,MAAa,GAAI,SAAQ,iBAA2C;IAyBlE;;OAEG;IACH,YAAY,WAAiC,EAAE,OAAgB;QAC7D,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE5B,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,WAAW,CAAC;QAEnC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QAEb,IAAI,CAAC,UAAU,GAAG,IAAI,wBAAa,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAEzD,IAAI,CAAC,MAAM,GAAG,IAAA,gCAAqB,EACjC,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,oBAAS,kBAAI,MAAM,EAAE,EAAE,IAAK,IAAI,EAAG,EAAE,YAAY,EAAE,IAAI,EAAE,EACzF,OAAO,CACR,CAAC;IACJ,CAAC;IA5BD;;;OAGG;IACI,MAAM,CAAU,mBAAmB,CACxC,UAAmB;QAEnB,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,UAAkC,CAAC;QAE1D,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,EAAE,YAAY,sBAAS,CAAC;IAC/D,CAAC;IAoBD;;OAEG;IACU,WAAW;;YACtB,MAAM,EACJ,EAAE,EACF,OAAO,EACP,UAAU,EACV,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,GACF,GAAG,IAAI,CAAC;YAET,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,eAAe,EAAE,CAAC;YAExD,MAAM,eAAe,GAAG,IAAA,2BAAc,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC9D,MAAM,KAAK,GAAG,IAAA,2BAAc,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YAE1C,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC;YAEhF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,EAAE;gBAC5C,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC1C,MAAM,GAAG,GAAG,IAAA,yCAA4B,EAAC,cAAc,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;gBAC5E,MAAM,KAAK,GAAG,IAAA,0BAAa,EAAC,QAAQ,CAAC,CAAC;gBAEtC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;YACxB,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,MAAM;;YACjB,MAAM,EACJ,OAAO,EACP,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,EACD,UAAU,EACV,EAAE,GACH,GAAG,IAAI,CAAC;YACT,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,eAAe,EAAE,CAAC;YACxD,MAAM,eAAe,GAAG,IAAA,2BAAc,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAE9D,8CAA8C;YAC9C,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;YAC7D,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,SAAS,CAAC,CAAC;YAEzC,OAAO,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACU,WAAW;;YACtB,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChD,IAAI,CAAC,mBAAmB,CAAC,iCAAqB,CAAC;gBAC/C,IAAI,CAAC,mBAAmB,CAAC,sCAA0B,CAAC;aACrD,CAAC,CAAC;YAEH,MAAM,CAAC,aAAa,EAAE,sBAAsB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;gBACzB,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;aAC9B,CAAC,CAAC;YAEH,IAAI,aAAa,EAAE;gBACjB,OAAO,aAAa,CAAC;aACtB;iBAAM,IAAI,sBAAsB,EAAE;gBACjC,OAAO,sBAAsB,CAAC;aAC/B;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACU,WAAW;;YACtB,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAC1C,IAAI,CAAC,mBAAmB,CAAC,iCAAqB,CAAC;gBAC/C,IAAI,CAAC,mBAAmB,CAAC,sCAA0B,CAAC;aACrD,CAAC,CAAC;YAEH,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACjD,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;gBACzB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;aACxB,CAAC,CAAC;YAEH,IAAI,aAAa,EAAE;gBACjB,OAAO,aAAa,CAAC;aACtB;iBAAM,IAAI,OAAO,EAAE;gBAClB,OAAO,OAAO,CAAC;aAChB;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAED;;OAEG;IACI,OAAO;QACZ,MAAM,EACJ,UAAU,EAAE,EAAE,MAAM,EAAE,EACtB,EAAE,GACH,GAAG,IAAI,CAAC;QAET,OAAO;YACL,UAAU,EAAE,MAAM;YAClB,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE;SAClB,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACW,WAAW,CAAC,UAA4B;;YACpD,MAAM,EACJ,EAAE,EACF,OAAO,EACP,UAAU,EACV,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,GACF,GAAG,IAAI,CAAC;YAET,IAAI,CAAC,UAAU,EAAE;gBACf,OAAO,IAAI,CAAC;aACb;YAED,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,eAAe,EAAE,CAAC;YAExD,MAAM,eAAe,GAAG,IAAA,2BAAc,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC9D,MAAM,QAAQ,GAAG,IAAA,2BAAc,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YAE7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,eAAe,EAAE,QAAQ,CAAC,EAAE;gBAC7E,MAAM,EAAE,IAAA,2BAAc,EAAC,UAAU,EAAE,OAAO,CAAC;aAC5C,CAAC,CAAC;YAEH,MAAM,QAAQ,GAAG,IAAA,0BAAa,EAAC,WAAW,CAAC,CAAC;YAC5C,IAAI,QAAQ,KAAK,EAAE,EAAE;gBACnB,OAAO,IAAI,CAAC;aACb;YAED,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACnC,CAAC;KAAA;IAED;;;;;OAKG;IACW,UAAU,CAAC,UAA4B;;YACnD,MAAM,EACJ,UAAU,EAAE,EAAE,MAAM,EAAE,EACtB,OAAO,EACP,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,GACF,GAAG,IAAI,CAAC;YAET,IAAI,CAAC,UAAU,EAAE;gBACf,OAAO,IAAI,CAAC;aACb;YAED,MAAM,KAAK,GAAG,IAAA,2BAAc,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAErF,IAAI,QAAQ,CAAC,MAAM,EAAE;gBACnB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,OAAO,GAAG,IAAA,0BAAa,EAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YACjD,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;KAAA;IAED;;OAEG;IACK,UAAU,CAAC,KAAa;QAC9B,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC;QAEpB,OAAO,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACK,eAAe,CAAC,KAAa;QACnC,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC;QAEpB,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAE7C,IAAI,KAAK,KAAK,aAAa,EAAE;YAC3B,OAAO,aAAa,CAAC;SACtB;aAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC9B,OAAO,GAAG,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;SACnC;aAAM;YACL,OAAO,GAAG,KAAK,IAAI,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;SACpC;IACH,CAAC;IAED;;;;OAIG;IACW,mBAAmB,CAAC,OAAe;;YAC/C,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,GACF,GAAG,IAAI,CAAC;YAET,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;YAE3E,IAAI,UAAU,CAAC,MAAM,EAAE;gBACrB,OAAO,IAAA,2BAAc,EAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;aAC5C;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;CACF;AAvSD,kBAuSC"}

package/api/entities/Asset/NonFungible/NftCollection.d.ts

@@ -0,0 +1,69 @@
+import BigNumber from 'bignumber.js';
+import { BaseAsset } from "../Base";
+import { NonFungibleSettlements } from "../Base/Settlements";
+import { Context, Nft } from "../../../../internal";
+import { AssetDetails, CollectionKey, EventIdentifier, IssueNftParams, ProcedureMethod, SubCallback, UniqueIdentifiers, UnsubCallback } from "../../../../types";
+/**
+ * Class used to manage NFT functionality
+ */
+export declare class NftCollection extends BaseAsset {
+    settlements: NonFungibleSettlements;
+    /**
+     * Issues a new NFT for the collection
+     *
+     * @note Each NFT requires metadata for each value returned by `collectionKeys`. The SDK and chain only validate the presence of these fields. Additional validation may be needed to ensure each value complies with the specification.
+     */
+    issue: ProcedureMethod<IssueNftParams, Nft>;
+    /**
+     * Local cache for `getCollectionId`
+     *
+     * @hidden
+     */
+    private _id?;
+    /**
+     * @hidden
+     */
+    constructor(identifiers: UniqueIdentifiers, context: Context);
+    /**
+     * Retrieve the NftCollection's data
+     *
+     * @note can be subscribed to
+     */
+    details(): Promise<AssetDetails>;
+    details(callback: SubCallback<AssetDetails>): Promise<UnsubCallback>;
+    /**
+     * Retrieve the metadata that defines the NFT collection. Every `issue` call for this collection must provide a value for each element returned
+     *
+     * @note Each NFT **must** have an entry for each value, it **should** comply with the spec.
+     * In other words, the SDK only validates the presence of metadata keys, additional validation should be used when issuing
+     */
+    collectionKeys(): Promise<CollectionKey[]>;
+    /**
+     * Retrieve the amount of unique investors that hold this Nft
+     */
+    investorCount(): Promise<BigNumber>;
+    /**
+     * Get an NFT belonging to this collection
+     *
+     * @throws if the given NFT does not exist
+     */
+    getNft(args: {
+        id: BigNumber;
+    }): Promise<Nft>;
+    /**
+     * Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created
+     *
+     * @note uses the middlewareV2
+     * @note there is a possibility that the data is not ready by the time it is requested. In that case, `null` is returned
+     */
+    createdAt(): Promise<EventIdentifier | null>;
+    /**
+     * Determine whether this NftCollection exists on chain
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Returns the collection's on chain numeric ID. Used primarily to access NFT specific storage values
+     */
+    getCollectionId(): Promise<BigNumber>;
+}
+//# sourceMappingURL=NftCollection.d.ts.map

package/api/entities/Asset/NonFungible/NftCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NftCollection.d.ts","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/NonFungible/NftCollection.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,SAAS,EAAE,gBAAkC;AACtD,OAAO,EAAE,sBAAsB,EAAE,4BAA8C;AAE/E,OAAO,EAAE,OAAO,EAAE,GAAG,EAAyC,6BAAmB;AAGjF,OAAO,EACL,YAAY,EACZ,aAAa,EAEb,eAAe,EACf,cAAc,EAEd,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,aAAa,EACd,0BAAgB;AAuBjB;;GAEG;AACH,qBAAa,aAAc,SAAQ,SAAS;IACnC,WAAW,EAAE,sBAAsB,CAAC;IAC3C;;;;OAIG;IACI,KAAK,EAAE,eAAe,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;IAEnD;;;;OAIG;IACH,OAAO,CAAC,GAAG,CAAC,CAAY;IAExB;;OAEG;gBACS,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,OAAO;IAmB5D;;;;OAIG;IACa,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC;IAChC,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IA0CpF;;;;;OAKG;IACU,cAAc,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAsCvD;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC,SAAS,CAAC;IAkBhD;;;;OAIG;IACU,MAAM,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB1D;;;;;OAKG;IACU,SAAS,IAAI,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAkBzD;;OAEG;IACmB,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAUhD;;OAEG;IACU,eAAe,IAAI,OAAO,CAAC,SAAS,CAAC;CAoBnD"}