chore(sdk): release v2.2.0

Consensys · Mar 18, 2023 · e7fff42 · e7fff42
1 parent 92a2732
commit e7fff42
Show file tree

Hide file tree

Showing 3 changed files with 158 additions and 16 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -4,6 +4,51 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v2.2.5](https://github.com/ConsenSys/consensys-sdk/compare/v2.1.5...v2.2.5)
+
+> 17 March 2023
+
+- fix: NFTSDK-503 added days for lowest price [`#171`](https://github.com/ConsenSys/consensys-sdk/pull/171)
+- chore: added versioning api header [`#169`](https://github.com/ConsenSys/consensys-sdk/pull/169)
+- fix: NFTSDK-485 added resync flag [`#168`](https://github.com/ConsenSys/consensys-sdk/pull/168)
+- chore: reveal flow e2e test added [`#167`](https://github.com/ConsenSys/consensys-sdk/pull/167)
+- fix: Added some adjustments when Polygon mainnet [`#165`](https://github.com/ConsenSys/consensys-sdk/pull/165)
+- Add new supported networks [`#163`](https://github.com/ConsenSys/consensys-sdk/pull/163)
+- chore: release v2.1.5 [`#160`](https://github.com/ConsenSys/consensys-sdk/pull/160)
+- chore: fix unit tests [`2d5a40b`](https://github.com/ConsenSys/consensys-sdk/commit/2d5a40b1781a90b8a251b391a41e8b958915db0d)
+- chore: add unit tests [`8d590ce`](https://github.com/ConsenSys/consensys-sdk/commit/8d590ce8f14d4b84c775a3838da7920e26c52520)
+- chore: added logs [`bf36144`](https://github.com/ConsenSys/consensys-sdk/commit/bf36144a64f6638d55961dc1c110dcf25e77726c)
+
+#### [v2.1.5](https://github.com/ConsenSys/consensys-sdk/compare/v2.1.4...v2.1.5)
+
+> 7 February 2023
+
+- Update readme 2 [`#159`](https://github.com/ConsenSys/consensys-sdk/pull/159)
+- release v2.1.4 [`#158`](https://github.com/ConsenSys/consensys-sdk/pull/158)
+- chore: release v2.1.4 [`#157`](https://github.com/ConsenSys/consensys-sdk/pull/157)
+- fix: rm type [`#156`](https://github.com/ConsenSys/consensys-sdk/pull/156)
+- feat: update readme [`70f5e3f`](https://github.com/ConsenSys/consensys-sdk/commit/70f5e3f59922d1063f7b87700136fadb6a3e0847)
+- chore: release v2.1.5 [`a921936`](https://github.com/ConsenSys/consensys-sdk/commit/a921936532970fd8d85408d76ccd66ae00a344bf)
+- fix e2e [`42a27cf`](https://github.com/ConsenSys/consensys-sdk/commit/42a27cf51c7c5777c6b4eda1b0da0ac7f467f329)
+
+#### [v2.1.4](https://github.com/ConsenSys/consensys-sdk/compare/v2.1.3...v2.1.4)
+
+> 6 February 2023
+
+- fix: semantic vulnerability [`#155`](https://github.com/ConsenSys/consensys-sdk/pull/155)
+- fix: fix pagination example [`#154`](https://github.com/ConsenSys/consensys-sdk/pull/154)
+- add search nfts fct [`#153`](https://github.com/ConsenSys/consensys-sdk/pull/153)
+- feat: added get owners by token address and token id [`#152`](https://github.com/ConsenSys/consensys-sdk/pull/152)
+- Get collections by wallet [`#150`](https://github.com/ConsenSys/consensys-sdk/pull/150)
+- feat: get nft owners by contract address [`#147`](https://github.com/ConsenSys/consensys-sdk/pull/147)
+- chore: fix lint [`#151`](https://github.com/ConsenSys/consensys-sdk/pull/151)
+- feat: added new function for getting transfers by contract address [`#146`](https://github.com/ConsenSys/consensys-sdk/pull/146)
+- fix: bump package version [`#145`](https://github.com/ConsenSys/consensys-sdk/pull/145)
+- fix: fix usage ts [`#144`](https://github.com/ConsenSys/consensys-sdk/pull/144)
+- chore: added dependency [`abfd1b7`](https://github.com/ConsenSys/consensys-sdk/commit/abfd1b7d285f21100f45c796e14a466555daefbc)
+- chore: rebase [`bc5aada`](https://github.com/ConsenSys/consensys-sdk/commit/bc5aada3e4696f7590907c67e0bfbfd69458d396)
+- chore: added tests [`6968987`](https://github.com/ConsenSys/consensys-sdk/commit/6968987af1e87cf1c4ad83970ab789fe62622655)
+
 #### [v2.1.3](https://github.com/ConsenSys/consensys-sdk/compare/v2.0.3...v2.1.3)
 
 > 23 January 2023

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@infura/sdk",
-  "version": "2.1.5",
+  "version": "2.2.0",
   "description": "Infura SDK: easily manage, interact with and read smart contract on Mainnet, testnet and local",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",

diff --git a/src/services/nft-api.ts b/src/services/nft-api.ts
@@ -57,6 +57,7 @@ export interface Paths {
     get: Operations['NftsController_getOwnersByTokenId'];
   };
   '/networks/{chainId}/nfts/{tokenAddress}/tradePrice': {
+    /** Get the lowest ETH based price for a scpecific token address */
     get: Operations['NftsController_getTradePrice'];
   };
 }
@@ -116,8 +117,6 @@ export interface Components {
         | 'PALM'
         | 'ARBITRUM';
       cursor: string;
-      /** @example 0x0a267cf51ef038fc00e71801f5a524aec06e4f07 */
-      account: string;
       transfers: Components['schemas']['TransfersResultsModel'][];
     };
     SearchNftResult: {
@@ -176,7 +175,7 @@ export interface Components {
       name: string;
       /** @example CNSYS */
       symbol: string;
-      /** @example ERC-721 */
+      /** @example ERC721 */
       tokenType: string;
     };
     AssetsModel: {
@@ -218,7 +217,6 @@ export interface Components {
       total: number;
       /** @example 0x0a267cf51ef038fc00e71801f5a524aec06e4f07 */
       account: string;
-      /** @example NFT */
       cursor: string;
       assets: Components['schemas']['AssetsModel'][];
     };
@@ -355,12 +353,20 @@ export interface Operations {
   /** Gets transfers from a block to block. */
   NftsController_getTransfersfromBlockToBlock: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
       };
       query: {
+        /** The minimum block number to get transfers from */
         fromBlock: number;
+        /** The maximum block number to get transfers from */
         toBlock: number;
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
       };
     };
@@ -375,11 +381,18 @@ export interface Operations {
   /** Gets transfers by block number or block hash. */
   NftsController_getTransfersByBlockNumberOrHash: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
       };
       query: {
+        /** The block hash or block number to get transfers from */
         blockHashNumber: string;
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
       };
     };
@@ -394,12 +407,18 @@ export interface Operations {
   /** Search for Nfts given a string */
   NftsController_searchNfts: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
       };
       query: {
-        /** Query to search with */
+        /** The string query to search */
         query: string;
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
       };
     };
@@ -414,9 +433,14 @@ export interface Operations {
   /** Gets the contract level metadata for a given contract address. */
   NftsController_getCollectionMetadata: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
-        /** Contract address */
+        /** The contract address of the NFT collection */
         tokenAddress: string;
       };
     };
@@ -431,13 +455,21 @@ export interface Operations {
   /** Gets all NFTs for a given contract address (including metadata). */
   NftsController_getNftsForCollection: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
-        /** Contract address */
+        /** The contract address of the NFT collection */
         tokenAddress: string;
       };
       query: {
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
+        /** A boolean to force clear the cache */
+        resync?: boolean;
       };
     };
     responses: {
@@ -451,12 +483,18 @@ export interface Operations {
   /** Gets NFT collections owned by a given wallet address. */
   NftsController_getCollectionsByWalletAddress: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
-        /** Wallet address of the owner of Nfts in collection */
+        /** The wallet address of the owner of the NFTs */
         walletAddress: string;
       };
       query: {
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
       };
     };
@@ -471,12 +509,18 @@ export interface Operations {
   /** Gets all NFTs owned by a given wallet address. */
   NftsController_getNftsForAddress: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
-        /** Wallet address */
+        /** The wallet address of the owner of the NFTs */
         walletAddress: string;
       };
       query: {
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
       };
     };
@@ -491,12 +535,22 @@ export interface Operations {
   /** Gets NFT data for the given NFT token ID and contract address. */
   NftsController_getNftMetadata: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
-        /** Contract address */
+        /** The contract address of the NFT collection */
         tokenAddress: string;
+        /** The token id to get metadata for */
         tokenId: string;
       };
+      query: {
+        /** A boolean to force resync the token's metadata */
+        resyncMetadata?: boolean;
+      };
     };
     responses: {
       200: {
@@ -509,12 +563,18 @@ export interface Operations {
   /** Gets transfers of NFTs for a given wallet address */
   NftsController_getTransferForAddress: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
-        /** Wallet address of the sender/recipient of the transfers */
+        /** The wallet address of the sender or recipient of the transfers */
         walletAddress: string;
       };
       query: {
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
       };
     };
@@ -529,13 +589,20 @@ export interface Operations {
   /** Gets transfers of an NFT by contract address and token ID. */
   NftsController_getTransfersByTokenId: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
-        /** Contract address */
+        /** The contract address of the NFT collection */
         tokenAddress: string;
+        /** The token id to get transfers for */
         tokenId: string;
       };
       query: {
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
       };
     };
@@ -550,12 +617,18 @@ export interface Operations {
   /** Gets transfers by contract address. */
   NftsController_getTransfersByTokenAddress: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
-        /** Contract address */
+        /** The contract address of the NFT collection */
         tokenAddress: string;
       };
       query: {
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
       };
     };
@@ -570,12 +643,18 @@ export interface Operations {
   /** Gets NFT owners given a token address */
   NftsController_getOwnersByContract: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
-        /** Contract address */
+        /** The contract address of the NFT collection */
         tokenAddress: string;
       };
       query: {
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
       };
     };
@@ -590,12 +669,20 @@ export interface Operations {
   /** Gets NFT owners for a specific token address and a tokenId */
   NftsController_getOwnersByTokenId: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
+        /** The contract address of the NFT collection */
         tokenAddress: string;
+        /** The token id to get owners for */
         tokenId: string;
       };
       query: {
+        /** The cursor returned in the previous response (to query the next page) */
         cursor?: string;
       };
     };
@@ -607,13 +694,23 @@ export interface Operations {
       };
     };
   };
+  /** Get the lowest ETH based price for a scpecific token address */
   NftsController_getTradePrice: {
     parameters: {
+      header: {
+        /** NFT Api version */
+        'X-Csi-Version'?: string;
+      };
       path: {
+        /** The id of the chain to query */
         chainId: string;
-        /** Contract address */
+        /** The contract address of the NFT collection */
         tokenAddress: string;
       };
+      query: {
+        /** The number of days to get lowest price for (defaults to 30) */
+        days?: number;
+      };
     };
     responses: {
       200: {