@settlemint/sdk-eas 2.5.2-main97dcc94b → 2.5.2-pr3f0fdd1a

package/README.md

@@ -74,7 +74,7 @@ The SettleMint EAS SDK provides a lightweight wrapper for the Ethereum Attestati
 
 import type { Address, Hex } from "viem";
 import { decodeAbiParameters, encodeAbiParameters, parseAbiParameters } from "viem";
-import { createEASClient, ZERO_ADDRESS, ZERO_BYTES32 } from "../eas.ts"; // Replace this path with "@settlemint/sdk-eas";
+import { ZERO_ADDRESS, ZERO_BYTES32, createEASClient } from "@settlemint/sdk-eas";
 
 const CONFIG = {
   instance: process.env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT,
@@ -234,25 +234,19 @@ async function runEASWorkflow() {
     console.log("⚠️  Schema registration failed:", error);
   }
 
-  /*
-    The following steps for retrieving schemas and attestations are commented out
-    because the underlying SDK functions are not yet fully implemented and depend on
-    a configured The Graph subgraph, which is not available in this example.
-  */
-
-  // // Step 5: Retrieve Schema
-  // console.log("📖 Step 5: Retrieve Schema");
-  // try {
-  //   const schema = await client.getSchema("0x1234567890123456789012345678901234567890123456789012345678901234");
-  //   console.log("✅ Schema retrieved successfully");
-  //   console.log(`   UID: ${schema.uid}`);
-  //   console.log(`   Resolver: ${schema.resolver}`);
-  //   console.log(`   Revocable: ${schema.revocable}`);
-  //   console.log(`   Schema: ${schema.schema}\n`);
-  // } catch (error) {
-  //   console.log("⚠️  Schema retrieval failed (Portal access required)");
-  //   console.log("   Would retrieve schema: 0x1234567890123456789012345678901234567890123456789012345678901234\n");
-  // }
+  // Step 5: Retrieve Schema
+  console.log("📖 Step 5: Retrieve Schema");
+  try {
+    const schema = await client.getSchema(schemaResult.hash);
+    console.log("✅ Schema retrieved successfully");
+    console.log(`   UID: ${schema.uid}`);
+    console.log(`   Resolver: ${schema.resolver}`);
+    console.log(`   Revocable: ${schema.revocable}`);
+    console.log(`   Schema: ${schema.schema}\n`);
+  } catch (error) {
+    console.log("⚠️  Schema retrieval failed:");
+    console.log(`   ${error}\n`);
+  }
 
   // // Step 6: Retrieve All Schemas
   // console.log("📚 Step 6: Retrieve All Schemas");
@@ -315,17 +309,17 @@ async function runEASWorkflow() {
   console.log("✅ Schema retrieval ready");
   console.log("✅ Attestation retrieval ready");
 
-  console.log("\n💡 Production ready!");
+  console.log("\n💡 Ready for production!");
   console.log("- All EAS operations implemented");
-  console.log("- Full Portal GraphQL integration");
+  console.log("- Portal GraphQL integration");
   console.log("- Comprehensive error handling");
   console.log("- Type-safe TypeScript API");
-  console.log("- No hardcoded values - fully configurable");
+  console.log("- Fully configurable");
 
-  console.log("\n🔑 To use with real Portal:");
-  console.log("- Obtain valid EAS Portal access token");
-  console.log("- Provide deployer and transaction sender addresses");
-  console.log("- Deploy or configure contract addresses");
+  console.log("\n🔑 To use with Portal:");
+  console.log("- Set valid Portal access token");
+  console.log("- Configure deployer and sender addresses");
+  console.log("- Deploy or set contract addresses");
   console.log("- Start creating attestations!");
 }
 
@@ -656,8 +650,6 @@ Defined in: [sdk/eas/src/eas.ts:528](https://github.com/settlemint/sdk/blob/v2.5
 
 Get an attestation by UID
 
-TODO: Implement using The Graph subgraph for EAS data queries
-
 ###### Parameters
 
 | Parameter | Type |
@@ -676,7 +668,9 @@ Defined in: [sdk/eas/src/eas.ts:539](https://github.com/settlemint/sdk/blob/v2.5
 
 Get attestations with pagination and filtering
 
-TODO: Implement using The Graph subgraph for EAS data queries
+Note: This method requires The Graph subgraph or additional indexing infrastructure
+as Portal's direct contract queries don't support listing all attestations.
+Consider using getAttestation() for individual attestation lookups.
 
 ###### Parameters
 
@@ -743,8 +737,6 @@ Defined in: [sdk/eas/src/eas.ts:508](https://github.com/settlemint/sdk/blob/v2.5
 
 Get a schema by UID
 
-TODO: Implement using The Graph subgraph for EAS data queries
-
 ###### Parameters
 
 | Parameter | Type |
@@ -763,7 +755,9 @@ Defined in: [sdk/eas/src/eas.ts:519](https://github.com/settlemint/sdk/blob/v2.5
 
 Get all schemas with pagination
 
-TODO: Implement using The Graph subgraph for EAS data queries
+Note: This method requires The Graph subgraph or additional indexing infrastructure
+as Portal's direct contract queries don't support listing all schemas.
+Consider using getSchema() for individual schema lookups.
 
 ###### Parameters
 
@@ -781,9 +775,9 @@ TODO: Implement using The Graph subgraph for EAS data queries
 
 Defined in: [sdk/eas/src/eas.ts:557](https://github.com/settlemint/sdk/blob/v2.5.2/sdk/eas/src/eas.ts#L557)
 
-Get the current timestamp from the contract
+Get the timestamp for specific data
 
-TODO: Fix Portal GraphQL query parameter encoding or use The Graph subgraph
+The data parameter must be a bytes32 value (64 hex characters with 0x prefix)
 
 ###### Returns
 
@@ -797,8 +791,6 @@ Defined in: [sdk/eas/src/eas.ts:548](https://github.com/settlemint/sdk/blob/v2.5
 
 Check if an attestation is valid
 
-TODO: Implement using The Graph subgraph for EAS data queries
-
 ###### Parameters
 
 | Parameter | Type |

package/dist/browser/eas.d.ts

@@ -4096,6 +4096,56 @@ declare const GraphQLOperations: {
       address: string;
     }, void>;
   };
+  queries: {
+    getSchema: (graphql: PortalClient["graphql"]) => gql_tada0.TadaDocumentNode<{
+      EASSchemaRegistry: {
+        getSchema: {
+          uid: string | null;
+          resolver: string | null;
+          revocable: boolean | null;
+          schema: string | null;
+        } | null;
+      } | null;
+    }, {
+      uid: string;
+      address: string;
+    }, void>;
+    getAttestation: (graphql: PortalClient["graphql"]) => gql_tada0.TadaDocumentNode<{
+      EAS: {
+        getAttestation: {
+          uid: string | null;
+          schema: string | null;
+          attester: string | null;
+          recipient: string | null;
+          time: string | null;
+          expirationTime: string | null;
+          revocable: boolean | null;
+          refUID: string | null;
+          data: string | null;
+          revocationTime: string | null;
+        } | null;
+      } | null;
+    }, {
+      uid: string;
+      address: string;
+    }, void>;
+    isAttestationValid: (graphql: PortalClient["graphql"]) => gql_tada0.TadaDocumentNode<{
+      EAS: {
+        isAttestationValid: boolean | null;
+      } | null;
+    }, {
+      uid: string;
+      address: string;
+    }, void>;
+    getTimestamp: (graphql: PortalClient["graphql"]) => gql_tada0.TadaDocumentNode<{
+      EAS: {
+        getTimestamp: string | null;
+      } | null;
+    }, {
+      data: string;
+      address: string;
+    }, void>;
+  };
 };
 //#endregion
 //#region src/eas.d.ts
@@ -4302,40 +4352,39 @@ declare class EASClient {
   revoke(schemaUID: Hex, attestationUID: Hex, fromAddress: Address, value?: bigint, gasLimit?: string): Promise<TransactionResult>;
   /**
    * Get a schema by UID
-   *
-   * TODO: Implement using The Graph subgraph for EAS data queries
    */
   getSchema(uid: Hex): Promise<SchemaData>;
   /**
    * Get all schemas with pagination
    *
-   * TODO: Implement using The Graph subgraph for EAS data queries
+   * Note: This method requires The Graph subgraph or additional indexing infrastructure
+   * as Portal's direct contract queries don't support listing all schemas.
+   * Consider using getSchema() for individual schema lookups.
    */
   getSchemas(_options?: GetSchemasOptions): Promise<SchemaData[]>;
   /**
    * Get an attestation by UID
-   *
-   * TODO: Implement using The Graph subgraph for EAS data queries
    */
   getAttestation(uid: Hex): Promise<AttestationInfo>;
   /**
    * Get attestations with pagination and filtering
    *
-   * TODO: Implement using The Graph subgraph for EAS data queries
+   * Note: This method requires The Graph subgraph or additional indexing infrastructure
+   * as Portal's direct contract queries don't support listing all attestations.
+   * Consider using getAttestation() for individual attestation lookups.
    */
   getAttestations(_options?: GetAttestationsOptions): Promise<AttestationInfo[]>;
   /**
    * Check if an attestation is valid
-   *
-   * TODO: Implement using The Graph subgraph for EAS data queries
    */
-  isValidAttestation(_uid: Hex): Promise<boolean>;
+  isValidAttestation(uid: Hex): Promise<boolean>;
   /**
-   * Get the current timestamp from the contract
+   * Get the timestamp for specific data
    *
-   * TODO: Fix Portal GraphQL query parameter encoding or use The Graph subgraph
+   * @param data - The data to get timestamp for
+   * @returns The timestamp when the data was timestamped
    */
-  getTimestamp(): Promise<bigint>;
+  getTimestamp(data: Hex): Promise<bigint>;
   /**
    * Get client configuration
    */

package/dist/browser/eas.js

@@ -6,8 +6,9 @@ import { isAddress, zeroAddress } from "viem";
 import { z } from "zod";
 
 //#region src/portal/operations.ts
-const GraphQLOperations = { mutations: {
-	deploySchemaRegistry: (graphql) => graphql(`
+const GraphQLOperations = {
+	mutations: {
+		deploySchemaRegistry: (graphql) => graphql(`
         mutation DeployContractEASSchemaRegistry(
           $from: String!
           $constructorArguments: DeployContractEASSchemaRegistryInput!
@@ -17,13 +18,13 @@ const GraphQLOperations = { mutations: {
             transactionHash
           }
         }`),
-	deployEAS: (graphql) => graphql(`
+		deployEAS: (graphql) => graphql(`
         mutation DeployContractEAS($from: String!, $constructorArguments: DeployContractEASInput!, $gasLimit: String!) {
           DeployContractEAS(from: $from, constructorArguments: $constructorArguments, gasLimit: $gasLimit) {
             transactionHash
           }
         }`),
-	registerSchema: (graphql) => graphql(`
+		registerSchema: (graphql) => graphql(`
         mutation EASSchemaRegistryRegister(
           $address: String!
           $from: String!
@@ -34,25 +35,68 @@ const GraphQLOperations = { mutations: {
             transactionHash
           }
         }`),
-	attest: (graphql) => graphql(`
+		attest: (graphql) => graphql(`
         mutation EASAttest($address: String!, $from: String!, $input: EASAttestInput!, $gasLimit: String!) {
           EASAttest(address: $address, from: $from, input: $input, gasLimit: $gasLimit) {
             transactionHash
           }
         }`),
-	multiAttest: (graphql) => graphql(`
+		multiAttest: (graphql) => graphql(`
         mutation EASMultiAttest($address: String!, $from: String!, $input: EASMultiAttestInput!, $gasLimit: String!) {
           EASMultiAttest(address: $address, from: $from, input: $input, gasLimit: $gasLimit) {
             transactionHash
           }
         }`),
-	revoke: (graphql) => graphql(`
+		revoke: (graphql) => graphql(`
         mutation EASRevoke($address: String!, $from: String!, $input: EASRevokeInput!, $gasLimit: String!) {
           EASRevoke(address: $address, from: $from, input: $input, gasLimit: $gasLimit) {
             transactionHash
           }
         }`)
-} };
+	},
+	queries: {
+		getSchema: (graphql) => graphql(`
+        query EASSchemaRegistryGetSchema($address: String!, $uid: String!) {
+          EASSchemaRegistry(address: $address) {
+            getSchema(uid: $uid) {
+              uid
+              resolver
+              revocable
+              schema
+            }
+          }
+        }`),
+		getAttestation: (graphql) => graphql(`
+        query EASGetAttestation($address: String!, $uid: String!) {
+          EAS(address: $address) {
+            getAttestation(uid: $uid) {
+              uid
+              schema
+              attester
+              recipient
+              time
+              expirationTime
+              revocable
+              refUID
+              data
+              revocationTime
+            }
+          }
+        }`),
+		isAttestationValid: (graphql) => graphql(`
+        query EASIsAttestationValid($address: String!, $uid: String!) {
+          EAS(address: $address) {
+            isAttestationValid(uid: $uid)
+          }
+        }`),
+		getTimestamp: (graphql) => graphql(`
+        query EASGetTimestamp($address: String!, $data: String!) {
+          EAS(address: $address) {
+            getTimestamp(data: $data)
+          }
+        }`)
+	}
+};
 
 //#endregion
 //#region src/schema.ts
@@ -483,51 +527,118 @@ var EASClient = class {
 	}
 	/**
 	* Get a schema by UID
-	*
-	* TODO: Implement using The Graph subgraph for EAS data queries
 	*/
 	async getSchema(uid) {
-		throw new Error(`Schema queries not implemented yet. Use The Graph subgraph for reading schema data. Schema UID: ${uid}`);
+		const schemaRegistryAddress = this.getSchemaRegistryAddress();
+		try {
+			const response = await this.portalClient.request(GraphQLOperations.queries.getSchema(this.portalGraphql), {
+				address: schemaRegistryAddress,
+				uid
+			});
+			const schemaResult = response.EASSchemaRegistry?.getSchema;
+			if (!schemaResult) {
+				throw new Error(`Schema not found: ${uid}`);
+			}
+			return {
+				uid: schemaResult.uid,
+				resolver: schemaResult.resolver,
+				revocable: Boolean(schemaResult.revocable),
+				schema: schemaResult.schema || ""
+			};
+		} catch (err) {
+			const error = err;
+			throw new Error(`Failed to get schema: ${error.message}`);
+		}
 	}
 	/**
 	* Get all schemas with pagination
 	*
-	* TODO: Implement using The Graph subgraph for EAS data queries
+	* Note: This method requires The Graph subgraph or additional indexing infrastructure
+	* as Portal's direct contract queries don't support listing all schemas.
+	* Consider using getSchema() for individual schema lookups.
 	*/
 	async getSchemas(_options) {
-		throw new Error("Schema listing not implemented yet. Use The Graph subgraph for reading schema data.");
+		throw new Error("Schema listing not implemented yet. Portal's direct contract queries don't support listing all schemas. Use getSchema() for individual schema lookups or implement The Graph subgraph integration for bulk queries.");
 	}
 	/**
 	* Get an attestation by UID
-	*
-	* TODO: Implement using The Graph subgraph for EAS data queries
 	*/
 	async getAttestation(uid) {
-		throw new Error(`Attestation queries not implemented yet. Use The Graph subgraph for reading attestation data. Attestation UID: ${uid}`);
+		const easAddress = this.getEASAddress();
+		try {
+			const response = await this.portalClient.request(GraphQLOperations.queries.getAttestation(this.portalGraphql), {
+				address: easAddress,
+				uid
+			});
+			const attestationResult = response.EAS?.getAttestation;
+			if (!attestationResult) {
+				throw new Error(`Attestation not found: ${uid}`);
+			}
+			return {
+				uid: attestationResult.uid,
+				schema: attestationResult.schema,
+				attester: attestationResult.attester,
+				recipient: attestationResult.recipient,
+				time: attestationResult.time ? BigInt(attestationResult.time) : BigInt(0),
+				expirationTime: attestationResult.expirationTime ? BigInt(attestationResult.expirationTime) : BigInt(0),
+				revocable: Boolean(attestationResult.revocable),
+				refUID: attestationResult.refUID,
+				data: attestationResult.data,
+				value: BigInt(0)
+			};
+		} catch (err) {
+			const error = err;
+			throw new Error(`Failed to get attestation: ${error.message}`);
+		}
 	}
 	/**
 	* Get attestations with pagination and filtering
 	*
-	* TODO: Implement using The Graph subgraph for EAS data queries
+	* Note: This method requires The Graph subgraph or additional indexing infrastructure
+	* as Portal's direct contract queries don't support listing all attestations.
+	* Consider using getAttestation() for individual attestation lookups.
 	*/
 	async getAttestations(_options) {
-		throw new Error("Attestation listing not implemented yet. Use The Graph subgraph for reading attestation data.");
+		throw new Error("Attestation listing not implemented yet. Portal's direct contract queries don't support listing all attestations. Use getAttestation() for individual attestation lookups or implement The Graph subgraph integration for bulk queries.");
 	}
 	/**
 	* Check if an attestation is valid
-	*
-	* TODO: Implement using The Graph subgraph for EAS data queries
 	*/
-	async isValidAttestation(_uid) {
-		return false;
+	async isValidAttestation(uid) {
+		const easAddress = this.getEASAddress();
+		try {
+			const response = await this.portalClient.request(GraphQLOperations.queries.isAttestationValid(this.portalGraphql), {
+				address: easAddress,
+				uid
+			});
+			return response.EAS?.isAttestationValid ?? false;
+		} catch (err) {
+			const error = err;
+			throw new Error(`Failed to check attestation validity: ${error.message}`);
+		}
 	}
 	/**
-	* Get the current timestamp from the contract
+	* Get the timestamp for specific data
 	*
-	* TODO: Fix Portal GraphQL query parameter encoding or use The Graph subgraph
+	* @param data - The data to get timestamp for
+	* @returns The timestamp when the data was timestamped
 	*/
-	async getTimestamp() {
-		throw new Error("Timestamp query not implemented yet. Fix Portal query parameters or use The Graph subgraph.");
+	async getTimestamp(data) {
+		const easAddress = this.getEASAddress();
+		try {
+			const response = await this.portalClient.request(GraphQLOperations.queries.getTimestamp(this.portalGraphql), {
+				address: easAddress,
+				data
+			});
+			const timestampResult = response.EAS?.getTimestamp;
+			if (timestampResult === undefined || timestampResult === null) {
+				throw new Error(`No timestamp found for data: ${data}`);
+			}
+			return BigInt(timestampResult);
+		} catch (err) {
+			const error = err;
+			throw new Error(`Failed to get timestamp: ${error.message}`);
+		}
 	}
 	/**
 	* Get client configuration