@quicknode/sdk 0.2.0 → 0.4.0

package/README.md

@@ -129,6 +129,76 @@ client.nft
   .then((response) => console.log(response));
 ```
 
+### nft.getNFTEventLogs
+
+| Argument | Values | Optional | Description                                                                       | Example                                    |
+| -------- | ------ | -------- | --------------------------------------------------------------------------------- | ------------------------------------------ |
+| address  | string | ❌       | Contract address of NFT                                                           | 0x2106C00Ac7dA0A3430aE667879139E832307AeAa |
+| tokenId  | string | ❌       | NFT ID                                                                            | 100                                        |
+| types    | array  | ✅       | An array of event types 'TRANSFER', 'ORDER', and/or 'MINT'. Defaults to all types | ['TRANSFER', 'ORDER', 'MINT]               |
+| 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
+  .getNFTEventLogs({
+    address: '0x60E4d786628Fea6478F785A6d7e704777c86a7c6',
+    tokenId: '100',
+    types: ['TRANSFER', 'ORDER'],
+  })
+  .then((response) => console.log(response));
+```
+
+### nft.getNFTDetails
+
+Returns the details for a single NFT
+| Argument | Values | Optional | Description | Example |
+| --------------- | ------ | -------- | --------------------------------- | ------------------------------------------ |
+| contractAddress | string | ❌ | Contract address of NFT Collection | 0x2106C00Ac7dA0A3430aE667879139E832307AeAa |
+| tokenId | string | ❌ | NFT ID | 5020 |
+
+```ts
+import { QuickNodeSDK } from '@quicknode/sdk';
+
+const client = new QuickNodeSDK();
+
+client.nft
+  .getNFTDetails({
+    contractAddress: '0x23581767a106ae21c074b2276D25e5C3e136a68b',
+    tokenId: '400',
+  })
+  .then((response) => console.log(response));
+```
+
+### nft.getContractEventLogs
+
+Returns the log events for a NFT contract
+
+| Argument | Values | Optional | Description                                                                       | Example                                    |
+| -------- | ------ | -------- | --------------------------------------------------------------------------------- | ------------------------------------------ |
+| address  | string | ❌       | Contract address of NFT                                                           | 0x2106C00Ac7dA0A3430aE667879139E832307AeAa |
+| types    | array  | ✅       | An array of event types 'TRANSFER', 'ORDER', and/or 'MINT'. Defaults to all types | ['TRANSFER', 'ORDER', 'MINT]               |
+| 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
+  .getContractEventLogs({
+    address: '0x60E4d786628Fea6478F785A6d7e704777c86a7c6',
+    tokenId: '100',
+    types: ['TRANSFER', 'ORDER'],
+  })
+  .then((response) => console.log(response));
+```
+
 ## Pagination
 
 For functions that support pagination, use the `first` property to specify the amount of results to return.
@@ -139,12 +209,11 @@ The returned `data.tokensPageInfo.endCursor` property in the response can be use
 
 For example, if a response contains:
 
-```
-"data: {
+```json
+"data": {
   "tokensPageInfo": {
     "hasNextPage": true,
     "endCursor": 'YXJyYXljb25uZWN0aW9uOlk='
-    }
   }
 }
 ```

package/package.json

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

package/src/index.esm.js

@@ -8038,6 +8038,127 @@ const getCollectionDetailsRawQuery = gql `
   }
 `;
 
+const getNFTEventLogsRawQuery = gql `
+  query NFTEvents(
+    $address: String!
+    $tokenId: String!
+    $filter: LogsFilterInputType
+    $first: Int
+    $after: String
+  ) {
+    token(contractAddress: $address, tokenId: $tokenId) {
+      ... on ERC721Token {
+        tokenId
+        contract {
+          address # Included key field for caching
+        }
+        logs(filter: $filter, first: $first, after: $after) {
+          edges {
+            node {
+              blockNumber
+              type
+              fromAddress
+              toAddress
+              estimatedConfirmedAt
+              transactionHash
+              ... on OrderLog {
+                marketplace
+                priceInEth
+              }
+            }
+          }
+          pageInfo {
+            hasNextPage
+            endCursor
+          }
+        }
+      }
+    }
+  }
+`;
+
+const getNFTDetailsRawQuery = gql `
+  query Token($contractAddress: String!, $tokenId: String!) {
+    token(contractAddress: $contractAddress, tokenId: $tokenId) {
+      ... on ERC721Token {
+        tokenId
+        attributes {
+          name
+          value
+        }
+        contract {
+          address
+          isVerified
+          tokenStandard
+          ... on ERC721Contract {
+            name
+          }
+        }
+        images {
+          height
+          mimeType
+          url
+          width
+        }
+        name
+        symbol
+        metadata {
+          animation_url
+          background_color
+          description
+          external_url
+          image
+          image_data
+          name
+          youtube_url
+        }
+      }
+    }
+  }
+`;
+
+const getContractEventLogsRawQuery = gql `
+  query ContractEvents(
+    $address: String!
+    $filter: LogsFilterInputType
+    $first: Int
+    $after: String
+  ) {
+    contract(address: $address) {
+      address
+      logs(filter: $filter, first: $first, after: $after) {
+        pageInfo {
+          hasNextPage
+          endCursor
+        }
+        edges {
+          node {
+            blockNumber
+            type
+            fromAddress
+            toAddress
+            estimatedConfirmedAt
+            transactionHash
+            token {
+              contract {
+                address
+              }
+              ... on ERC721Token {
+                tokenId
+              }
+            }
+            ... on OrderLog {
+              marketplace
+              priceInEth
+            }
+          }
+        }
+      }
+    }
+  }
+`;
+
+const DEFAULT_LOG_FILTER_TYPES = ['TRANSFER', 'ORDER', 'MINT'];
 class NFTQueries {
     constructor(client) {
         this.client = client;
@@ -8074,6 +8195,36 @@ class NFTQueries {
             });
         });
     }
+    getNFTEventLogs(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { types = DEFAULT_LOG_FILTER_TYPES } = variables, otherVariables = __rest(variables, ["types"]);
+            return yield this.client.query({
+                query: getNFTEventLogsRawQuery,
+                variables: Object.assign(Object.assign({}, otherVariables), { filter: {
+                        typeIn: types,
+                    } }),
+            });
+        });
+    }
+    getNFTDetails(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.query({
+                query: getNFTDetailsRawQuery,
+                variables,
+            });
+        });
+    }
+    getContractEventLogs(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { types = DEFAULT_LOG_FILTER_TYPES } = variables, otherVariables = __rest(variables, ["types"]);
+            return yield this.client.query({
+                query: getContractEventLogsRawQuery,
+                variables: Object.assign(Object.assign({}, otherVariables), { filter: {
+                        typeIn: types,
+                    } }),
+            });
+        });
+    }
 }
 
 /**

package/src/index.js

@@ -8046,6 +8046,127 @@ const getCollectionDetailsRawQuery = gql `
   }
 `;
 
+const getNFTEventLogsRawQuery = gql `
+  query NFTEvents(
+    $address: String!
+    $tokenId: String!
+    $filter: LogsFilterInputType
+    $first: Int
+    $after: String
+  ) {
+    token(contractAddress: $address, tokenId: $tokenId) {
+      ... on ERC721Token {
+        tokenId
+        contract {
+          address # Included key field for caching
+        }
+        logs(filter: $filter, first: $first, after: $after) {
+          edges {
+            node {
+              blockNumber
+              type
+              fromAddress
+              toAddress
+              estimatedConfirmedAt
+              transactionHash
+              ... on OrderLog {
+                marketplace
+                priceInEth
+              }
+            }
+          }
+          pageInfo {
+            hasNextPage
+            endCursor
+          }
+        }
+      }
+    }
+  }
+`;
+
+const getNFTDetailsRawQuery = gql `
+  query Token($contractAddress: String!, $tokenId: String!) {
+    token(contractAddress: $contractAddress, tokenId: $tokenId) {
+      ... on ERC721Token {
+        tokenId
+        attributes {
+          name
+          value
+        }
+        contract {
+          address
+          isVerified
+          tokenStandard
+          ... on ERC721Contract {
+            name
+          }
+        }
+        images {
+          height
+          mimeType
+          url
+          width
+        }
+        name
+        symbol
+        metadata {
+          animation_url
+          background_color
+          description
+          external_url
+          image
+          image_data
+          name
+          youtube_url
+        }
+      }
+    }
+  }
+`;
+
+const getContractEventLogsRawQuery = gql `
+  query ContractEvents(
+    $address: String!
+    $filter: LogsFilterInputType
+    $first: Int
+    $after: String
+  ) {
+    contract(address: $address) {
+      address
+      logs(filter: $filter, first: $first, after: $after) {
+        pageInfo {
+          hasNextPage
+          endCursor
+        }
+        edges {
+          node {
+            blockNumber
+            type
+            fromAddress
+            toAddress
+            estimatedConfirmedAt
+            transactionHash
+            token {
+              contract {
+                address
+              }
+              ... on ERC721Token {
+                tokenId
+              }
+            }
+            ... on OrderLog {
+              marketplace
+              priceInEth
+            }
+          }
+        }
+      }
+    }
+  }
+`;
+
+const DEFAULT_LOG_FILTER_TYPES = ['TRANSFER', 'ORDER', 'MINT'];
 class NFTQueries {
     constructor(client) {
         this.client = client;
@@ -8082,6 +8203,36 @@ class NFTQueries {
             });
         });
     }
+    getNFTEventLogs(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { types = DEFAULT_LOG_FILTER_TYPES } = variables, otherVariables = __rest(variables, ["types"]);
+            return yield this.client.query({
+                query: getNFTEventLogsRawQuery,
+                variables: Object.assign(Object.assign({}, otherVariables), { filter: {
+                        typeIn: types,
+                    } }),
+            });
+        });
+    }
+    getNFTDetails(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.query({
+                query: getNFTDetailsRawQuery,
+                variables,
+            });
+        });
+    }
+    getContractEventLogs(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { types = DEFAULT_LOG_FILTER_TYPES } = variables, otherVariables = __rest(variables, ["types"]);
+            return yield this.client.query({
+                query: getContractEventLogsRawQuery,
+                variables: Object.assign(Object.assign({}, otherVariables), { filter: {
+                        typeIn: types,
+                    } }),
+            });
+        });
+    }
 }
 
 /**

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

@@ -0,0 +1,6 @@
+import { PaginationArgs, LogEvents } from '../../../types';
+export declare const getContractEventLogsRawQuery: import("graphql/language/ast").DocumentNode;
+export interface ContractEventLogQueryVariables extends PaginationArgs {
+    address: string;
+    types?: LogEvents[];
+}

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

@@ -0,0 +1,5 @@
+export declare const getNFTDetailsRawQuery: import("graphql/language/ast").DocumentNode;
+export interface NFTDetailsQueryVariables {
+    contractAddress: string;
+    tokenId: string;
+}

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

@@ -0,0 +1,7 @@
+import { PaginationArgs, LogEvents } from '../../../types';
+export declare const getNFTEventLogsRawQuery: import("graphql/language/ast").DocumentNode;
+export interface EventLogsQueryVariables extends PaginationArgs {
+    address: string;
+    tokenId: string;
+    types?: LogEvents[];
+}

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

@@ -4,7 +4,10 @@ import { WalletAddressNFTsQueryVariables } from './getNFTsByWalletAddress/getNFT
 import { WalletENSNFTsQueryVariables } from './getNFTsByWalletENS/getNFTsByWalletENS';
 import { ContractAddressNFTsQueryVariables } from './getNFTsByContractAddress/getNFTsByContractAddress';
 import { CollectionDetailsQueryVariables } from './getCollectionDetails/getCollectionDetails';
-import { ContractNFTsQueryResponse, WalletNFTsQueryResponse, CollectionDetailsQueryResponse } from './sharedTypes';
+import { EventLogsQueryVariables } from './getNFTEventLogs/getNFTEventLogs';
+import { NFTDetailsQueryVariables } from './getNFTDetails/getNFTDetails';
+import { ContractEventLogQueryVariables } from './getContractEventLogs/getContractEventLogs';
+import { ContractNFTsQueryResponse, WalletNFTsQueryResponse, CollectionDetailsQueryResponse, EventLogsQueryResponse, NFTDetailsQueryResponse, ContractEventLogsQueryResponse } from './sharedTypes';
 export declare class NFTQueries {
     private client;
     constructor(client: CustomApolloClient);
@@ -12,4 +15,7 @@ export declare class NFTQueries {
     getNFTsByWalletENS(variables: WalletENSNFTsQueryVariables): Promise<ApolloQueryResult<WalletNFTsQueryResponse>>;
     getNFTsByContractAddress(variables: ContractAddressNFTsQueryVariables): Promise<ApolloQueryResult<ContractNFTsQueryResponse>>;
     getCollectionDetails(variables: CollectionDetailsQueryVariables): Promise<ApolloQueryResult<CollectionDetailsQueryResponse>>;
+    getNFTEventLogs(variables: EventLogsQueryVariables): Promise<ApolloQueryResult<EventLogsQueryResponse>>;
+    getNFTDetails(variables: NFTDetailsQueryVariables): Promise<ApolloQueryResult<NFTDetailsQueryResponse>>;
+    getContractEventLogs(variables: ContractEventLogQueryVariables): Promise<ApolloQueryResult<ContractEventLogsQueryResponse>>;
 }