Feat/engt 1220

documentation/sdql/EXAMPLES.md

@@ -10,7 +10,7 @@ This example checks if the user's age is greater than or equal to 15. It also qu
 {
     "version": 0.1,
     "timestamp": "2021-11-13T20:20:39",
-    "expiry" : "2022-11-13T20:20:39",
+    "expiry": "2022-11-13T20:20:39",
     "description": "For 15-year and older individuals, querying intractions with the Avalanche blockchain, location, gender, urls visited and chain transaction count",
     "business": "Shrapnel",
     "queries": {
@@ -65,17 +65,17 @@ This example checks if the user's age is greater than or equal to 15. It also qu
             "name": "gender",
             "return": "enum",
             "enum_keys": [
-                    "female",
-                    "male",
-                    "nonbinary",
-                    "unknown"
-                ]
+                "female",
+                "male",
+                "nonbinary",
+                "unknown"
+            ]
         },
         "q5": {
             "name": "url_visited_count",
             "return": "object",
-            "object_schema":{
-                "patternProperties":{
+            "object_schema": {
+                "patternProperties": {
                     "^http(s)?:\/\/[\\-a-zA-Z0-9]*.[a-zA-Z0-9]*.[a-zA-Z]*\/[a-zA-Z0-9]*$": {
                         "type": "integer"
                     }
@@ -114,6 +114,41 @@ This example checks if the user's age is greater than or equal to 15. It also qu
                     ]
                 }
             }
+        },
+        "q7": {
+            "name": "nft",
+            "return": "array",
+            "networkid": "*",
+            "address": "*",
+            "array_items": {
+                "object_schema": {
+                    "properties": {
+                        "networkid": {
+                            "type": "integer",
+                        },
+                        "tokenAddress": {
+                            "type": "string",
+                            "pattern": "^0x[a-fA-F0-9]{40}$",
+                        },
+                        "ticker": {
+                            "type": "string"
+                        },
+                        "balance": {
+                            "type": "number",
+                        },
+                        "decimals": {
+                            "type": "number",
+                        },
+                    },
+                    "required": [
+                        "networkid",
+                        "tokenAddress",
+                        "balance",
+                        "decimals",
+                        "ticker"
+                    ],
+                },
+            },
         }
     },
     "returns": {
@@ -147,8 +182,7 @@ This example checks if the user's age is greater than or equal to 15. It also qu
         },
         "url": "https://418e-64-85-231-39.ngrok.io/insights"
     },
-  "compensations":{
-
+    "compensations": {
         "parameters": {
             "recipientAddress": {
                 type:...,
@@ -157,82 +191,84 @@ This example checks if the user's age is greater than or equal to 15. It also qu
             "productId": {
                 type: string,
                 required: true,
-                values: [urls]
+                values: [urls
+                ]
             },
             "shippingAddress": {
                 type: string,
                 required: true,
             },
-
         },
-        "c1":{
+        "c1": {
             "description": "10% discount code for Starbucks",
             "chainId": 1,
             "callback": {
                 "parameters": [
                     "recipientAddress"
                 ],
-                "data": {...an object to be forwarded with the api call}
+                "data": {...an object to be forwarded with the api call
+                }
             }
         },
-        "c2":{
+        "c2": {
             "description": "participate in the draw to win a CryptoPunk NFT",
             "chainId": 1,
             "callback": {
                 "parameters": [
                     "recipientAddress",
                     "productId"
                 ],
-                "data": {...an object to be forwarded with the api call}
+                "data": {...an object to be forwarded with the api call
+                }
             }
         },
-        "c3":{
+        "c3": {
             "description": "a free CrazyApesClub NFT",
             "chainId": 1,
             "callback": {
                 "parameters": [
                     "recipientAddress",
                     "shippingAddress"
                 ],
-                "data": {...an object to be forwarded with the api call}
+                "data": {...an object to be forwarded with the api call
+                }
             },
             "alternatives": [
                 "c4",
                 "c5"
             ]
-
         },
-        "c4":{
+        "c4": {
             "description": "a free CrazyApesClub NFT on Avalanche",
             "chainId": 43114,
             "callback": {
                 "parameters": [
                     "recipientAddress",
                     "shippingAddress"
                 ],
-                "data": {...an object to be forwarded with the api call}
+                "data": {...an object to be forwarded with the api call
+                }
             },
             "alternatives": [
                 "c3",
                 "c5"
             ]
-
         },
-        "c5":{
+        "c5": {
             "description": "a free CrazyApesClub NFT on Solana",
             "chainId": -1,
             "callback": {
                 "parameters": [
                     "recipientAddress",
                     "shippingAddress"
                 ],
-                "data": {...an object to be forwarded with the api call}
+                "data": {...an object to be forwarded with the api call
+                }
             },
             "alternatives": [
                 "c3",
                 "c4"
             ]
-
         },
     },
     "logic": {

packages/contracts-sdk/src/implementations/ConsentContract.ts

@@ -212,6 +212,7 @@ export class ConsentContract implements IConsentContract {
   public agreementFlags(
     tokenId: TokenId,
   ): ResultAsync<HexString32, ConsentContractError> {
+
     return ResultAsync.fromPromise(
       this.contract.agreementFlagsArray(tokenId) as Promise<HexString32>,
       (e) => {
@@ -512,6 +513,7 @@ export class ConsentContract implements IConsentContract {
   public ownerOf(
     tokenId: TokenId,
   ): ResultAsync<EVMAccountAddress, ConsentContractError> {
+
     return ResultAsync.fromPromise(
       this.contract.ownerOf(tokenId) as Promise<EVMAccountAddress>,
       (e) => {
@@ -568,10 +570,12 @@ export class ConsentContract implements IConsentContract {
     tokenId: TokenId,
   ): ResultAsync<ConsentToken, ConsentContractError> {
     // Get the agreement flags of the user's current consent token
+    console.log("getting");
     return ResultUtils.combine([
       this.ownerOf(tokenId),
       this.agreementFlags(tokenId),
     ]).andThen(([ownerAddress, agreementFlags]) => {
+
       return okAsync(
         new ConsentToken(
           this.contractAddress,

packages/core/src/implementations/SnickerdoodleCore.module.ts

@@ -62,13 +62,15 @@ import {
   ConsentTokenUtils,
   InvitationService,
   MonitoringService,
-  NetworkQueryEvaluator,
+  BlockchainTransactionQueryEvaluator,
+  NftQueryEvaluator,
   ProfileService,
   QueryEvaluator,
   QueryParsingEngine,
   QueryRepository,
   QueryService,
   SiftContractService,
+  Web3QueryEvaluator,
 } from "@core/implementations/business/index.js";
 import {
   AdContentRepository,
@@ -119,8 +121,12 @@ import {
   IBalanceQueryEvaluatorType,
   IConsentTokenUtils,
   IConsentTokenUtilsType,
-  INetworkQueryEvaluator,
-  INetworkQueryEvaluatorType,
+  IBlockchainTransactionQueryEvaluator,
+  IBlockchainTransactionQueryEvaluatorType,
+  IWeb3QueryEvaluator,
+  IWeb3QueryEvaluatorType,
+  INftQueryEvaluator, 
+  INftQueryEvaluatorType,
   IQueryEvaluator,
   IQueryEvaluatorType,
   IQueryParsingEngine,
@@ -165,7 +171,6 @@ import {
   IDataWalletUtilsType,
 } from "@core/interfaces/utilities/index.js";
 
-
 export const snickerdoodleCoreModule = new ContainerModule(
   (
     bind: interfaces.Bind,
@@ -278,10 +283,18 @@ export const snickerdoodleCoreModule = new ContainerModule(
       .inSingletonScope();
 
     // Query instances
-    bind<INetworkQueryEvaluator>(INetworkQueryEvaluatorType)
-      .to(NetworkQueryEvaluator)
+    bind<IBlockchainTransactionQueryEvaluator>(IBlockchainTransactionQueryEvaluatorType)
+      .to(BlockchainTransactionQueryEvaluator)
       .inSingletonScope();
 
+    bind<INftQueryEvaluator>(INftQueryEvaluatorType)
+      .to(NftQueryEvaluator)
+      .inSingletonScope();
+
+   bind<IWeb3QueryEvaluator>(IWeb3QueryEvaluatorType)
+      .to(Web3QueryEvaluator)
+      .inSingletonScope();
+
     bind<IQueryEvaluator>(IQueryEvaluatorType)
       .to(QueryEvaluator)
       .inSingletonScope();

packages/core/src/implementations/business/QueryService.ts

@@ -111,6 +111,7 @@ export class QueryService implements IQueryService {
               consentContractAddress,
             )
             .andThen(([permittedQueryIds, expectedRewards]) => {
+
               return this.publishSDQLQueryRequestIfExpectedAndEligibleRewardsMatch(
                 consentToken,
                 optInKey,
@@ -265,6 +266,7 @@ export class QueryService implements IQueryService {
       this.configProvider.getConfig(),
       this.consentTokenUtils.getCurrentConsentToken(consentContractAddress),
     ]).andThen(([context, config, consentToken]) => {
+
       return this.validateContextConfig(context, consentToken).andThen(() => {
         return ResultUtils.combine([
           this.queryParsingEngine.handleQuery(
@@ -277,6 +279,7 @@ export class QueryService implements IQueryService {
             context.dataWalletKey!,
           ),
         ]).andThen(([maps, optInKey]) => {
+
           const maps2 = maps as [InsightString[], EligibleReward[]];
           const insights = maps2[0];
           const rewards = maps2[1];

packages/core/src/implementations/business/utilities/QueryParsingEngine.ts

@@ -97,9 +97,11 @@ export class QueryParsingEngine implements IQueryParsingEngine {
     return this.queryFactories
       .makeParserAsync(cid, schemaString)
       .andThen((sdqlParser) => {
+
         return sdqlParser.buildAST();
       })
       .andThen((ast: AST) => {
+
         const astEvaluator = this.queryFactories.makeAstEvaluator(
           cid,
           ast,

packages/core/src/implementations/business/utilities/query/NetworkQueryEvaluator.ts → packages/core/src/implementations/business/utilities/query/BlockchainTransactionQueryEvaluator.ts

@@ -6,21 +6,21 @@ import {
   PersistenceError,
   SDQL_Return,
 } from "@snickerdoodlelabs/objects";
-import { AST_NetworkQuery } from "@snickerdoodlelabs/query-parser";
+import { AST_BlockchainTransactionQuery } from "@snickerdoodlelabs/query-parser";
 import { inject, injectable } from "inversify";
 import { okAsync, ResultAsync } from "neverthrow";
 
-import { INetworkQueryEvaluator } from "@core/interfaces/business/utilities/query/INetworkQueryEvaluator";
+import { IBlockchainTransactionQueryEvaluator } from "@core/interfaces/business/utilities/query/IBlockchainTransactionQueryEvaluator";
 
 @injectable()
-export class NetworkQueryEvaluator implements INetworkQueryEvaluator {
+export class BlockchainTransactionQueryEvaluator implements IBlockchainTransactionQueryEvaluator {
   constructor(
     @inject(IDataWalletPersistenceType)
     protected dataWalletPersistence: IDataWalletPersistence,
   ) {}
 
   public eval(
-    query: AST_NetworkQuery,
+    query: AST_BlockchainTransactionQuery,
   ): ResultAsync<SDQL_Return, PersistenceError> {
     const result = SDQL_Return(false);
     const chainId = query.contract.networkId;
@@ -93,6 +93,11 @@ export class NetworkQueryEvaluator implements INetworkQueryEvaluator {
         });
     }
 
+
     return okAsync(SDQL_Return(false));
   }
+
+
+
+
 }