@tezos-x/octez.js-tzip16 0.9.0

package/README.md

@@ -0,0 +1,68 @@
+# octez.js TZIP-016 package
+
+*Documentation can be found [here](https://octez.js.io/docs/metadata-tzip16/)*
+*TypeDoc style documentation is available on-line [here](https://octez.js.io/typedoc/modules/_octez.js_tzip16.html)*
+
+**Maintained by [Nomadic Labs](https://www.nomadic-labs.com/).**
+
+`@tezos-x/octez.js-tzip16` is an npm package that provides developers with TZIP-016 functionality for octez.js. TZIP-016 is a standard for encoding access to smart contract metadata either on-chain or off-chain. The `@tezos-x/octez.js-tzip16` package allows developers to retrieve the metadata associated with a smart contract and execute the off-chain views found in the metadata.
+
+## General Information
+
+Contract metadata gathers valuable information about the contract that is not directly used for its operation. According to TZIP-016, a contract with metadata must include in its storage a big_map named `%metadata` of the following type: `(big_map %metadata string bytes)`. The big_map must have an empty string as a key where its value is a byte-encoded URI representing the metadata location. Contract metadata can be located on-chain or off-chain (web services or IPFS). Please refer to the following link for complete documentation on [TZIP-016](https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-16/tzip-16.md#introduction).
+
+When using the `@tezos-x/octez.js-tzip16` package, developers can retrieve metadata of a contract based on its address. The underlying steps performed by octez.js are to find the URI in the contract storage, decode it, extract the metadata depending on the protocol (tezos-storage, HTTP(S) or IPFS), perform an integrity check if the URI contains a sha256 hash, and return the metadata to the user.
+
+Another functionality of the `@tezos-x/octez.js-tzip16` package allows executing off-chain views. If a contract contains views in its metadata, octez.js builds an ordinary JavaScript object with methods corresponding to the views name.
+
+## Install
+
+The package can be used to extend the well-known octez.js contract abstraction. The `@tezos-x/octez.js-tzip16` and the `@tezos-x/octez.js` packages need to be installed as follows:
+
+```
+npm i --save @tezos-x/octez.js-tzip16
+npm i --save @tezos-x/octez.js
+```
+
+## Usage
+
+**Create an instance of the `Tzip16Module` and add it as an extension to the `TezosToolkit`**
+
+The constructor of the `Tzip16Module` takes an optional `MetadataProvider` as a parameter. When none is passed, the default `MetadataProvider` of octez.js is instantiated, and the default handlers (`HttpHandler`, `IpfsHandler`, and `TezosStorageHandler`) are used. 
+The `MetadataProvider` can be customized by the user if needed.
+
+**Use the `tzip16` function to extend a contract abstraction**
+
+```js
+import { TezosToolkit } from '@tezos-x/octez.js';
+import { Tzip16Module, tzip16 } from '@tezos-x/octez.js-tzip16';
+
+const Tezos = new TezosToolkit('https://YOUR_PREFERRED_RPC_URL');
+Tezos.addExtension(new Tzip16Module());
+
+const contract = await Tezos.contract.at("contractAddress", tzip16)
+```
+
+### Get the contract metadata
+
+```ts
+const metadata = await contract.tzip16().getMetadata();
+```
+
+The `getMetadata` method returns an object which contains the URI, the metadata in JSON format, an optional SHA256 hash of the metadata, and an optional integrity check result.
+
+### Execute off-chain views
+
+```ts
+// Initialize off-chain views
+const metadataViews = await contractAbstraction.tzip16().metadataViews();
+const viewResult = await metadataViews.nameOfTheView().executeView(paramOfTheView);
+```
+
+## Additional info
+
+See the top-level [https://github.com/trilitech/octez.js](https://github.com/trilitech/octez.js) file for details on reporting issues, contributing, and versioning.
+
+## Disclaimer
+
+THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/lib/composer.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tzip16 = tzip16;
+const tzip16_contract_abstraction_1 = require("./tzip16-contract-abstraction");
+const ABSTRACTION_KEY = Symbol('Tzip16ContractAbstractionObjectKey');
+function tzip16(abs, context) {
+    return Object.assign(abs, {
+        // namespace tzip16
+        tzip16() {
+            if (!this[ABSTRACTION_KEY]) {
+                this[ABSTRACTION_KEY] = new tzip16_contract_abstraction_1.Tzip16ContractAbstraction(this, context);
+            }
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            return this[ABSTRACTION_KEY];
+        },
+    });
+}

package/dist/lib/errors.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoParameterExpectedError = exports.ForbiddenInstructionInViewCodeError = exports.UnconfiguredContractMetadataProviderError = exports.InvalidContractMetadataTypeError = exports.ProtocolNotSupportedError = exports.InvalidContractMetadataError = exports.InvalidUriError = exports.UriNotFoundError = exports.ContractMetadataNotFoundError = exports.BigMapContractMetadataNotFoundError = exports.InvalidViewParameterError = void 0;
+const octez_js_core_1 = require("@tezos-x/octez.js-core");
+var octez_js_core_2 = require("@tezos-x/octez.js-core");
+Object.defineProperty(exports, "InvalidViewParameterError", { enumerable: true, get: function () { return octez_js_core_2.InvalidViewParameterError; } });
+/**
+ *  @category Error
+ *  @description Error that indicates missing big map metadata (non compliance to the TZIP-16 standard)
+ */
+class BigMapContractMetadataNotFoundError extends octez_js_core_1.TaquitoError {
+    constructor(invalidBigMapId) {
+        super();
+        this.invalidBigMapId = invalidBigMapId;
+        this.name = 'BigMapContractMetadataNotFoundError';
+        this.message =
+            'Non-compliance with the TZIP-016 standard. No big map named metadata was found in the contract storage.';
+    }
+}
+exports.BigMapContractMetadataNotFoundError = BigMapContractMetadataNotFoundError;
+/**
+ *  @category Error
+ *  @description Error that indicates missing metadata in storage
+ */
+class ContractMetadataNotFoundError extends octez_js_core_1.TaquitoError {
+    constructor(info) {
+        super();
+        this.info = info;
+        this.name = 'ContractMetadataNotFoundError';
+        this.message = `No metadata was found in the contract storage. ${info}`;
+    }
+}
+exports.ContractMetadataNotFoundError = ContractMetadataNotFoundError;
+/**
+ *  @category Error
+ *  @description Error that indicates missing URI (non compliance to the TZIP-16 standard)
+ */
+class UriNotFoundError extends octez_js_core_1.TaquitoError {
+    constructor() {
+        super();
+        this.name = 'UriNotFoundError';
+        this.message =
+            'Non-compliance with the TZIP-016 standard. No URI found in the contract storage.';
+    }
+}
+exports.UriNotFoundError = UriNotFoundError;
+/**
+ *  @category Error
+ *  @description Error that indicates an invalid URI (non compliance to the TZIP-16 standard)
+ */
+class InvalidUriError extends octez_js_core_1.TaquitoError {
+    constructor(uri) {
+        super();
+        this.uri = uri;
+        this.name = 'InvalidUriError';
+        this.message = `Non-compliance with the TZIP-016 standard. The URI is invalid: ${uri}.`;
+    }
+}
+exports.InvalidUriError = InvalidUriError;
+/**
+ *  @category Error
+ *  @description Error that indicates invalid metadata (non compliance to the TZIP-16 standard)
+ */
+class InvalidContractMetadataError extends octez_js_core_1.TaquitoError {
+    constructor(invalidMetadata) {
+        super();
+        this.invalidMetadata = invalidMetadata;
+        this.name = 'InvalidContractMetadataError';
+        this.message = `The metadata found at the pointed ressource are not compliant with tzip16 standard: ${invalidMetadata}.`;
+    }
+}
+exports.InvalidContractMetadataError = InvalidContractMetadataError;
+/**
+ *  @category Error
+ *  @description Error that indicates the uri protocol being passed or used is not supported
+ */
+class ProtocolNotSupportedError extends octez_js_core_1.ParameterValidationError {
+    constructor(protocol) {
+        super();
+        this.protocol = protocol;
+        this.name = 'ProtocolNotSupportedError';
+        this.message = `The protocol found in the URI is not supported: ${protocol}.`;
+    }
+}
+exports.ProtocolNotSupportedError = ProtocolNotSupportedError;
+/**
+ *  @category Error
+ *  @description Error that indicates the metadata type is invalid (non compliance to the TZIP-16 standard)
+ */
+class InvalidContractMetadataTypeError extends octez_js_core_1.TaquitoError {
+    constructor() {
+        super();
+        this.name = 'InvalidContractMetadataTypeError';
+        this.message =
+            'Non-compliance with the TZIP-016 standard. The type of metadata should be bytes.';
+    }
+}
+exports.InvalidContractMetadataTypeError = InvalidContractMetadataTypeError;
+/**
+ *  @category Error
+ *  @description Error that indicates metadata provider being unconfigured in the TezosToolkit instance
+ */
+class UnconfiguredContractMetadataProviderError extends octez_js_core_1.TezosToolkitConfigError {
+    constructor() {
+        super();
+        this.name = 'UnconfiguredContractMetadataProviderError';
+        this.message =
+            'No metadata provider has been configured. The default one can be configured by calling addExtension(new Tzip16Module()) on your TezosToolkit instance.';
+    }
+}
+exports.UnconfiguredContractMetadataProviderError = UnconfiguredContractMetadataProviderError;
+/**
+ *  @category Error
+ *  @description Error that indicates a forbidden instruction being found inside the View code
+ */
+class ForbiddenInstructionInViewCodeError extends octez_js_core_1.TaquitoError {
+    constructor(instruction) {
+        super();
+        this.instruction = instruction;
+        this.name = 'ForbiddenInstructionInViewCodeError';
+        this.message = `Error found in the code of the view. It contains a forbidden instruction: ${instruction}.`;
+    }
+}
+exports.ForbiddenInstructionInViewCodeError = ForbiddenInstructionInViewCodeError;
+/**
+ *  @category Error
+ *  @description Error that indicates parameters are being passed when it is not required
+ */
+class NoParameterExpectedError extends octez_js_core_1.ParameterValidationError {
+    constructor(viewName, args) {
+        super();
+        this.viewName = viewName;
+        this.args = args;
+        this.name = 'NoParameterExpectedError';
+        this.message = `${viewName} Received ${args.length} arguments while expecting no parameter or 'Unit'`;
+    }
+}
+exports.NoParameterExpectedError = NoParameterExpectedError;

package/dist/lib/handlers/http-handler.js

@@ -0,0 +1,31 @@
+"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.HttpHandler = void 0;
+const octez_js_http_utils_1 = require("@tezos-x/octez.js-http-utils");
+class HttpHandler {
+    constructor() {
+        this.httpBackend = new octez_js_http_utils_1.HttpBackend();
+    }
+    getMetadata(_contractAbstraction_1, _a, _context_1) {
+        return __awaiter(this, arguments, void 0, function* (_contractAbstraction, { protocol, location }, _context) {
+            return this.httpBackend.createRequest({
+                url: `${protocol}:${decodeURIComponent(location)}`,
+                method: 'GET',
+                headers: {
+                    'Content-Type': 'text/plain; charset=utf-8'
+                },
+                json: false
+            });
+        });
+    }
+}
+exports.HttpHandler = HttpHandler;

package/dist/lib/handlers/ipfs-handler.js

@@ -0,0 +1,32 @@
+"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.IpfsHttpHandler = void 0;
+const octez_js_http_utils_1 = require("@tezos-x/octez.js-http-utils");
+class IpfsHttpHandler {
+    constructor(ipfsGatheway) {
+        this.httpBackend = new octez_js_http_utils_1.HttpBackend();
+        this._ipfsGateway = ipfsGatheway ? ipfsGatheway : 'ipfs.io';
+    }
+    getMetadata(_contractAbstraction_1, _a, _context_1) {
+        return __awaiter(this, arguments, void 0, function* (_contractAbstraction, { location }, _context) {
+            return this.httpBackend.createRequest({
+                url: `https://${this._ipfsGateway}/ipfs/${location.substring(2)}/`,
+                method: 'GET',
+                headers: {
+                    'Content-Type': 'text/plain; charset=utf-8'
+                },
+                json: false
+            });
+        });
+    }
+}
+exports.IpfsHttpHandler = IpfsHttpHandler;

package/dist/lib/handlers/tezos-storage-handler.js

@@ -0,0 +1,62 @@
+"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.TezosStorageHandler = void 0;
+const octez_js_michelson_encoder_1 = require("@tezos-x/octez.js-michelson-encoder");
+const octez_js_utils_1 = require("@tezos-x/octez.js-utils");
+const errors_1 = require("../errors");
+const typeOfValueToFind = {
+    prim: 'big_map',
+    args: [{ prim: 'string' }, { prim: 'bytes' }],
+    annots: ['%metadata'],
+};
+class TezosStorageHandler {
+    constructor() {
+        this.TEZOS_STORAGE_REGEX = /^(?:\/\/(KT1\w{33})(?:\.(.+))?\/)?([\w|%]+)$/;
+    }
+    getMetadata(contractAbstraction_1, _a, context_1) {
+        return __awaiter(this, arguments, void 0, function* (contractAbstraction, { location }, context) {
+            const parsedTezosStorageUri = this.parseTezosStorageUri(location);
+            if (!parsedTezosStorageUri) {
+                throw new errors_1.InvalidUriError(`tezos-storage:${location}`);
+            }
+            const script = yield context.readProvider.getScript(parsedTezosStorageUri.contractAddress || contractAbstraction.address, 'head');
+            const bigMapId = octez_js_michelson_encoder_1.Schema.fromRPCResponse({ script }).FindFirstInTopLevelPair(script.storage, typeOfValueToFind);
+            if (!bigMapId || !bigMapId.int) {
+                throw new errors_1.BigMapContractMetadataNotFoundError(bigMapId);
+            }
+            const bytes = yield context.contract.getBigMapKeyByID(bigMapId.int.toString(), parsedTezosStorageUri.path, new octez_js_michelson_encoder_1.Schema(typeOfValueToFind));
+            if (!bytes) {
+                throw new errors_1.ContractMetadataNotFoundError(`No '${parsedTezosStorageUri.path}' key found in the big map %metadata of the contract ${parsedTezosStorageUri.contractAddress || contractAbstraction.address}`);
+            }
+            if (!/^[0-9a-fA-F]*$/.test(bytes)) {
+                throw new errors_1.InvalidContractMetadataTypeError();
+            }
+            return (0, octez_js_utils_1.bytesToString)(bytes);
+        });
+    }
+    /**
+     * @description Extract the smart contract address, the network and the path pointing to the metadata from the uri
+     * @returns an object which contains the properties allowing to find where the metadata are located or it returns undefined if the uri is not valid
+     * @param tezosStorageURI URI (without the tezos-storage prefix)
+     */
+    parseTezosStorageUri(tezosStorageURI) {
+        const extractor = this.TEZOS_STORAGE_REGEX.exec(tezosStorageURI);
+        if (!extractor)
+            return;
+        return {
+            contractAddress: extractor[1],
+            network: extractor[2],
+            path: decodeURIComponent(extractor[3]),
+        };
+    }
+}
+exports.TezosStorageHandler = TezosStorageHandler;

package/dist/lib/metadata-interface.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewImplementationType = void 0;
+var ViewImplementationType;
+(function (ViewImplementationType) {
+    ViewImplementationType["MICHELSON_STORAGE"] = "michelsonStorageView";
+    ViewImplementationType["REST_API_QUERY"] = "restApiQuery";
+})(ViewImplementationType || (exports.ViewImplementationType = ViewImplementationType = {}));

package/dist/lib/metadata-provider.js

@@ -0,0 +1,68 @@
+"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.MetadataProvider = void 0;
+const errors_1 = require("./errors");
+const tzip16_utils_1 = require("./tzip16-utils");
+/**
+ * @description: Metadata Provider
+ */
+class MetadataProvider {
+    constructor(handlers) {
+        this.handlers = handlers;
+        this.PROTOCOL_REGEX = /(?:sha256:\/\/0x(.*)\/)?(https?|ipfs|tezos-storage):(.*)/;
+    }
+    /**
+     * @description Fetch the metadata by using the appropriate handler based on the protcol found in the URI
+     * @returns an object which contains the uri, the metadata, an optional integrity check result and an optional SHA256 hash
+     * @param _contractAbstraction the contract abstraction which contains the URI in its storage
+     * @param _uri the decoded uri found in the storage
+     * @param context the TezosToolkit Context
+     */
+    provideMetadata(contractAbstraction, uri, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const uriInfo = this.extractProtocolInfo(uri);
+            if (!uriInfo || !uriInfo.location) {
+                throw new errors_1.InvalidUriError(uri);
+            }
+            const handler = this.handlers.get(uriInfo.protocol);
+            if (!handler) {
+                throw new errors_1.ProtocolNotSupportedError(uriInfo.protocol);
+            }
+            const metadata = yield handler.getMetadata(contractAbstraction, uriInfo, context);
+            const sha256Hash = (0, tzip16_utils_1.calculateSHA256Hash)(metadata);
+            let metadataJSON;
+            try {
+                metadataJSON = JSON.parse(metadata);
+            }
+            catch (ex) {
+                throw new errors_1.InvalidContractMetadataError(metadata);
+            }
+            return {
+                uri,
+                metadata: metadataJSON,
+                integrityCheckResult: uriInfo.sha256hash ? uriInfo.sha256hash === sha256Hash : undefined,
+                sha256Hash: uriInfo.sha256hash ? sha256Hash : undefined,
+            };
+        });
+    }
+    extractProtocolInfo(_uri) {
+        const extractor = this.PROTOCOL_REGEX.exec(_uri);
+        if (!extractor)
+            return;
+        return {
+            sha256hash: extractor[1],
+            protocol: extractor[2],
+            location: extractor[3],
+        };
+    }
+}
+exports.MetadataProvider = MetadataProvider;

package/dist/lib/octez.js-tzip16.js

@@ -0,0 +1,36 @@
+"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 });
+exports.VERSION = void 0;
+/**
+ * @packageDocumentation
+ * @module @tezos-x/octez.js-tzip16
+ */
+__exportStar(require("./handlers/http-handler"), exports);
+__exportStar(require("./handlers/tezos-storage-handler"), exports);
+__exportStar(require("./handlers/ipfs-handler"), exports);
+__exportStar(require("./composer"), exports);
+__exportStar(require("./metadata-interface"), exports);
+__exportStar(require("./metadata-provider"), exports);
+__exportStar(require("./tzip16-contract-abstraction"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./tzip16-extension"), exports);
+__exportStar(require("./tzip16-utils"), exports);
+__exportStar(require("./viewKind/interface"), exports);
+__exportStar(require("./viewKind/michelson-storage-view"), exports);
+__exportStar(require("./viewKind/viewFactory"), exports);
+var version_1 = require("./version");
+Object.defineProperty(exports, "VERSION", { enumerable: true, get: function () { return version_1.VERSION; } });

package/dist/lib/tzip16-contract-abstraction.js

@@ -0,0 +1,174 @@
+"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.Tzip16ContractAbstraction = void 0;
+const octez_js_1 = require("@tezos-x/octez.js");
+const octez_js_utils_1 = require("@tezos-x/octez.js-utils");
+const errors_1 = require("./errors");
+const bignumber_js_1 = require("bignumber.js");
+const octez_js_michelson_encoder_1 = require("@tezos-x/octez.js-michelson-encoder");
+const viewFactory_1 = require("./viewKind/viewFactory");
+const metadataBigMapType = {
+    prim: 'big_map',
+    args: [{ prim: 'string' }, { prim: 'bytes' }],
+    annots: ['%metadata'],
+};
+class Tzip16ContractAbstraction {
+    constructor(constractAbstraction, context) {
+        this.constractAbstraction = constractAbstraction;
+        this.context = context;
+        this._viewFactory = new viewFactory_1.ViewFactory();
+        this._metadataViewsObject = {};
+        this._metadataProvider = context.metadataProvider;
+    }
+    findMetadataBigMap() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const metadataBigMapId = this.constractAbstraction.schema.FindFirstInTopLevelPair(yield this.context.readProvider.getStorage(this.constractAbstraction.address, 'head'), metadataBigMapType);
+            if (!metadataBigMapId || !metadataBigMapId.int) {
+                throw new errors_1.BigMapContractMetadataNotFoundError(metadataBigMapId);
+            }
+            return new octez_js_1.BigMapAbstraction(new bignumber_js_1.default(metadataBigMapId['int']), new octez_js_michelson_encoder_1.Schema(metadataBigMapType), this.context.contract);
+        });
+    }
+    getUriOrFail() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const metadataBigMap = yield this.findMetadataBigMap();
+            const uri = yield metadataBigMap.get('');
+            if (!uri) {
+                throw new errors_1.UriNotFoundError();
+            }
+            return uri;
+        });
+    }
+    /**
+     * @description Return an object containing the metadata, the uri, an optional integrity check result and an optional sha256 hash
+     */
+    getMetadata() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataProvider) {
+                throw new errors_1.UnconfiguredContractMetadataProviderError();
+            }
+            if (!this._metadataEnvelope) {
+                const uri = yield this.getUriOrFail();
+                this._metadataEnvelope = yield this._metadataProvider.provideMetadata(this.constractAbstraction, (0, octez_js_utils_1.bytesToString)(uri), this.context);
+            }
+            return this._metadataEnvelope;
+        });
+    }
+    metadataName() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataEnvelope) {
+                yield this.getMetadata();
+            }
+            return this._metadataEnvelope.metadata.name;
+        });
+    }
+    metadataDescription() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataEnvelope)
+                yield this.getMetadata();
+            return this._metadataEnvelope.metadata.description;
+        });
+    }
+    metadataVersion() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataEnvelope)
+                yield this.getMetadata();
+            return this._metadataEnvelope.metadata.version;
+        });
+    }
+    metadataLicense() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataEnvelope)
+                yield this.getMetadata();
+            return this._metadataEnvelope.metadata.license;
+        });
+    }
+    metadataAuthors() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataEnvelope)
+                yield this.getMetadata();
+            return this._metadataEnvelope.metadata.authors;
+        });
+    }
+    metadataHomepage() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataEnvelope)
+                yield this.getMetadata();
+            return this._metadataEnvelope.metadata.homepage;
+        });
+    }
+    metadataSource() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataEnvelope)
+                yield this.getMetadata();
+            return this._metadataEnvelope.metadata.source;
+        });
+    }
+    metadataInterfaces() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataEnvelope)
+                yield this.getMetadata();
+            return this._metadataEnvelope.metadata.interfaces;
+        });
+    }
+    metadataErrors() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataEnvelope)
+                yield this.getMetadata();
+            return this._metadataEnvelope.metadata.errors;
+        });
+    }
+    metadataViews() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (Object.keys(this._metadataViewsObject).length === 0) {
+                yield this.initializeMetadataViewsList();
+            }
+            return this._metadataViewsObject;
+        });
+    }
+    initializeMetadataViewsList() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const { metadata } = yield this.getMetadata();
+            const metadataViews = {};
+            (_a = metadata.views) === null || _a === void 0 ? void 0 : _a.forEach((view) => this.createViewImplementations(view, metadataViews));
+            this._metadataViewsObject = metadataViews;
+        });
+    }
+    generateIndexedViewName(viewName, metadataViews) {
+        let i = 1;
+        if (viewName in metadataViews) {
+            while (`${viewName}${i}` in metadataViews) {
+                i++;
+            }
+            viewName = `${viewName}${i}`;
+        }
+        return viewName;
+    }
+    createViewImplementations(view, metadataViews) {
+        var _a;
+        for (const viewImplementation of (_a = view === null || view === void 0 ? void 0 : view.implementations) !== null && _a !== void 0 ? _a : []) {
+            if (view.name) {
+                // when views have the same name, add an index at the end of the name
+                const viewName = this.generateIndexedViewName(view.name, metadataViews);
+                const metadataView = this._viewFactory.getView(viewName, this.context.rpc, this.context.readProvider, this.constractAbstraction, viewImplementation);
+                if (metadataView) {
+                    metadataViews[viewName] = metadataView;
+                }
+                else {
+                    console.warn(`Skipped generating ${viewName} because the view has an unsupported type: ${this._viewFactory.getImplementationType(viewImplementation)}`);
+                }
+            }
+        }
+    }
+}
+exports.Tzip16ContractAbstraction = Tzip16ContractAbstraction;

package/dist/lib/tzip16-extension.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tzip16Module = exports.DEFAULT_HANDLERS = void 0;
+const metadata_provider_1 = require("./metadata-provider");
+const http_handler_1 = require("./handlers/http-handler");
+const tezos_storage_handler_1 = require("./handlers/tezos-storage-handler");
+const ipfs_handler_1 = require("./handlers/ipfs-handler");
+exports.DEFAULT_HANDLERS = new Map([
+    ['http', new http_handler_1.HttpHandler()],
+    ['https', new http_handler_1.HttpHandler()],
+    ['tezos-storage', new tezos_storage_handler_1.TezosStorageHandler()],
+    ['ipfs', new ipfs_handler_1.IpfsHttpHandler()]
+]);
+class Tzip16Module {
+    constructor(metadataProvider) {
+        this._metadataProvider = metadataProvider ? metadataProvider : new metadata_provider_1.MetadataProvider(exports.DEFAULT_HANDLERS);
+    }
+    configureContext(context) {
+        Object.assign(context, { metadataProvider: this._metadataProvider });
+    }
+}
+exports.Tzip16Module = Tzip16Module;