@quicknode/sdk 0.0.4 → 0.2.0

package/README.md

@@ -24,7 +24,7 @@ client.nft
   .then((response) => console.log(response));
 ```
 
-Full example implementation [here](https://github.com/user/repo/blob/branch/other_file.md).
+Full example implementation [here](https://github.com/quiknode-labs/qn-oss/tree/main/packages/apps/examples/nft-sdk)
 
 ## Providing a config object to the client
 
@@ -50,11 +50,11 @@ const client = new QuickNodeSDK({
 
 ### nft.getNFTsByWalletENS
 
-| Argument | Values | Optional | Example                      |
-| -------- | ------ | -------- | ---------------------------- |
-| ensName  | string | ❌       | vitalik.eth                  |
-| first    | number | ✅       | 10                           |
-| after    | string | ✅       | YXJyYXljb25uZWN0aW9uOjUwNQ== |
+| Argument | Values | Optional | Description                     | Example                     |
+| -------- | ------ | -------- | ------------------------------- | --------------------------- |
+| ensName  | string | ❌       | Wallet ENS address              | vitalik.eth                 |
+| first    | number | ✅       | Number of results to return     | 10                          |
+| after    | string | ✅       | Return results after end cursor | YXJyYXljb25uZWN0aW9uOjUwNQ= |
 
 ```ts
 import { QuickNodeSDK } from '@quicknode/sdk';
@@ -65,18 +65,17 @@ client.nft
   .getNFTsByWalletENS({
     ensName: 'vitalik.eth',
     first: 5,
-    after: 'YXJyYXljb25uZWN0aW9uOjUwNQ==',
   })
   .then((response) => console.log(response));
 ```
 
 ### nft.getNFTsByWalletAddress
 
-| Argument | Values | Optional | Example                                    |
-| -------- | ------ | -------- | ------------------------------------------ |
-| address  | string | ❌       | 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 |
-| first    | number | ✅       | 10                                         |
-| after    | string | ✅       | YXJyYXljb25uZWN0aW9uOjUwNQ==               |
+| Argument | Values | Optional | Description                     | Example                                    |
+| -------- | ------ | -------- | ------------------------------- | ------------------------------------------ |
+| address  | string | ❌       | Wallet address                  | 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 |
+| first    | number | ✅       | Number of results to return     | 10                                         |
+| after    | string | ✅       | Return results after end cursor | YXJyYXljb25uZWN0aW9uOjUwNQ=                |
 
 ```ts
 import { QuickNodeSDK } from '@quicknode/sdk';
@@ -87,11 +86,79 @@ client.nft
   .getNFTsByWalletAddress({
     address: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
     first: 5,
-    after: 'YXJyYXljb25uZWN0aW9uOjUwNQ==',
   })
   .then((response) => console.log(response));
 ```
 
+### nft.getNFTsByContractAddress
+
+| Argument | Values | Optional | Description                     | Example                                    |
+| -------- | ------ | -------- | ------------------------------- | ------------------------------------------ |
+| address  | string | ❌       | Contract address of NFT         | 0x2106C00Ac7dA0A3430aE667879139E832307AeAa |
+| first    | number | ✅       | Number of results to return     | 10                                         |
+| after    | string | ✅       | Return results after end cursor | YXJyYXljb25uZWN0aW9uOjUwNQ=                |
+
+```ts
+import { QuickNodeSDK } from '@quicknode/sdk';
+
+const client = new QuickNodeSDK();
+
+client.nft
+  .getNFTsByContractAddress({
+    address: '0x2106C00Ac7dA0A3430aE667879139E832307AeAa',
+    first: 5,
+  })
+  .then((response) => console.log(response));
+```
+
+### nft.getCollectionDetails
+
+| Argument | Values | Optional | Description             | Example                                    |
+| -------- | ------ | -------- | ----------------------- | ------------------------------------------ |
+| address  | string | ❌       | Contract address of NFT | 0x2106C00Ac7dA0A3430aE667879139E832307AeAa |
+
+```ts
+import { QuickNodeSDK } from '@quicknode/sdk';
+
+const client = new QuickNodeSDK();
+
+client.nft
+  .getCollectionDetails({
+    address: '0x2106C00Ac7dA0A3430aE667879139E832307AeAa',
+  })
+  .then((response) => console.log(response));
+```
+
+## Pagination
+
+For functions that support pagination, use the `first` property to specify the amount of results to return.
+
+The returned `data.tokensPageInfo.endCursor` property in the response can be used to access subsequent results. This value can be passed in to the `after` property and will return the results after that `endCursor`.
+
+`hasNextPage` can be used to determine the end of the results, where it will be `false`.
+
+For example, if a response contains:
+
+```
+"data: {
+  "tokensPageInfo": {
+    "hasNextPage": true,
+    "endCursor": 'YXJyYXljb25uZWN0aW9uOlk='
+    }
+  }
+}
+```
+
+calling the following will get the next page of results
+
+```typescript
+client.nft.getNFTsByWalletENS({
+  ensName: 'vitalik.eth',
+  first: 5,
+  after: 'YXJyYXljb25uZWN0aW9uOlk=', // from data.tokensPageInfo.endCursor in response
+});
+```
+
 # Contributing corner
 
 ## Building

package/package.json

@@ -6,7 +6,7 @@
     "directory": "packages/libs/api/sdk"
   },
   "license": "MIT",
-  "version": "0.0.4",
+  "version": "0.2.0",
   "main": "./src/index.js",
   "module": "./src/index.esm.js",
   "types": "./src/index.d.ts",

package/src/index.esm.js

@@ -7976,6 +7976,68 @@ const getWalletENSNFTsRawQuery = gql `
   }
 `;
 
+const getContractAddressNFTsRawQuery = gql `
+  query ContractNFTs($address: String!, $first: Int, $after: String) {
+    contract(address: $address) {
+      address
+      isVerified
+      tokenStandard
+      tokens(first: $first, after: $after) {
+        pageInfo {
+          hasNextPage
+          endCursor
+        }
+        edges {
+          node {
+            tokenId
+            images {
+              url
+            }
+            ... on ERC721Token {
+              contract {
+                address # Included key field for caching
+              }
+            }
+          }
+        }
+      }
+      ... on ERC721Contract {
+        circulatingSupply
+        name
+        symbol
+      }
+    }
+  }
+`;
+
+const getCollectionDetailsRawQuery = gql `
+  query CollectionDetails($address: String!) {
+    contract(address: $address) {
+      ... on ERC721Contract {
+        address
+        isVerified
+        tokenStandard
+        attributes {
+          name
+          rarity
+          value
+          valueCount
+        }
+        circulatingSupply
+        name
+        stats {
+          average
+          ceiling
+          floor
+          totalSales
+          volume
+        }
+        symbol
+      }
+    }
+  }
+`;
+
 class NFTQueries {
     constructor(client) {
         this.client = client;
@@ -7996,6 +8058,22 @@ class NFTQueries {
             });
         });
     }
+    getNFTsByContractAddress(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.query({
+                query: getContractAddressNFTsRawQuery,
+                variables,
+            });
+        });
+    }
+    getCollectionDetails(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.query({
+                query: getCollectionDetailsRawQuery,
+                variables,
+            });
+        });
+    }
 }
 
 /**
@@ -8121,4 +8199,4 @@ class QuickNodeSDK {
     }
 }
 
-export { QuickNodeSDK, QuickNodeSDK as default, getWalletAddressNFTsRawQuery, getWalletENSNFTsRawQuery };
+export { QuickNodeSDK, QuickNodeSDK as default, getContractAddressNFTsRawQuery, getWalletAddressNFTsRawQuery, getWalletENSNFTsRawQuery };

package/src/index.js

@@ -7984,6 +7984,68 @@ const getWalletENSNFTsRawQuery = gql `
   }
 `;
 
+const getContractAddressNFTsRawQuery = gql `
+  query ContractNFTs($address: String!, $first: Int, $after: String) {
+    contract(address: $address) {
+      address
+      isVerified
+      tokenStandard
+      tokens(first: $first, after: $after) {
+        pageInfo {
+          hasNextPage
+          endCursor
+        }
+        edges {
+          node {
+            tokenId
+            images {
+              url
+            }
+            ... on ERC721Token {
+              contract {
+                address # Included key field for caching
+              }
+            }
+          }
+        }
+      }
+      ... on ERC721Contract {
+        circulatingSupply
+        name
+        symbol
+      }
+    }
+  }
+`;
+
+const getCollectionDetailsRawQuery = gql `
+  query CollectionDetails($address: String!) {
+    contract(address: $address) {
+      ... on ERC721Contract {
+        address
+        isVerified
+        tokenStandard
+        attributes {
+          name
+          rarity
+          value
+          valueCount
+        }
+        circulatingSupply
+        name
+        stats {
+          average
+          ceiling
+          floor
+          totalSales
+          volume
+        }
+        symbol
+      }
+    }
+  }
+`;
+
 class NFTQueries {
     constructor(client) {
         this.client = client;
@@ -8004,6 +8066,22 @@ class NFTQueries {
             });
         });
     }
+    getNFTsByContractAddress(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.query({
+                query: getContractAddressNFTsRawQuery,
+                variables,
+            });
+        });
+    }
+    getCollectionDetails(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.query({
+                query: getCollectionDetailsRawQuery,
+                variables,
+            });
+        });
+    }
 }
 
 /**
@@ -8131,5 +8209,6 @@ class QuickNodeSDK {
 
 exports.QuickNodeSDK = QuickNodeSDK;
 exports["default"] = QuickNodeSDK;
+exports.getContractAddressNFTsRawQuery = getContractAddressNFTsRawQuery;
 exports.getWalletAddressNFTsRawQuery = getWalletAddressNFTsRawQuery;
 exports.getWalletENSNFTsRawQuery = getWalletENSNFTsRawQuery;

package/src/queries/nft/getCollectionDetails/getCollectionDetails.d.ts

@@ -0,0 +1,4 @@
+export declare const getCollectionDetailsRawQuery: import("graphql/language/ast").DocumentNode;
+export interface CollectionDetailsQueryVariables {
+    address: string;
+}

package/src/queries/nft/getNFTsByContractAddress/getNFTsByContractAddress.d.ts

@@ -0,0 +1,5 @@
+import { PaginationArgs } from '../../../types';
+export declare const getContractAddressNFTsRawQuery: import("graphql/language/ast").DocumentNode;
+export interface ContractAddressNFTsQueryVariables extends PaginationArgs {
+    address: string;
+}

package/src/queries/nft/index.d.ts

@@ -1,2 +1,3 @@
 export * from './getNFTsByWalletAddress/getNFTsByWalletAddress';
 export * from './getNFTsByWalletENS/getNFTsByWalletENS';
+export * from './getNFTsByContractAddress/getNFTsByContractAddress';

package/src/queries/nft/nftQueries.d.ts

@@ -2,10 +2,14 @@ import { ApolloQueryResult } from '@apollo/client';
 import { CustomApolloClient } from '../../client/customApolloClient';
 import { WalletAddressNFTsQueryVariables } from './getNFTsByWalletAddress/getNFTsByWalletAddress';
 import { WalletENSNFTsQueryVariables } from './getNFTsByWalletENS/getNFTsByWalletENS';
-import { WalletNFTsQueryResponse } from './sharedTypes';
+import { ContractAddressNFTsQueryVariables } from './getNFTsByContractAddress/getNFTsByContractAddress';
+import { CollectionDetailsQueryVariables } from './getCollectionDetails/getCollectionDetails';
+import { ContractNFTsQueryResponse, WalletNFTsQueryResponse, CollectionDetailsQueryResponse } from './sharedTypes';
 export declare class NFTQueries {
     private client;
     constructor(client: CustomApolloClient);
     getNFTsByWalletAddress(variables: WalletAddressNFTsQueryVariables): Promise<ApolloQueryResult<WalletNFTsQueryResponse>>;
     getNFTsByWalletENS(variables: WalletENSNFTsQueryVariables): Promise<ApolloQueryResult<WalletNFTsQueryResponse>>;
+    getNFTsByContractAddress(variables: ContractAddressNFTsQueryVariables): Promise<ApolloQueryResult<ContractNFTsQueryResponse>>;
+    getCollectionDetails(variables: CollectionDetailsQueryVariables): Promise<ApolloQueryResult<CollectionDetailsQueryResponse>>;
 }