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

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

@@ -0,0 +1,185 @@
+"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.NftCollection = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const Base_1 = require("../Base");
+const Settlements_1 = require("../Base/Settlements");
+const issueNft_1 = require("../../../procedures/issueNft");
+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 sumNftIssuance = (numberOfNfts) => {
+    let numberIssued = new bignumber_js_1.default(0);
+    numberOfNfts.forEach(([, holderEntry]) => {
+        const holderAmount = (0, conversion_1.u64ToBigNumber)(holderEntry);
+        numberIssued = numberIssued.plus(holderAmount);
+    });
+    return numberIssued;
+};
+/**
+ * Class used to manage NFT functionality
+ */
+class NftCollection extends Base_1.BaseAsset {
+    /**
+     * @hidden
+     */
+    constructor(identifiers, context) {
+        super(identifiers, context);
+        const { ticker } = identifiers;
+        this.settlements = new Settlements_1.NonFungibleSettlements(this, context);
+        this.transferOwnership = (0, internal_2.createProcedureMethod)({ getProcedureAndArgs: args => [internal_1.transferAssetOwnership, Object.assign({ ticker }, args)] }, context);
+        this.issue = (0, internal_2.createProcedureMethod)({
+            getProcedureAndArgs: args => [issueNft_1.issueNft, Object.assign({ ticker }, args)],
+        }, context);
+    }
+    // eslint-disable-next-line require-jsdoc
+    details(callback) {
+        const _super = Object.create(null, {
+            details: { get: () => super.details }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query }, }, ticker, context, } = this;
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const rawNumberNftsPromise = query.nft.numberOfNFTs.entries(rawTicker);
+            if (callback) {
+                const rawNumberNfts = yield rawNumberNftsPromise;
+                const numberIssued = sumNftIssuance(rawNumberNfts);
+                // currently `asset.tokens` does not track Nft `totalSupply', we wrap the callback to provide it
+                const wrappedCallback = (commonDetails) => __awaiter(this, void 0, void 0, function* () {
+                    const nftDetails = Object.assign(Object.assign({}, commonDetails), { totalSupply: numberIssued });
+                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+                    callback(nftDetails);
+                });
+                return _super.details.call(this, wrappedCallback);
+            }
+            const [rawNumberNfts, commonDetails] = yield Promise.all([
+                rawNumberNftsPromise,
+                _super.details.call(this),
+            ]);
+            const numberIssued = sumNftIssuance(rawNumberNfts);
+            return Object.assign(Object.assign({}, commonDetails), { totalSupply: numberIssued });
+        });
+    }
+    /**
+     * 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() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, ticker, context: { polymeshApi: { query }, }, } = this;
+            const collectionId = yield this.getCollectionId();
+            const rawCollectionId = (0, conversion_1.bigNumberToU64)(collectionId, context);
+            const rawKeys = yield query.nft.collectionKeys(rawCollectionId);
+            const neededKeys = [...rawKeys].map(value => (0, conversion_1.meshMetadataKeyToMetadataKey)(value, ticker));
+            const allMetadata = yield this.metadata.get();
+            return Promise.all(neededKeys.map(({ type, id }) => __awaiter(this, void 0, void 0, function* () {
+                const neededMetadata = allMetadata.find(entry => entry.type === type && entry.id.eq(id));
+                if (!neededMetadata) {
+                    throw new internal_1.PolymeshError({
+                        code: types_1.ErrorCode.DataUnavailable,
+                        message: 'Failed to find metadata details',
+                        data: { type, id },
+                    });
+                }
+                const details = yield neededMetadata.details();
+                if (type === types_1.MetadataType.Local) {
+                    return Object.assign(Object.assign({}, details), { id, type, ticker });
+                }
+                else {
+                    return Object.assign(Object.assign({}, details), { id, type });
+                }
+            })));
+        });
+    }
+    /**
+     * Retrieve the amount of unique investors that hold this Nft
+     */
+    investorCount() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context: { polymeshApi: { query }, }, context, ticker, } = this;
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const holderEntries = yield query.nft.numberOfNFTs.entries(rawTicker);
+            const assetBalances = holderEntries.filter(([, balance]) => !balance.isZero());
+            return new bignumber_js_1.default(assetBalances.length);
+        });
+    }
+    /**
+     * Get an NFT belonging to this collection
+     *
+     * @throws if the given NFT does not exist
+     */
+    getNft(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { context, ticker } = this;
+            const { id } = args;
+            const nft = new internal_1.Nft({ ticker, id }, context);
+            const exists = yield nft.exists();
+            if (!exists) {
+                throw new internal_1.PolymeshError({
+                    code: types_1.ErrorCode.DataUnavailable,
+                    message: 'The NFT does not exist',
+                    data: { id },
+                });
+            }
+            return 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() {
+        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);
+        });
+    }
+    /**
+     * Determine whether this NftCollection exists on chain
+     */
+    exists() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { ticker, context } = this;
+            const rawTokenId = yield context.polymeshApi.query.nft.collectionTicker((0, conversion_1.stringToTicker)(ticker, context));
+            return !rawTokenId.isZero();
+        });
+    }
+    /**
+     * Returns the collection's on chain numeric ID. Used primarily to access NFT specific storage values
+     */
+    getCollectionId() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { ticker, context, context: { polymeshApi: { query }, }, } = this;
+            if (this._id) {
+                return this._id;
+            }
+            const rawTicker = (0, conversion_1.stringToTicker)(ticker, context);
+            const rawId = yield query.nft.collectionTicker(rawTicker);
+            this._id = (0, conversion_1.u64ToBigNumber)(rawId);
+            return this._id;
+        });
+    }
+}
+exports.NftCollection = NftCollection;
+//# sourceMappingURL=NftCollection.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NftCollection.js","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/NonFungible/NftCollection.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,gEAAqC;AAErC,kCAAsD;AACtD,qDAA+E;AAC/E,2DAAqD;AACrD,mDAAiF;AACjF,4DAAkD;AAElD,6CAWiB;AAEjB,6DAM4B;AAC5B,yDAAoE;AAEpE,MAAM,cAAc,GAAG,CACrB,YAA2F,EAChF,EAAE;IACb,IAAI,YAAY,GAAG,IAAI,sBAAS,CAAC,CAAC,CAAC,CAAC;IACpC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE;QACvC,MAAM,YAAY,GAAG,IAAA,2BAAc,EAAC,WAAW,CAAC,CAAC;QACjD,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAa,aAAc,SAAQ,gBAAS;IAgB1C;;OAEG;IACH,YAAY,WAA8B,EAAE,OAAgB;QAC1D,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE5B,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,IAAI,oCAAsB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE7D,IAAI,CAAC,iBAAiB,GAAG,IAAA,gCAAqB,EAC5C,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,iCAAsB,kBAAI,MAAM,IAAK,IAAI,EAAG,EAAE,EAC9E,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,IAAA,gCAAqB,EAChC;YACE,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,mBAAQ,kBAAI,MAAM,IAAK,IAAI,EAAG;SAC7D,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAUD,yCAAyC;IACnB,OAAO,CAC3B,QAAoC;;;;;YAEpC,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,EACD,MAAM,EACN,OAAO,GACR,GAAG,IAAI,CAAC;YAET,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAElD,MAAM,oBAAoB,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAEvE,IAAI,QAAQ,EAAE;gBACZ,MAAM,aAAa,GAAG,MAAM,oBAAoB,CAAC;gBACjD,MAAM,YAAY,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;gBAEnD,gGAAgG;gBAChG,MAAM,eAAe,GAAG,CAAO,aAA2B,EAAiB,EAAE;oBAC3E,MAAM,UAAU,mCAAQ,aAAa,KAAE,WAAW,EAAE,YAAY,GAAE,CAAC;oBAEnE,mEAAmE;oBACnE,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACvB,CAAC,CAAA,CAAC;gBAEF,OAAO,OAAM,OAAO,YAAC,eAAe,EAAE;aACvC;YAED,MAAM,CAAC,aAAa,EAAE,aAAa,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACvD,oBAAoB;gBACpB,OAAM,OAAO;aACd,CAAC,CAAC;YACH,MAAM,YAAY,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;YAEnD,uCAAY,aAAa,KAAE,WAAW,EAAE,YAAY,IAAG;QACzD,CAAC;KAAA;IAED;;;;;OAKG;IACU,cAAc;;YACzB,MAAM,EACJ,OAAO,EACP,MAAM,EACN,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,GACF,GAAG,IAAI,CAAC;YAET,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;YAClD,MAAM,eAAe,GAAG,IAAA,2BAAc,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAE9D,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;YAChE,MAAM,UAAU,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAA,yCAA4B,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;YAE1F,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YAC9C,OAAO,OAAO,CAAC,GAAG,CAChB,UAAU,CAAC,GAAG,CAAC,CAAO,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE;gBACpC,MAAM,cAAc,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBACzF,IAAI,CAAC,cAAc,EAAE;oBACnB,MAAM,IAAI,wBAAa,CAAC;wBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;wBAC/B,OAAO,EAAE,iCAAiC;wBAC1C,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;qBACnB,CAAC,CAAC;iBACJ;gBAED,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,CAAC;gBAE/C,IAAI,IAAI,KAAK,oBAAY,CAAC,KAAK,EAAE;oBAC/B,uCAAY,OAAO,KAAE,EAAE,EAAE,IAAI,EAAE,MAAM,IAAG;iBACzC;qBAAM;oBACL,uCAAY,OAAO,KAAE,EAAE,EAAE,IAAI,IAAG;iBACjC;YACH,CAAC,CAAA,CAAC,CACH,CAAC;QACJ,CAAC;KAAA;IAED;;OAEG;IACU,aAAa;;YACxB,MAAM,EACJ,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,EACD,OAAO,EACP,MAAM,GACP,GAAG,IAAI,CAAC;YAET,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAElD,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAEtE,MAAM,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAE/E,OAAO,IAAI,sBAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;KAAA;IAED;;;;OAIG;IACU,MAAM,CAAC,IAAuB;;YACzC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;YACjC,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC;YAEpB,MAAM,GAAG,GAAG,IAAI,cAAG,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YAE7C,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,EAAE,CAAC;YAClC,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,wBAAa,CAAC;oBACtB,IAAI,EAAE,iBAAS,CAAC,eAAe;oBAC/B,OAAO,EAAE,wBAAwB;oBACjC,IAAI,EAAE,EAAE,EAAE,EAAE;iBACb,CAAC,CAAC;aACJ;YAED,OAAO,GAAG,CAAC;QACb,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;IAED;;OAEG;IACmB,MAAM;;YAC1B,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YAEjC,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,gBAAgB,CACrE,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAChC,CAAC;YAEF,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC9B,CAAC;KAAA;IAED;;OAEG;IACU,eAAe;;YAC1B,MAAM,EACJ,MAAM,EACN,OAAO,EACP,OAAO,EAAE,EACP,WAAW,EAAE,EAAE,KAAK,EAAE,GACvB,GACF,GAAG,IAAI,CAAC;YAET,IAAI,IAAI,CAAC,GAAG,EAAE;gBACZ,OAAO,IAAI,CAAC,GAAG,CAAC;aACjB;YAED,MAAM,SAAS,GAAG,IAAA,2BAAc,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;YAE1D,IAAI,CAAC,GAAG,GAAG,IAAA,2BAAc,EAAC,KAAK,CAAC,CAAC;YAEjC,OAAO,IAAI,CAAC,GAAG,CAAC;QAClB,CAAC;KAAA;CACF;AA1OD,sCA0OC"}

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

@@ -0,0 +1,3 @@
+export * from './NftCollection';
+export * from './Nft';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/NonFungible/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,OAAO,CAAC"}

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

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./NftCollection"), exports);
+__exportStar(require("./Nft"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/entities/Asset/NonFungible/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,wCAAsB"}

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

@@ -1,159 +1,5 @@
-import BigNumber from 'bignumber.js';
-import { Metadata } from "./Metadata";
-import { AuthorizationRequest, Context, Entity } from "../../../internal";
-import { ControllerTransferParams, EventIdentifier, HistoricAgentOperation, HistoricAssetTransaction, ModifyAssetParams, NoArgsProcedureMethod, ProcedureMethod, RedeemTokensParams, ResultSet, SecurityIdentifier, SetVenueFilteringParams, SubCallback, TransferAssetOwnershipParams, UnsubCallback } from "../../../types";
-import { AssetHolders } from './AssetHolders';
-import { Checkpoints } from './Checkpoints';
-import { Compliance } from './Compliance';
-import { CorporateActions } from './CorporateActions';
-import { Documents } from './Documents';
-import { Issuance } from './Issuance';
-import { Offerings } from './Offerings';
-import { Permissions } from './Permissions';
-import { Settlements } from './Settlements';
-import { TransferRestrictions } from './TransferRestrictions';
-import { AssetDetails } from './types';
-/**
- * Properties that uniquely identify an Asset
- */
-export interface UniqueIdentifiers {
-    /**
-     * ticker of the Asset
-     */
-    ticker: string;
-}
-/**
- * Class used to manage all Asset functionality
- */
-export declare class Asset extends Entity<UniqueIdentifiers, string> {
-    /**
-     * @hidden
-     * Check if a value is of type {@link UniqueIdentifiers}
-     */
-    static isUniqueIdentifiers(identifier: unknown): identifier is UniqueIdentifiers;
-    /**
-     * Identity ID of the Asset (used for Claims)
-     */
-    did: string;
-    /**
-     * ticker of the Asset
-     */
-    ticker: string;
-    documents: Documents;
-    settlements: Settlements;
-    assetHolders: AssetHolders;
-    issuance: Issuance;
-    compliance: Compliance;
-    transferRestrictions: TransferRestrictions;
-    offerings: Offerings;
-    checkpoints: Checkpoints;
-    corporateActions: CorporateActions;
-    permissions: Permissions;
-    metadata: Metadata;
-    /**
-     * @hidden
-     */
-    constructor(identifiers: UniqueIdentifiers, context: Context);
-    /**
-     * Transfer ownership of the Asset to another Identity. This generates an authorization request that must be accepted
-     *   by the recipient
-     *
-     * @note this will create {@link api/entities/AuthorizationRequest!AuthorizationRequest | Authorization Request} which has to be accepted by the `target` Identity.
-     *   An {@link api/entities/Account!Account} or {@link api/entities/Identity!Identity} can fetch its pending Authorization Requests by calling {@link api/entities/common/namespaces/Authorizations!Authorizations.getReceived | authorizations.getReceived}.
-     *   Also, an Account or Identity can directly fetch the details of an Authorization Request by calling {@link api/entities/common/namespaces/Authorizations!Authorizations.getOne | authorizations.getOne}
-     */
-    transferOwnership: ProcedureMethod<TransferAssetOwnershipParams, AuthorizationRequest>;
-    /**
-     * Modify some properties of the Asset
-     *
-     * @throws if the passed values result in no changes being made to the Asset
-     */
-    modify: ProcedureMethod<ModifyAssetParams, Asset>;
-    /**
-     * Retrieve the Asset's data
-     *
-     * @note can be subscribed to
-     */
-    details(): Promise<AssetDetails>;
-    details(callback: SubCallback<AssetDetails>): Promise<UnsubCallback>;
-    /**
-     * Retrieve the Asset's funding round
-     *
-     * @note can be subscribed to
-     */
-    currentFundingRound(): Promise<string | null>;
-    currentFundingRound(callback: SubCallback<string | null>): Promise<UnsubCallback>;
-    /**
-     * Retrieve the Asset's identifiers list
-     *
-     * @note can be subscribed to
-     */
-    getIdentifiers(): Promise<SecurityIdentifier[]>;
-    getIdentifiers(callback?: SubCallback<SecurityIdentifier[]>): Promise<UnsubCallback>;
-    /**
-     * 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>;
-    /**
-     * Freeze transfers of the Asset
-     */
-    freeze: NoArgsProcedureMethod<Asset>;
-    /**
-     * Unfreeze transfers of the Asset
-     */
-    unfreeze: NoArgsProcedureMethod<Asset>;
-    /**
-     * Check whether transfers are frozen for the Asset
-     *
-     * @note can be subscribed to
-     */
-    isFrozen(): Promise<boolean>;
-    isFrozen(callback: SubCallback<boolean>): Promise<UnsubCallback>;
-    /**
-     * Redeem (burn) an amount of this Asset's tokens
-     *
-     * @note tokens are removed from the caller's Default Portfolio
-     */
-    redeem: ProcedureMethod<RedeemTokensParams, void>;
-    /**
-     * Retrieve the amount of unique investors that hold this Asset
-     */
-    investorCount(): Promise<BigNumber>;
-    /**
-     * Force a transfer from a given Portfolio to the caller’s default Portfolio
-     */
-    controllerTransfer: ProcedureMethod<ControllerTransferParams, void>;
-    /**
-     * Retrieve this Asset's Operation History
-     *
-     * @note Operations are grouped by the agent Identity who performed them
-     *
-     * @note uses the middlewareV2
-     */
-    getOperationHistory(): Promise<HistoricAgentOperation[]>;
-    /**
-     * Retrieve this Asset's transaction History
-     *
-     * @note uses the middlewareV2
-     */
-    getTransactionHistory(opts: {
-        size?: BigNumber;
-        start?: BigNumber;
-    }): Promise<ResultSet<HistoricAssetTransaction>>;
-    /**
-     * Determine whether this Asset exists on chain
-     */
-    exists(): Promise<boolean>;
-    /**
-     * Return the Asset's ticker
-     */
-    toHuman(): string;
-    /**
-     * Enable/disable venue filtering for this Asset and/or set allowed/disallowed venues
-     */
-    setVenueFiltering: ProcedureMethod<SetVenueFilteringParams, void>;
-}
+export * from './Fungible';
+export * from './NonFungible';
+export * from './Base';
+export * from './types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Asset/index.ts"],"names":[],"mappings":"AAOA,OAAO,SAAS,MAAM,cAAc,CAAC;AAGrC,OAAO,EAAE,QAAQ,EAAE,mBAAsC;AACzD,OAAO,EACL,oBAAoB,EACpB,OAAO,EAEP,MAAM,EAQP,0BAAmB;AAOpB,OAAO,EACL,wBAAwB,EAExB,eAAe,EACf,sBAAsB,EACtB,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,EACf,kBAAkB,EAClB,SAAS,EACT,kBAAkB,EAClB,uBAAuB,EACvB,WAAW,EACX,4BAA4B,EAC5B,aAAa,EACd,uBAAgB;AAiBjB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAC1D;;;OAGG;WACoB,mBAAmB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI,iBAAiB;IAMhG;;OAEG;IACI,GAAG,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACI,MAAM,EAAE,MAAM,CAAC;IAGf,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,QAAQ,CAAC;IAE1B;;OAEG;gBACS,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,OAAO;IAwD5D;;;;;;;OAOG;IACI,iBAAiB,EAAE,eAAe,CAAC,4BAA4B,EAAE,oBAAoB,CAAC,CAAC;IAC9F;;;;OAIG;IACI,MAAM,EAAE,eAAe,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;IAEzD;;;;OAIG;IACI,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC;IAChC,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IAwF3E;;;;OAIG;IACI,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAC7C,mBAAmB,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IA+BxF;;;;OAIG;IACI,cAAc,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAC/C,cAAc,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,kBAAkB,EAAE,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IA8B3F;;;;;OAKG;IACU,SAAS,IAAI,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAkBzD;;OAEG;IACI,MAAM,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAE5C;;OAEG;IACI,QAAQ,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAE9C;;;;OAIG;IACI,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IA4BvE;;;;OAIG;IACI,MAAM,EAAE,eAAe,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;IAEzD;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC,SAAS,CAAC;IAwBhD;;OAEG;IACI,kBAAkB,EAAE,eAAe,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;IAE3E;;;;;;OAMG;IACU,mBAAmB,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAwBrE;;;;OAIG;IACU,qBAAqB,CAAC,IAAI,EAAE;QACvC,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,KAAK,CAAC,EAAE,SAAS,CAAC;KACnB,GAAG,OAAO,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC;IAmDhD;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAUvC;;OAEG;IACI,OAAO,IAAI,MAAM;IAIxB;;OAEG;IACI,iBAAiB,EAAE,eAAe,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;CAC1E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/entities/Asset/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}