@imtbl/blockchain-data 2.0.0-alpha.0

package/LICENSE.md

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+   Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work,
+   excluding those notices that do not pertain to any part of
+   the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,58 @@
+# About
+
+The Blockchain Data SDK provides a set of wrapper functions for interacting with the Immutable Blockchain Data APIs. It provides a simple and easy-to-use interface for querying blockchain data, such as assets, orders, and trades. 
+
+[Read more about the Blockchain Data APIs in our docs here](https://docs.immutable.com/docs/zkEVM/products/blockchain-data).
+
+# Table of Contents
+
+- [Usage](#usage)
+- [Installation](#installation)
+  - [Individual Package Installation](#individual-package-installation)
+  - [SDK Installation](#sdk-installation)
+    - [Conditional Exports](#conditional-exports)
+    - [Direct Imports](#direct-imports)
+
+# Usage
+
+You can find an example usage of this package in the example set up [here](https://github.com/immutable/ts-immutable-sdk/tree/main/examples/blockchain-data)
+
+# Installation
+
+## Individual Package Installation
+
+To install this package, run the following command:
+
+```sh
+npm add @imtbl/blockchain-data
+# or
+yarn add @imtbl/blockchain-data
+# or
+pnpm add @imtbl/blockchain-data
+```
+
+## SDK Installation
+
+This package is also included within the [`@imtbl/sdk` NPM package](https://www.npmjs.com/package/@imtbl/sdk) and can be re-exported directly from there.
+
+### Conditional Exports
+
+If your environment supports conditional exports, you can import the contents of this package directly from the `@imtbl/sdk` package using the `@imtbl/sdk/blockchain_data` import path like so:
+
+```ts
+import { APIError, BlockchainData } from '@imtbl/sdk/blockchain_data';
+```
+
+This is the recommended way of consuming this package, as it allows for better tree-shaking and smaller bundle sizes.
+
+### Direct Imports
+
+If your environment does not support conditional exports, you will need to import the contents of this package directly from the `@imtbl/sdk` package like so:
+
+```ts
+import { blockchainData } from '@imtbl/sdk';
+
+const { APIError, BlockchainData } = blockchainData;
+```
+
+However this method will result in a larger bundle size as the entire `@imtbl/blockchain-data` package will be included in your bundle.

package/dist/browser/index.js

@@ -0,0 +1,2 @@
+import {mr}from'@imtbl/generated-clients';export{BlockchainData as Types}from'@imtbl/generated-clients';import {Environment,addKeysToHeadersOverride}from'@imtbl/config';import f from'axios';var r=class extends Error{code;details;link;traceId;constructor({message:e,code:t,details:u,link:h,trace_id:p}){super(e),this.code=t,this.details=u,this.link=h,this.traceId=p;}};var R={sdkVersion:"ts-immutable-sdk-multi-rollup-api-client-2.0.0-alpha.0"},c=a=>{let{baseConfig:e,basePath:t,headers:u}=a;if(!t.trim())throw Error("basePath can not be empty");let h={...u||{},...addKeysToHeadersOverride(e,a)||{},...R},p={...e,basePath:t,baseOptions:{headers:h}};return new mr.Configuration(p)},l=class{apiConfig;baseConfig;constructor({baseConfig:e,overrides:t}){if(this.baseConfig=e,t)this.apiConfig=c(t);else switch(e.environment){case Environment.SANDBOX:{this.apiConfig=c({basePath:"https://api.sandbox.immutable.com",baseConfig:e});break}case Environment.PRODUCTION:{this.apiConfig=c({basePath:"https://api.immutable.com",baseConfig:e});break}default:this.apiConfig=c({basePath:"https://api.sandbox.immutable.com",baseConfig:e});}}};function s(a){if(f.isAxiosError(a)&&a.response){let e=a.response.data;return e.code&&e.message?new r({code:e.code,message:e.message,details:e.details||null,link:e.link||"",trace_id:e.trace_id||""}):new r({code:a.code??a.response?.status.toString()??"unknown_error_code",message:String(a),details:null,link:"",trace_id:""})}return new r({code:"unknown_error_code",message:String(a),details:null,link:"",trace_id:""})}var y=class{config;activities;chains;collections;nfts;nftOwners;tokens;metadata;crafting;pricing;metadataSearch;constructor(e){this.config=new l(e),this.activities=new mr.ActivitiesApi(this.config.apiConfig),this.chains=new mr.ChainsApi(this.config.apiConfig),this.collections=new mr.CollectionsApi(this.config.apiConfig),this.nfts=new mr.NftsApi(this.config.apiConfig),this.nftOwners=new mr.NftOwnersApi(this.config.apiConfig),this.tokens=new mr.TokensApi(this.config.apiConfig),this.metadata=new mr.MetadataApi(this.config.apiConfig),this.crafting=new mr.CraftingApi(this.config.apiConfig),this.pricing=new mr.PricingApi(this.config.apiConfig),this.metadataSearch=new mr.MetadataSearchApi(this.config.apiConfig);}async listActivities(e){return await this.activities.listActivities(e).then(t=>t.data).catch(t=>{throw s(t)})}async listActivityHistory(e){return await this.activities.listActivityHistory(e).then(t=>t.data).catch(t=>{throw s(t)})}async getActivity(e){return await this.activities.getActivity(e).then(t=>t.data).catch(t=>{throw s(t)})}async listChains(e){return await this.chains.listChains(e).then(t=>t.data).catch(t=>{throw s(t)})}async listCollections(e){return await this.collections.listCollections(e).then(t=>t.data).catch(t=>{throw s(t)})}async listCollectionsByNFTOwner(e){return await this.collections.listCollectionsByNFTOwner(e).then(t=>t.data).catch(t=>{throw s(t)})}async getCollection(e){return await this.collections.getCollection(e).then(t=>t.data).catch(t=>{throw s(t)})}async getNFT(e){return await this.nfts.getNFT(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTs(e){return await this.nfts.listNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTsByAccountAddress(e){return await this.nfts.listNFTsByAccountAddress(e).then(t=>t.data).catch(t=>{throw s(t)})}async listAllNFTs(e){return await this.nfts.listAllNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async createMintRequest(e){return await this.nfts.createMintRequest(e).then(t=>t.data).catch(t=>{throw s(t)})}async listMintRequests(e){return await this.nfts.listMintRequests(e).then(t=>t.data).catch(t=>{throw s(t)})}async getMintRequest(e){return await this.nfts.getMintRequest(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTOwners(e){return await this.nftOwners.listNFTOwners(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTOwnersByContractAddress(e){return await this.nftOwners.listOwnersByContractAddress(e).then(t=>t.data).catch(t=>{throw s(t)})}async listAllNFTOwners(e){return await this.nftOwners.listAllNFTOwners(e).then(t=>t.data).catch(t=>{throw s(t)})}async listTokens(e){return await this.tokens.listERC20Tokens(e).then(t=>t.data).catch(t=>{throw s(t)})}async getToken(e){return await this.tokens.getERC20Token(e).then(t=>t.data).catch(t=>{throw s(t)})}async getMetadata(e){return await this.metadata.getMetadata(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTMetadataByContractAddress(e){return await this.metadata.listMetadata(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTMetadataByChain(e){return await this.metadata.listMetadataForChain(e).then(t=>t.data).catch(t=>{throw s(t)})}async refreshCollectionMetadata(e){return await this.collections.refreshCollectionMetadata(e).then(t=>t.data).catch(t=>{throw s(t)})}async refreshNFTMetadata(e){return await this.metadata.refreshNFTMetadataByTokenID(e).then(t=>t.data).catch(t=>{throw s(t)})}async refreshStackedMetadata(e){return await this.metadata.refreshMetadataByID(e).then(t=>t.data).catch(t=>{throw s(t)})}async signCraftingPayload(e){return await this.crafting.signCraftingPayload(e).then(t=>t.data).catch(t=>{throw s(t)})}async listFilters(e){return await this.metadataSearch.listFilters(e).then(t=>t.data).catch(t=>{throw s(t)})}async searchNFTs(e){return await this.metadataSearch.searchNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async searchStacks(e){return await this.metadataSearch.searchStacks(e).then(t=>t.data).catch(t=>{throw s(t)})}async quotesForNFTs(e){return await this.pricing.quotesForNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async quotesForStacks(e){return await this.pricing.quotesForStacks(e).then(t=>t.data).catch(t=>{throw s(t)})}async listStacks(e){return await this.metadata.listStacks(e).then(t=>t.data).catch(t=>{throw s(t)})}};
+export{r as APIError,y as BlockchainData};

package/dist/node/index.cjs

@@ -0,0 +1,2 @@
+'use strict';var generatedClients=require('@imtbl/generated-clients'),config=require('@imtbl/config'),m=require('axios');function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var m__default=/*#__PURE__*/_interopDefault(m);var r=class extends Error{code;details;link;traceId;constructor({message:e,code:t,details:c,link:l,trace_id:u}){super(e),this.code=t,this.details=c,this.link=l,this.traceId=u;}};var d={sdkVersion:"ts-immutable-sdk-multi-rollup-api-client-2.0.0-alpha.0"},n=a=>{let{baseConfig:e,basePath:t,headers:c}=a;if(!t.trim())throw Error("basePath can not be empty");let l={...c||{},...config.addKeysToHeadersOverride(e,a)||{},...d},u={...e,basePath:t,baseOptions:{headers:l}};return new generatedClients.mr.Configuration(u)},o=class{apiConfig;baseConfig;constructor({baseConfig:e,overrides:t}){if(this.baseConfig=e,t)this.apiConfig=n(t);else switch(e.environment){case config.Environment.SANDBOX:{this.apiConfig=n({basePath:"https://api.sandbox.immutable.com",baseConfig:e});break}case config.Environment.PRODUCTION:{this.apiConfig=n({basePath:"https://api.immutable.com",baseConfig:e});break}default:this.apiConfig=n({basePath:"https://api.sandbox.immutable.com",baseConfig:e});}}};function s(a){if(m__default.default.isAxiosError(a)&&a.response){let e=a.response.data;return e.code&&e.message?new r({code:e.code,message:e.message,details:e.details||null,link:e.link||"",trace_id:e.trace_id||""}):new r({code:a.code??a.response?.status.toString()??"unknown_error_code",message:String(a),details:null,link:"",trace_id:""})}return new r({code:"unknown_error_code",message:String(a),details:null,link:"",trace_id:""})}var h=class{config;activities;chains;collections;nfts;nftOwners;tokens;metadata;crafting;pricing;metadataSearch;constructor(e){this.config=new o(e),this.activities=new generatedClients.mr.ActivitiesApi(this.config.apiConfig),this.chains=new generatedClients.mr.ChainsApi(this.config.apiConfig),this.collections=new generatedClients.mr.CollectionsApi(this.config.apiConfig),this.nfts=new generatedClients.mr.NftsApi(this.config.apiConfig),this.nftOwners=new generatedClients.mr.NftOwnersApi(this.config.apiConfig),this.tokens=new generatedClients.mr.TokensApi(this.config.apiConfig),this.metadata=new generatedClients.mr.MetadataApi(this.config.apiConfig),this.crafting=new generatedClients.mr.CraftingApi(this.config.apiConfig),this.pricing=new generatedClients.mr.PricingApi(this.config.apiConfig),this.metadataSearch=new generatedClients.mr.MetadataSearchApi(this.config.apiConfig);}async listActivities(e){return await this.activities.listActivities(e).then(t=>t.data).catch(t=>{throw s(t)})}async listActivityHistory(e){return await this.activities.listActivityHistory(e).then(t=>t.data).catch(t=>{throw s(t)})}async getActivity(e){return await this.activities.getActivity(e).then(t=>t.data).catch(t=>{throw s(t)})}async listChains(e){return await this.chains.listChains(e).then(t=>t.data).catch(t=>{throw s(t)})}async listCollections(e){return await this.collections.listCollections(e).then(t=>t.data).catch(t=>{throw s(t)})}async listCollectionsByNFTOwner(e){return await this.collections.listCollectionsByNFTOwner(e).then(t=>t.data).catch(t=>{throw s(t)})}async getCollection(e){return await this.collections.getCollection(e).then(t=>t.data).catch(t=>{throw s(t)})}async getNFT(e){return await this.nfts.getNFT(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTs(e){return await this.nfts.listNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTsByAccountAddress(e){return await this.nfts.listNFTsByAccountAddress(e).then(t=>t.data).catch(t=>{throw s(t)})}async listAllNFTs(e){return await this.nfts.listAllNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async createMintRequest(e){return await this.nfts.createMintRequest(e).then(t=>t.data).catch(t=>{throw s(t)})}async listMintRequests(e){return await this.nfts.listMintRequests(e).then(t=>t.data).catch(t=>{throw s(t)})}async getMintRequest(e){return await this.nfts.getMintRequest(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTOwners(e){return await this.nftOwners.listNFTOwners(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTOwnersByContractAddress(e){return await this.nftOwners.listOwnersByContractAddress(e).then(t=>t.data).catch(t=>{throw s(t)})}async listAllNFTOwners(e){return await this.nftOwners.listAllNFTOwners(e).then(t=>t.data).catch(t=>{throw s(t)})}async listTokens(e){return await this.tokens.listERC20Tokens(e).then(t=>t.data).catch(t=>{throw s(t)})}async getToken(e){return await this.tokens.getERC20Token(e).then(t=>t.data).catch(t=>{throw s(t)})}async getMetadata(e){return await this.metadata.getMetadata(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTMetadataByContractAddress(e){return await this.metadata.listMetadata(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTMetadataByChain(e){return await this.metadata.listMetadataForChain(e).then(t=>t.data).catch(t=>{throw s(t)})}async refreshCollectionMetadata(e){return await this.collections.refreshCollectionMetadata(e).then(t=>t.data).catch(t=>{throw s(t)})}async refreshNFTMetadata(e){return await this.metadata.refreshNFTMetadataByTokenID(e).then(t=>t.data).catch(t=>{throw s(t)})}async refreshStackedMetadata(e){return await this.metadata.refreshMetadataByID(e).then(t=>t.data).catch(t=>{throw s(t)})}async signCraftingPayload(e){return await this.crafting.signCraftingPayload(e).then(t=>t.data).catch(t=>{throw s(t)})}async listFilters(e){return await this.metadataSearch.listFilters(e).then(t=>t.data).catch(t=>{throw s(t)})}async searchNFTs(e){return await this.metadataSearch.searchNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async searchStacks(e){return await this.metadataSearch.searchStacks(e).then(t=>t.data).catch(t=>{throw s(t)})}async quotesForNFTs(e){return await this.pricing.quotesForNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async quotesForStacks(e){return await this.pricing.quotesForStacks(e).then(t=>t.data).catch(t=>{throw s(t)})}async listStacks(e){return await this.metadata.listStacks(e).then(t=>t.data).catch(t=>{throw s(t)})}};
+Object.defineProperty(exports,"Types",{enumerable:true,get:function(){return generatedClients.BlockchainData}});exports.APIError=r;exports.BlockchainData=h;

package/dist/node/index.js

@@ -0,0 +1,2 @@
+import {mr}from'@imtbl/generated-clients';export{BlockchainData as Types}from'@imtbl/generated-clients';import {Environment,addKeysToHeadersOverride}from'@imtbl/config';import m from'axios';var r=class extends Error{code;details;link;traceId;constructor({message:e,code:t,details:c,link:l,trace_id:u}){super(e),this.code=t,this.details=c,this.link=l,this.traceId=u;}};var d={sdkVersion:"ts-immutable-sdk-multi-rollup-api-client-2.0.0-alpha.0"},n=a=>{let{baseConfig:e,basePath:t,headers:c}=a;if(!t.trim())throw Error("basePath can not be empty");let l={...c||{},...addKeysToHeadersOverride(e,a)||{},...d},u={...e,basePath:t,baseOptions:{headers:l}};return new mr.Configuration(u)},o=class{apiConfig;baseConfig;constructor({baseConfig:e,overrides:t}){if(this.baseConfig=e,t)this.apiConfig=n(t);else switch(e.environment){case Environment.SANDBOX:{this.apiConfig=n({basePath:"https://api.sandbox.immutable.com",baseConfig:e});break}case Environment.PRODUCTION:{this.apiConfig=n({basePath:"https://api.immutable.com",baseConfig:e});break}default:this.apiConfig=n({basePath:"https://api.sandbox.immutable.com",baseConfig:e});}}};function s(a){if(m.isAxiosError(a)&&a.response){let e=a.response.data;return e.code&&e.message?new r({code:e.code,message:e.message,details:e.details||null,link:e.link||"",trace_id:e.trace_id||""}):new r({code:a.code??a.response?.status.toString()??"unknown_error_code",message:String(a),details:null,link:"",trace_id:""})}return new r({code:"unknown_error_code",message:String(a),details:null,link:"",trace_id:""})}var h=class{config;activities;chains;collections;nfts;nftOwners;tokens;metadata;crafting;pricing;metadataSearch;constructor(e){this.config=new o(e),this.activities=new mr.ActivitiesApi(this.config.apiConfig),this.chains=new mr.ChainsApi(this.config.apiConfig),this.collections=new mr.CollectionsApi(this.config.apiConfig),this.nfts=new mr.NftsApi(this.config.apiConfig),this.nftOwners=new mr.NftOwnersApi(this.config.apiConfig),this.tokens=new mr.TokensApi(this.config.apiConfig),this.metadata=new mr.MetadataApi(this.config.apiConfig),this.crafting=new mr.CraftingApi(this.config.apiConfig),this.pricing=new mr.PricingApi(this.config.apiConfig),this.metadataSearch=new mr.MetadataSearchApi(this.config.apiConfig);}async listActivities(e){return await this.activities.listActivities(e).then(t=>t.data).catch(t=>{throw s(t)})}async listActivityHistory(e){return await this.activities.listActivityHistory(e).then(t=>t.data).catch(t=>{throw s(t)})}async getActivity(e){return await this.activities.getActivity(e).then(t=>t.data).catch(t=>{throw s(t)})}async listChains(e){return await this.chains.listChains(e).then(t=>t.data).catch(t=>{throw s(t)})}async listCollections(e){return await this.collections.listCollections(e).then(t=>t.data).catch(t=>{throw s(t)})}async listCollectionsByNFTOwner(e){return await this.collections.listCollectionsByNFTOwner(e).then(t=>t.data).catch(t=>{throw s(t)})}async getCollection(e){return await this.collections.getCollection(e).then(t=>t.data).catch(t=>{throw s(t)})}async getNFT(e){return await this.nfts.getNFT(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTs(e){return await this.nfts.listNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTsByAccountAddress(e){return await this.nfts.listNFTsByAccountAddress(e).then(t=>t.data).catch(t=>{throw s(t)})}async listAllNFTs(e){return await this.nfts.listAllNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async createMintRequest(e){return await this.nfts.createMintRequest(e).then(t=>t.data).catch(t=>{throw s(t)})}async listMintRequests(e){return await this.nfts.listMintRequests(e).then(t=>t.data).catch(t=>{throw s(t)})}async getMintRequest(e){return await this.nfts.getMintRequest(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTOwners(e){return await this.nftOwners.listNFTOwners(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTOwnersByContractAddress(e){return await this.nftOwners.listOwnersByContractAddress(e).then(t=>t.data).catch(t=>{throw s(t)})}async listAllNFTOwners(e){return await this.nftOwners.listAllNFTOwners(e).then(t=>t.data).catch(t=>{throw s(t)})}async listTokens(e){return await this.tokens.listERC20Tokens(e).then(t=>t.data).catch(t=>{throw s(t)})}async getToken(e){return await this.tokens.getERC20Token(e).then(t=>t.data).catch(t=>{throw s(t)})}async getMetadata(e){return await this.metadata.getMetadata(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTMetadataByContractAddress(e){return await this.metadata.listMetadata(e).then(t=>t.data).catch(t=>{throw s(t)})}async listNFTMetadataByChain(e){return await this.metadata.listMetadataForChain(e).then(t=>t.data).catch(t=>{throw s(t)})}async refreshCollectionMetadata(e){return await this.collections.refreshCollectionMetadata(e).then(t=>t.data).catch(t=>{throw s(t)})}async refreshNFTMetadata(e){return await this.metadata.refreshNFTMetadataByTokenID(e).then(t=>t.data).catch(t=>{throw s(t)})}async refreshStackedMetadata(e){return await this.metadata.refreshMetadataByID(e).then(t=>t.data).catch(t=>{throw s(t)})}async signCraftingPayload(e){return await this.crafting.signCraftingPayload(e).then(t=>t.data).catch(t=>{throw s(t)})}async listFilters(e){return await this.metadataSearch.listFilters(e).then(t=>t.data).catch(t=>{throw s(t)})}async searchNFTs(e){return await this.metadataSearch.searchNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async searchStacks(e){return await this.metadataSearch.searchStacks(e).then(t=>t.data).catch(t=>{throw s(t)})}async quotesForNFTs(e){return await this.pricing.quotesForNFTs(e).then(t=>t.data).catch(t=>{throw s(t)})}async quotesForStacks(e){return await this.pricing.quotesForStacks(e).then(t=>t.data).catch(t=>{throw s(t)})}async listStacks(e){return await this.metadata.listStacks(e).then(t=>t.data).catch(t=>{throw s(t)})}};
+export{r as APIError,h as BlockchainData};

package/dist/types/blockchain-data.d.ts

@@ -0,0 +1,252 @@
+import { BlockchainData as Types } from '@imtbl/generated-clients';
+import { BlockchainDataConfiguration, BlockchainDataModuleConfiguration } from './config';
+export declare class BlockchainData {
+    readonly config: BlockchainDataConfiguration;
+    private readonly activities;
+    private readonly chains;
+    private readonly collections;
+    private readonly nfts;
+    private readonly nftOwners;
+    private readonly tokens;
+    private readonly metadata;
+    private readonly crafting;
+    private readonly pricing;
+    private readonly metadataSearch;
+    constructor(moduleConfig: BlockchainDataModuleConfiguration);
+    /**
+     * List all activities
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of activities
+     * @throws {@link index.APIError}
+     */
+    listActivities(request: Types.ListActivitiesRequestParams): Promise<Types.ListActivitiesResult>;
+    /**
+     * List activities sorted by updated_at timestamp ascending, useful for time based data replication
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of activities
+     * @throws {@link index.APIError}
+     */
+    listActivityHistory(request: Types.ListActivityHistoryRequestParams): Promise<Types.ListActivitiesResult>;
+    /**
+     * Get a single activity by ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a single activity
+     * @throws {@link index.APIError}
+     */
+    getActivity(request: Types.GetActivityRequestParams): Promise<Types.GetActivityResult>;
+    /**
+     * List supported chains
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of supported chains
+     * @throws {@link index.APIError}
+     */
+    listChains(request: Types.ListChainsRequestParams): Promise<Types.ListChainsResult>;
+    /**
+     * List all collections
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of collections
+     * @throws {@link index.APIError}
+     */
+    listCollections(request: Types.ListCollectionsRequestParams): Promise<Types.ListCollectionsResult>;
+    /**
+     * List collections by NFT owner
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of collections
+     * @throws {@link index.APIError}
+     */
+    listCollectionsByNFTOwner(request: Types.ListCollectionsByNFTOwnerRequestParams): Promise<Types.ListCollectionsResult>;
+    /**
+     * Get a collection by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a single collection
+     * @throws {@link index.APIError}
+     */
+    getCollection(request: Types.GetCollectionRequestParams): Promise<Types.GetCollectionResult>;
+    /**
+     * Get NFT by token ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a single NFT
+     * @throws {@link index.APIError}
+     */
+    getNFT(request: Types.GetNFTRequestParams): Promise<Types.GetNFTResult>;
+    /**
+     * List NFTs by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFTs
+     * @throws {@link index.APIError}
+     */
+    listNFTs(request: Types.ListNFTsRequestParams): Promise<Types.ListNFTsResult>;
+    /**
+     * List NFTs by account address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFTs
+     * @throws {@link index.APIError}
+     */
+    listNFTsByAccountAddress(request: Types.ListNFTsByAccountAddressRequestParams): Promise<Types.ListNFTsByOwnerResult>;
+    /**
+     * List All NFTs on a chain
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFTs
+     * @throws {@link index.APIError}
+     */
+    listAllNFTs(request: Types.ListAllNFTsRequestParams): Promise<Types.ListNFTsResult>;
+    /**
+     * Create a mint request to mint a set of NFTs for a given collection
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the remaining rate limits
+     * @throws {@link index.APIError}
+     */
+    createMintRequest(request: Types.CreateMintRequestRequestParams): Promise<Types.CreateMintRequestResult>;
+    /**
+     * List all mint requests for a given contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of mint requests
+     * @throws {@link index.APIError}
+     */
+    listMintRequests(request: Types.ListMintRequestsRequestParams): Promise<Types.ListMintRequestsResult>;
+    /**
+     * Retrieve the status of a single mint request identified by its reference ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a single mint request
+     * @throws {@link index.APIError}
+     */
+    getMintRequest(request: Types.GetMintRequestRequestParams): Promise<Types.ListMintRequestsResult>;
+    /**
+     * List NFT owners by token ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFT owners
+     * @throws {@link index.APIError}
+     */
+    listNFTOwners(request: Types.ListNFTOwnersRequestParams): Promise<Types.ListNFTOwnersResult>;
+    /**
+     * List NFT owners by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFT owners
+     * @throws {@link index.APIError}
+     */
+    listNFTOwnersByContractAddress(request: Types.ListOwnersByContractAddressRequestParams): Promise<Types.ListNFTOwnersResult>;
+    /**
+     * List All NFT owners on a chain
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFT owners
+     * @throws {@link index.APIError}
+     */
+    listAllNFTOwners(request: Types.ListAllNFTOwnersRequestParams): Promise<Types.ListNFTOwnersResult>;
+    /**
+     * List ERC20 Token contracts
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of ERC20 Tokens
+     * @throws {@link index.APIError}
+     */
+    listTokens(request: Types.ListERC20TokensRequestParams): Promise<Types.ListTokensResult>;
+    /**
+     * Get details for an ERC20 Token by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of ERC20 Tokens
+     * @throws {@link index.APIError}
+     */
+    getToken(request: Types.GetERC20TokenRequestParams): Promise<Types.GetTokenResult>;
+    /**
+     * Get metadata by ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a single Metadata
+     * @throws {@link index.APIError}
+     */
+    getMetadata(request: Types.GetMetadataRequestParams): Promise<Types.GetMetadataResult>;
+    /**
+     * List NFT Metadata by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of Metadata
+     * @throws {@link index.APIError}
+     */
+    listNFTMetadataByContractAddress(request: Types.ListMetadataRequestParams): Promise<Types.ListMetadataResult>;
+    /**
+     * List NFT Metadata by chain
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of Metadata
+     * @throws {@link index.APIError}
+     */
+    listNFTMetadataByChain(request: Types.ListMetadataForChainRequestParams): Promise<Types.ListMetadataResult>;
+    /**
+     * Refresh collection metadata
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the updated collection
+     * @throws {@link index.APIError}
+     */
+    refreshCollectionMetadata(request: Types.RefreshCollectionMetadataRequestParams): Promise<Types.RefreshCollectionMetadataResult>;
+    /**
+     * Refresh metadata for specific NFTs
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the remaining rate limits
+     * @throws {@link index.APIError}
+     */
+    refreshNFTMetadata(request: Types.RefreshNFTMetadataByTokenIDRequestParams): Promise<Types.MetadataRefreshRateLimitResult>;
+    /**
+     * Refresh metadata by ID. This will refresh metadata for all NFTs that reference the given metadata ID.
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the remaining rate limits
+     * @throws {@link index.APIError}
+     */
+    refreshStackedMetadata(request: Types.RefreshMetadataByIDRequestParams): Promise<Types.MetadataRefreshRateLimitResult>;
+    /**
+     * Sign a crafting payload
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the signature result
+     * @throws {@link index.APIError}
+     */
+    signCraftingPayload(request: Types.SignCraftingPayloadRequestParams): Promise<Types.SignCraftingResult>;
+    /**
+     * Marketplace APIs
+     * - Metadata search
+     */
+    /**
+     * Get list of metadata filters
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the a list of metadata filters
+     * @throws {@link index.APIError}
+     */
+    listFilters(request: Types.ListFiltersRequestParams): Promise<Types.ListFiltersResult>;
+    /**
+     * Search NFTs
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the a list NFTs with metadata, market and listings information
+     * @throws {@link index.APIError}
+     */
+    searchNFTs(request: Types.SearchNFTsRequestParams): Promise<Types.SearchNFTsResult>;
+    /**
+     * Search NFT stacks
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the a list NFT stacks with stack count, market and listings information
+     * @throws {@link index.APIError}
+     */
+    searchStacks(request: Types.SearchStacksRequestParams): Promise<Types.SearchStacksResult>;
+    /**
+     * Marketplace APIs
+     * - Pricing
+     */
+    /**
+     * Get pricing data for a list of token ids
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the a list of pricing data for particular NFTs
+     * @throws {@link index.APIError}
+     */
+    quotesForNFTs(request: Types.QuotesForNFTsRequestParams): Promise<Types.QuotesForNFTsResult>;
+    /**
+     * Get pricing data for a list of stack ids
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the a list of pricing data for particular stack ids
+     * @throws {@link index.APIError}
+     */
+    quotesForStacks(request: Types.QuotesForStacksRequestParams): Promise<Types.QuotesForStacksResult>;
+    /**
+     * Marketplace APIs
+     * - Metadata
+     */
+    /**
+     * List NFT stack bundles by stack_id.
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFT stacks with stack count, market and listings information
+     * @throws {@link index.APIError}
+     */
+    listStacks(request: Types.ListStacksRequestParams): Promise<Types.StackBundle[]>;
+}

package/dist/types/config/config.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/config/index.d.ts

@@ -0,0 +1,19 @@
+import { ImmutableConfiguration, ModuleConfiguration } from '@imtbl/config';
+import { mr } from '@imtbl/generated-clients';
+export interface APIConfigurationParams {
+    basePath: string;
+    headers?: Record<string, string>;
+    baseConfig?: ImmutableConfiguration;
+}
+/**
+ * createAPIConfiguration to create a custom Configuration
+ * other than the production and sandbox defined below.
+ */
+export declare const createAPIConfiguration: (overrides: APIConfigurationParams) => mr.Configuration;
+export interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
+}
+export declare class BlockchainDataConfiguration {
+    readonly apiConfig: mr.Configuration;
+    readonly baseConfig: ImmutableConfiguration;
+    constructor({ baseConfig, overrides }: BlockchainDataModuleConfiguration);
+}

package/dist/types/index.d.ts

@@ -0,0 +1,12 @@
+import { mr, BlockchainData as Types } from '@imtbl/generated-clients';
+import { APIError } from './types/errors';
+import { BlockchainData } from './blockchain-data';
+import { BlockchainDataModuleConfiguration } from './config';
+/**
+ * @deprecated since version 1.1.5
+ * Please use Types.ActivityType instead
+ * import { Types } from '@imtbl/blockchain-data'
+ */
+type ActivityType = mr.ActivityType;
+export { Types, APIError, BlockchainData };
+export type { BlockchainDataModuleConfiguration, ActivityType };

package/dist/types/types/errors.d.ts

@@ -0,0 +1,20 @@
+import { mr } from '@imtbl/generated-clients';
+interface OpenAPIError extends mr.BasicAPIError {
+    code: string;
+    details: {
+        [key: string]: any;
+    } | null;
+}
+/**
+ * Custom Error class that is returned from the API when a request fails
+ */
+export declare class APIError extends Error {
+    readonly code: string;
+    readonly details: {
+        [key: string]: any;
+    } | null;
+    readonly link: string;
+    readonly traceId: string;
+    constructor({ message, code, details, link, trace_id: traceId, }: OpenAPIError);
+}
+export {};

package/dist/types/utils/formatErrors.d.ts

@@ -0,0 +1,7 @@
+import { APIError } from '../types/errors';
+/**
+ * [Formats an error in the APIError shape](https://axios-http.com/docs/handling_errors)
+ * @param error - The Error object thrown by the request
+ * @returns APIError
+ */
+export declare function formatError(error: unknown): APIError;

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@imtbl/blockchain-data",
+  "description": "Wrapper functions for interacting with Immutable blockchain data APIs",
+  "version": "2.0.0-alpha.0",
+  "author": "Immutable",
+  "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
+  "dependencies": {
+    "@imtbl/config": "2.0.0-alpha.0",
+    "@imtbl/generated-clients": "2.0.0-alpha.0",
+    "axios": "^1.6.5"
+  },
+  "devDependencies": {
+    "@swc/core": "^1.3.36",
+    "@swc/jest": "^0.2.24",
+    "@types/jest": "^29.4.3",
+    "eslint": "^8.40.0",
+    "jest": "^29.4.3",
+    "jest-environment-jsdom": "^29.4.3",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.2"
+  },
+  "exports": {
+    "development": {
+      "types": "./src/index.ts",
+      "browser": "./dist/browser/index.js",
+      "require": "./dist/node/index.cjs",
+      "default": "./dist/node/index.js"
+    },
+    "default": {
+      "types": "./dist/types/index.d.ts",
+      "browser": "./dist/browser/index.js",
+      "require": "./dist/node/index.cjs",
+      "default": "./dist/node/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/immutable/ts-immutable-sdk#readme",
+  "license": "Apache-2.0",
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "browser": "dist/browser/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": "immutable/ts-immutable-sdk.git",
+  "type": "module",
+  "types": "./dist/types/index.d.ts",
+  "scripts": {
+    "build": "pnpm transpile && pnpm typegen",
+    "transpile": "tsup src/index.ts --config ../../../tsup.config.js",
+    "typegen": "tsc --customConditions default --emitDeclarationOnly --outDir dist/types",
+    "lint": "eslint ./src --ext .ts,.jsx,.tsx --max-warnings=0",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "typecheck": "tsc --customConditions default --noEmit --jsx preserve"
+  }
+}