@settlemint/sdk-eas 2.3.5-prad3d4392 → 2.3.5-prb695ce87

package/dist/eas.d.cts

@@ -1,30 +1,11 @@
-import { z } from "zod/v4";
+import { GraphQLClient } from "graphql-request";
+import { Address, Hex } from "viem";
 
-//#region src/client-options.schema.d.ts
+//#region src/types.d.ts
 /**
-* Schema for validating EAS client configuration options.
-* Extends the base Viem client options with EAS-specific requirements.
+* Supported field types for EAS schema fields.
+* Maps to the Solidity types that can be used in EAS schemas.
 */
-/**
- * Schema for validating EAS client configuration options.
- * Extends the base Viem client options with EAS-specific requirements.
- */
-declare const ClientOptionsSchema: z.ZodObject<{
-  schemaRegistryAddress: z.ZodString;
-  attestationAddress: z.ZodString;
-  accessToken: z.ZodString;
-  chainId: z.ZodString;
-  chainName: z.ZodString;
-  rpcUrl: z.ZodString;
-}, z.core.$strip>;
-/**
- * Configuration options for creating an EAS client.
- * Combines EAS-specific options with base Viem client options.
- */
-type ClientOptions = z.infer<typeof ClientOptionsSchema>;
-
-//#endregion
-//#region src/types.d.ts
 /**
  * Supported field types for EAS schema fields.
  * Maps to the Solidity types that can be used in EAS schemas.
@@ -52,8 +33,28 @@ interface SchemaField {
   /** Optional description of the field's purpose */
   description?: string;
 }
+/**
+ * Configuration options for the EAS client
+ */
+interface EASClientOptions {
+  instance: string;
+  accessToken: string;
+  easContractAddress?: Address;
+  schemaRegistryContractAddress?: Address;
+  debug?: boolean;
+}
+/**
+ * Schema registration request
+ */
+interface SchemaRequest {
+  schema?: string;
+  fields?: SchemaField[];
+  resolver: Address;
+  revocable: boolean;
+}
 /**
  * Options for registering a new schema in the EAS Schema Registry.
+ * @deprecated Use SchemaRequest instead
  */
 interface RegisterSchemaOptions {
   /** Array of fields that make up the schema */
@@ -63,35 +64,178 @@ interface RegisterSchemaOptions {
   /** Whether attestations using this schema can be revoked */
   revocable: boolean;
 }
+/**
+ * Attestation data structure
+ */
+interface AttestationData {
+  recipient: Address;
+  expirationTime: bigint;
+  revocable: boolean;
+  refUID: Hex;
+  data: Hex;
+  value: bigint;
+}
+/**
+ * Attestation request
+ */
+interface AttestationRequest {
+  schema: Hex;
+  data: AttestationData;
+}
+/**
+ * Transaction result
+ */
+interface TransactionResult {
+  hash: Hex;
+  success: boolean;
+}
+/**
+ * Schema data from registry
+ */
+interface SchemaData {
+  uid: Hex;
+  resolver: Address;
+  revocable: boolean;
+  schema: string;
+}
+/**
+ * Attestation data from contract
+ */
+interface AttestationInfo {
+  uid: Hex;
+  schema: Hex;
+  attester: Address;
+  recipient: Address;
+  time: bigint;
+  expirationTime: bigint;
+  revocable: boolean;
+  refUID: Hex;
+  data: Hex;
+  value: bigint;
+}
+/**
+ * Options for retrieving schemas
+ */
+interface GetSchemasOptions extends Record<string, unknown> {
+  limit?: number;
+  offset?: number;
+  resolver?: Address;
+}
+/**
+ * Options for retrieving attestations
+ */
+interface GetAttestationsOptions extends Record<string, unknown> {
+  limit?: number;
+  offset?: number;
+  schema?: Hex;
+  attester?: Address;
+  recipient?: Address;
+}
+/**
+ * Contract deployment result
+ */
+interface DeploymentResult {
+  easAddress: Address;
+  schemaRegistryAddress: Address;
+} //#endregion
+//#region src/utils/validation.d.ts
+declare function validateFieldName(name: string): void;
+declare function validateFieldType(type: string): asserts type is EASFieldType;
+declare function validateSchemaFields(fields: SchemaField[]): void;
+declare function buildSchemaString(fields: SchemaField[]): string;
 
 //#endregion
 //#region src/eas.d.ts
 /**
- * Creates an EAS client for interacting with the Ethereum Attestation Service.
- *
- * @param options - Configuration options for the client
- * @returns An object containing the EAS client instance
- * @throws Will throw an error if the options fail validation
- *
- * @example
- * ```ts
- * import { createEASClient } from '@settlemint/sdk-eas';
- *
- * const client = createEASClient({
- *   schemaRegistryAddress: "0x1234567890123456789012345678901234567890",
- *   attestationAddress: "0x1234567890123456789012345678901234567890",
- *   accessToken: "your-access-token",
- *   chainId: "1",
- *   chainName: "Ethereum",
- *   rpcUrl: "http://localhost:8545"
- * });
- * ```
+ * Main EAS client class
  */
-declare function createEASClient(options: ClientOptions): {
-  registerSchema: (options: RegisterSchemaOptions) => Promise<string>;
-  getSchema: (uid: string) => Promise<string>;
-};
+declare class EASClient {
+  private options;
+  private portalClient;
+  private deployedAddresses?;
+  constructor(options: EASClientOptions);
+  /**
+   * Deploy EAS contracts (if needed)
+   */
+  deploy(): Promise<DeploymentResult>;
+  /**
+   * Get the EAS contract address (from options or deployment)
+   */
+  private getEASAddress;
+  /**
+   * Get the Schema Registry contract address (from options or deployment)
+   */
+  private getSchemaRegistryAddress;
+  /**
+   * Register a new schema
+   */
+  registerSchema(request: SchemaRequest): Promise<TransactionResult>;
+  /**
+   * Create an attestation
+   */
+  attest(request: AttestationRequest): Promise<TransactionResult>;
+  /**
+   * Create multiple attestations
+   */
+  multiAttest(requests: AttestationRequest[]): Promise<TransactionResult>;
+  /**
+   * Revoke an attestation
+   */
+  revoke(uid: Hex, value?: bigint): Promise<TransactionResult>;
+  /**
+   * Get a schema by UID
+   */
+  getSchema(uid: Hex): Promise<SchemaData>;
+  /**
+   * Get all schemas (paginated)
+   */
+  getSchemas(options?: GetSchemasOptions): Promise<SchemaData[]>;
+  /**
+   * Get an attestation by UID
+   */
+  getAttestation(uid: Hex): Promise<AttestationInfo>;
+  /**
+   * Get attestations (paginated)
+   */
+  getAttestations(options?: GetAttestationsOptions): Promise<AttestationInfo[]>;
+  /**
+   * Check if an attestation is valid
+   */
+  isValidAttestation(uid: Hex): Promise<boolean>;
+  /**
+   * Get the current timestamp from the contract
+   */
+  getTimestamp(): Promise<bigint>;
+  /**
+   * Get client configuration
+   */
+  getOptions(): EASClientOptions;
+  /**
+   * Get the Portal client instance for advanced operations
+   */
+  getPortalClient(): GraphQLClient;
+  /**
+   * Get current contract addresses (from options or deployment)
+   */
+  getContractAddresses(): {
+    easAddress?: Address;
+    schemaRegistryAddress?: Address;
+  };
+  /**
+   * Mock Portal GraphQL call - replace with actual implementation later
+   * This provides a clean way to add real Portal calls
+   */
+  private mockPortalCall;
+  /**
+   * Build schema string from fields - utility method
+   */
+  private buildSchemaString;
+}
+/**
+ * Create a new EAS client instance
+ */
+declare function createEASClient(options: EASClientOptions): EASClient;
 
 //#endregion
-export { ClientOptions, ClientOptionsSchema, EASFieldType, EAS_FIELD_TYPES, RegisterSchemaOptions, SchemaField, createEASClient };
+export { AttestationData, AttestationInfo, AttestationRequest, DeploymentResult, EASClient, EASClientOptions, EASFieldType, EAS_FIELD_TYPES, GetAttestationsOptions, GetSchemasOptions, RegisterSchemaOptions, SchemaData, SchemaField, SchemaRequest, TransactionResult, buildSchemaString, createEASClient, validateSchemaFields };
 //# sourceMappingURL=eas.d.cts.map

package/dist/eas.d.ts

@@ -1,30 +1,11 @@
-import { z } from "zod/v4";
+import { GraphQLClient } from "graphql-request";
+import { Address, Hex } from "viem";
 
-//#region src/client-options.schema.d.ts
+//#region src/types.d.ts
 /**
-* Schema for validating EAS client configuration options.
-* Extends the base Viem client options with EAS-specific requirements.
+* Supported field types for EAS schema fields.
+* Maps to the Solidity types that can be used in EAS schemas.
 */
-/**
- * Schema for validating EAS client configuration options.
- * Extends the base Viem client options with EAS-specific requirements.
- */
-declare const ClientOptionsSchema: z.ZodObject<{
-  schemaRegistryAddress: z.ZodString;
-  attestationAddress: z.ZodString;
-  accessToken: z.ZodString;
-  chainId: z.ZodString;
-  chainName: z.ZodString;
-  rpcUrl: z.ZodString;
-}, z.core.$strip>;
-/**
- * Configuration options for creating an EAS client.
- * Combines EAS-specific options with base Viem client options.
- */
-type ClientOptions = z.infer<typeof ClientOptionsSchema>;
-
-//#endregion
-//#region src/types.d.ts
 /**
  * Supported field types for EAS schema fields.
  * Maps to the Solidity types that can be used in EAS schemas.
@@ -52,8 +33,28 @@ interface SchemaField {
   /** Optional description of the field's purpose */
   description?: string;
 }
+/**
+ * Configuration options for the EAS client
+ */
+interface EASClientOptions {
+  instance: string;
+  accessToken: string;
+  easContractAddress?: Address;
+  schemaRegistryContractAddress?: Address;
+  debug?: boolean;
+}
+/**
+ * Schema registration request
+ */
+interface SchemaRequest {
+  schema?: string;
+  fields?: SchemaField[];
+  resolver: Address;
+  revocable: boolean;
+}
 /**
  * Options for registering a new schema in the EAS Schema Registry.
+ * @deprecated Use SchemaRequest instead
  */
 interface RegisterSchemaOptions {
   /** Array of fields that make up the schema */
@@ -63,35 +64,178 @@ interface RegisterSchemaOptions {
   /** Whether attestations using this schema can be revoked */
   revocable: boolean;
 }
+/**
+ * Attestation data structure
+ */
+interface AttestationData {
+  recipient: Address;
+  expirationTime: bigint;
+  revocable: boolean;
+  refUID: Hex;
+  data: Hex;
+  value: bigint;
+}
+/**
+ * Attestation request
+ */
+interface AttestationRequest {
+  schema: Hex;
+  data: AttestationData;
+}
+/**
+ * Transaction result
+ */
+interface TransactionResult {
+  hash: Hex;
+  success: boolean;
+}
+/**
+ * Schema data from registry
+ */
+interface SchemaData {
+  uid: Hex;
+  resolver: Address;
+  revocable: boolean;
+  schema: string;
+}
+/**
+ * Attestation data from contract
+ */
+interface AttestationInfo {
+  uid: Hex;
+  schema: Hex;
+  attester: Address;
+  recipient: Address;
+  time: bigint;
+  expirationTime: bigint;
+  revocable: boolean;
+  refUID: Hex;
+  data: Hex;
+  value: bigint;
+}
+/**
+ * Options for retrieving schemas
+ */
+interface GetSchemasOptions extends Record<string, unknown> {
+  limit?: number;
+  offset?: number;
+  resolver?: Address;
+}
+/**
+ * Options for retrieving attestations
+ */
+interface GetAttestationsOptions extends Record<string, unknown> {
+  limit?: number;
+  offset?: number;
+  schema?: Hex;
+  attester?: Address;
+  recipient?: Address;
+}
+/**
+ * Contract deployment result
+ */
+interface DeploymentResult {
+  easAddress: Address;
+  schemaRegistryAddress: Address;
+} //#endregion
+//#region src/utils/validation.d.ts
+declare function validateFieldName(name: string): void;
+declare function validateFieldType(type: string): asserts type is EASFieldType;
+declare function validateSchemaFields(fields: SchemaField[]): void;
+declare function buildSchemaString(fields: SchemaField[]): string;
 
 //#endregion
 //#region src/eas.d.ts
 /**
- * Creates an EAS client for interacting with the Ethereum Attestation Service.
- *
- * @param options - Configuration options for the client
- * @returns An object containing the EAS client instance
- * @throws Will throw an error if the options fail validation
- *
- * @example
- * ```ts
- * import { createEASClient } from '@settlemint/sdk-eas';
- *
- * const client = createEASClient({
- *   schemaRegistryAddress: "0x1234567890123456789012345678901234567890",
- *   attestationAddress: "0x1234567890123456789012345678901234567890",
- *   accessToken: "your-access-token",
- *   chainId: "1",
- *   chainName: "Ethereum",
- *   rpcUrl: "http://localhost:8545"
- * });
- * ```
+ * Main EAS client class
  */
-declare function createEASClient(options: ClientOptions): {
-  registerSchema: (options: RegisterSchemaOptions) => Promise<string>;
-  getSchema: (uid: string) => Promise<string>;
-};
+declare class EASClient {
+  private options;
+  private portalClient;
+  private deployedAddresses?;
+  constructor(options: EASClientOptions);
+  /**
+   * Deploy EAS contracts (if needed)
+   */
+  deploy(): Promise<DeploymentResult>;
+  /**
+   * Get the EAS contract address (from options or deployment)
+   */
+  private getEASAddress;
+  /**
+   * Get the Schema Registry contract address (from options or deployment)
+   */
+  private getSchemaRegistryAddress;
+  /**
+   * Register a new schema
+   */
+  registerSchema(request: SchemaRequest): Promise<TransactionResult>;
+  /**
+   * Create an attestation
+   */
+  attest(request: AttestationRequest): Promise<TransactionResult>;
+  /**
+   * Create multiple attestations
+   */
+  multiAttest(requests: AttestationRequest[]): Promise<TransactionResult>;
+  /**
+   * Revoke an attestation
+   */
+  revoke(uid: Hex, value?: bigint): Promise<TransactionResult>;
+  /**
+   * Get a schema by UID
+   */
+  getSchema(uid: Hex): Promise<SchemaData>;
+  /**
+   * Get all schemas (paginated)
+   */
+  getSchemas(options?: GetSchemasOptions): Promise<SchemaData[]>;
+  /**
+   * Get an attestation by UID
+   */
+  getAttestation(uid: Hex): Promise<AttestationInfo>;
+  /**
+   * Get attestations (paginated)
+   */
+  getAttestations(options?: GetAttestationsOptions): Promise<AttestationInfo[]>;
+  /**
+   * Check if an attestation is valid
+   */
+  isValidAttestation(uid: Hex): Promise<boolean>;
+  /**
+   * Get the current timestamp from the contract
+   */
+  getTimestamp(): Promise<bigint>;
+  /**
+   * Get client configuration
+   */
+  getOptions(): EASClientOptions;
+  /**
+   * Get the Portal client instance for advanced operations
+   */
+  getPortalClient(): GraphQLClient;
+  /**
+   * Get current contract addresses (from options or deployment)
+   */
+  getContractAddresses(): {
+    easAddress?: Address;
+    schemaRegistryAddress?: Address;
+  };
+  /**
+   * Mock Portal GraphQL call - replace with actual implementation later
+   * This provides a clean way to add real Portal calls
+   */
+  private mockPortalCall;
+  /**
+   * Build schema string from fields - utility method
+   */
+  private buildSchemaString;
+}
+/**
+ * Create a new EAS client instance
+ */
+declare function createEASClient(options: EASClientOptions): EASClient;
 
 //#endregion
-export { ClientOptions, ClientOptionsSchema, EASFieldType, EAS_FIELD_TYPES, RegisterSchemaOptions, SchemaField, createEASClient };
+export { AttestationData, AttestationInfo, AttestationRequest, DeploymentResult, EASClient, EASClientOptions, EASFieldType, EAS_FIELD_TYPES, GetAttestationsOptions, GetSchemasOptions, RegisterSchemaOptions, SchemaData, SchemaField, SchemaRequest, TransactionResult, buildSchemaString, createEASClient, validateSchemaFields };
 //# sourceMappingURL=eas.d.ts.map