@settlemint/sdk-eas 2.3.5-pra3eb4e90 → 2.3.5-prb4784bd0

package/dist/browser/eas.d.ts

@@ -1,15 +1,30 @@
-import { createPortalClient } from "@settlemint/sdk-portal";
-import { Address, Hex } from "viem";
+import { z } from "zod/v4";
 
-//#region src/types.d.ts
+//#region src/client-options.schema.d.ts
 /**
-* Common address constants
+* Schema for validating EAS client configuration options.
+* Extends the base Viem client options with EAS-specific requirements.
 */
 /**
- * Common address constants
+ * 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.
  */
-declare const ZERO_ADDRESS: Address;
-declare const ZERO_BYTES32: Hex;
+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.
@@ -38,349 +53,45 @@ interface SchemaField {
   description?: string;
 }
 /**
- * Configuration options for the EAS client
- */
-interface EASClientOptions {
-  /** Portal GraphQL endpoint URL */
-  instance: string;
-  /** Portal access token */
-  accessToken: string;
-  /** Optional EAS contract address (if already deployed) */
-  easContractAddress?: Address;
-  /** Optional Schema Registry contract address (if already deployed) */
-  schemaRegistryContractAddress?: Address;
-  /** Enable debug logging */
-  debug?: boolean;
-}
-/**
- * Schema registration request
+ * Options for registering a new schema in the EAS Schema Registry.
  */
-interface SchemaRequest {
-  /** Schema fields (alternative to schema string) */
-  fields?: SchemaField[];
-  /** Raw schema string (alternative to fields) */
-  schema?: string;
-  /** Resolver contract address (use ZERO_ADDRESS for no resolver) */
-  resolver: Address;
+interface RegisterSchemaOptions {
+  /** Array of fields that make up the schema */
+  fields: SchemaField[];
+  /** Address of the resolver contract that will handle attestations */
+  resolverAddress: string;
   /** Whether attestations using this schema can be revoked */
   revocable: boolean;
 }
-/**
- * Attestation data structure
- */
-interface AttestationData {
-  /** Recipient of the attestation */
-  recipient: Address;
-  /** Expiration time (0 for no expiration) */
-  expirationTime: bigint;
-  /** Whether this attestation can be revoked */
-  revocable: boolean;
-  /** Reference UID (use ZERO_BYTES32 for no reference) */
-  refUID: Hex;
-  /** Encoded attestation data */
-  data: Hex;
-  /** Value sent with the attestation */
-  value: bigint;
-}
-/**
- * Attestation request
- */
-interface AttestationRequest {
-  /** Schema UID to attest against */
-  schema: Hex;
-  /** Attestation data */
-  data: AttestationData;
-}
-/**
- * Transaction result
- */
-interface TransactionResult {
-  /** Transaction hash */
-  hash: Hex;
-  /** Whether the transaction was successful */
-  success: boolean;
-}
-/**
- * Schema information
- */
-interface SchemaData {
-  /** Schema UID */
-  uid: Hex;
-  /** Resolver contract address */
-  resolver: Address;
-  /** Whether attestations can be revoked */
-  revocable: boolean;
-  /** Schema string */
-  schema: string;
-}
-/**
- * Attestation information
- */
-interface AttestationInfo {
-  /** Attestation UID */
-  uid: Hex;
-  /** Schema UID */
-  schema: Hex;
-  /** Address that created the attestation */
-  attester: Address;
-  /** Recipient of the attestation */
-  recipient: Address;
-  /** Creation timestamp */
-  time: bigint;
-  /** Expiration timestamp */
-  expirationTime: bigint;
-  /** Whether this attestation can be revoked */
-  revocable: boolean;
-  /** Reference UID */
-  refUID: Hex;
-  /** Encoded attestation data */
-  data: Hex;
-  /** Value sent with the attestation */
-  value: bigint;
-}
-/**
- * Options for retrieving schemas
- */
-interface GetSchemasOptions {
-  /** Maximum number of schemas to return */
-  limit?: number;
-  /** Number of schemas to skip */
-  offset?: number;
-}
-/**
- * Options for retrieving attestations
- */
-interface GetAttestationsOptions {
-  /** Maximum number of attestations to return */
-  limit?: number;
-  /** Number of attestations to skip */
-  offset?: number;
-  /** Filter by schema UID */
-  schema?: Hex;
-  /** Filter by attester address */
-  attester?: Address;
-  /** Filter by recipient address */
-  recipient?: Address;
-}
-/**
- * Contract deployment result
- */
-interface DeploymentResult {
-  /** Deployed EAS contract address */
-  easAddress: Address;
-  /** Deployed Schema Registry contract address */
-  schemaRegistryAddress: Address;
-  /** EAS deployment transaction hash (when address not immediately available) */
-  easTransactionHash?: Hex;
-  /** Schema Registry deployment transaction hash (when address not immediately available) */
-  schemaRegistryTransactionHash?: Hex;
-}
-/**
- * @deprecated Use SchemaRequest instead
- */
-interface RegisterSchemaOptions extends SchemaRequest {}
-/**
- * @internal
- * Portal transaction response structure
- */
-interface PortalTransactionResponse {
-  transactionHash?: string;
-  contractAddress?: string;
-}
-/**
- * @internal
- * Portal schema response structure
- */
-interface PortalSchemaResponse {
-  EASSchemaRegistry?: {
-    getSchema?: {
-      uid: string;
-      resolver: string;
-      revocable: boolean;
-      schema: string;
-    };
-  };
-}
-/**
- * @internal
- * Portal attestation response structure
- */
-interface PortalAttestationResponse {
-  EAS?: {
-    getAttestation?: {
-      uid: string;
-      schema: string;
-      attester: string;
-      recipient: string;
-      time: string;
-      expirationTime: string;
-      revocable: boolean;
-      refUID: string;
-      data: string;
-    };
-    isAttestationValid?: boolean;
-    getTimestamp?: string;
-  };
-}
-/**
- * @internal
- * Portal contracts response structure
- */
-interface PortalContractsResponse {
-  getContractsEasSchemaRegistry?: {
-    count: number;
-    records: Array<{
-      address: string;
-      abiName: string;
-      createdAt: string;
-    }>;
-  };
-  getContractsEas?: {
-    count: number;
-    records: Array<{
-      address: string;
-      abiName: string;
-      createdAt: string;
-    }>;
-  };
-} //#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/graphql/operations.d.ts
-declare const DEPLOY_SCHEMA_REGISTRY_MUTATION: string;
-declare const DEPLOY_EAS_MUTATION: string;
-declare const REGISTER_SCHEMA_MUTATION: string;
-declare const ATTEST_MUTATION: string;
-declare const MULTI_ATTEST_MUTATION: string;
-declare const REVOKE_MUTATION: string;
-declare const GET_SCHEMA_QUERY: string;
-declare const GET_SCHEMAS_QUERY: string;
-declare const GET_ATTESTATION_QUERY: string;
-declare const IS_ATTESTATION_VALID_QUERY: string;
-declare const GET_TIMESTAMP_QUERY: string;
-declare const GET_ATTESTATIONS_QUERY: string;
-/**
- * All GraphQL operations organized by category
- */
-declare const GraphQLOperations: {
-  readonly mutations: {
-    readonly deploySchemaRegistry: string;
-    readonly deployEAS: string;
-    readonly registerSchema: string;
-    readonly attest: string;
-    readonly multiAttest: string;
-    readonly revoke: string;
-  };
-  readonly queries: {
-    readonly getSchema: string;
-    readonly getSchemas: string;
-    readonly getAttestation: string;
-    readonly getAttestations: string;
-    readonly isAttestationValid: string;
-    readonly getTimestamp: string;
-  };
-};
-/**
- * Type-safe access to GraphQL operations
- */
-type GraphQLMutations = typeof GraphQLOperations.mutations;
-type GraphQLQueries = typeof GraphQLOperations.queries;
 
 //#endregion
 //#region src/eas.d.ts
 /**
- * Main EAS client class for interacting with Ethereum Attestation Service via Portal
- */
-declare class EASClient {
-  private options;
-  private portalClient;
-  private deployedAddresses?;
-  constructor(options: EASClientOptions);
-  /**
-   * Deploy EAS contracts via Portal
-   */
-  deploy(deployerAddress: Address, forwarderAddress?: Address, gasLimit?: string): Promise<DeploymentResult>;
-  /**
-   * Register a new schema in the EAS Schema Registry
-   */
-  registerSchema(request: SchemaRequest, fromAddress: Address, gasLimit?: string): Promise<TransactionResult>;
-  /**
-   * Create an attestation
-   */
-  attest(request: AttestationRequest, fromAddress: Address, gasLimit?: string): Promise<TransactionResult>;
-  /**
-   * Create multiple attestations in a single transaction
-   */
-  multiAttest(requests: AttestationRequest[], fromAddress: Address, gasLimit?: string): Promise<TransactionResult>;
-  /**
-   * Revoke an attestation
-   */
-  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
-   */
-  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
-   */
-  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>;
-  /**
-   * Get the current timestamp from the contract
-   *
-   * TODO: Fix Portal GraphQL query parameter encoding or use The Graph subgraph
-   */
-  getTimestamp(): Promise<bigint>;
-  /**
-   * Get client configuration
-   */
-  getOptions(): EASClientOptions;
-  /**
-   * Get the Portal client instance for advanced operations
-   */
-  getPortalClient(): ReturnType<typeof createPortalClient>["client"];
-  /**
-   * Get current contract addresses
-   */
-  getContractAddresses(): {
-    easAddress?: Address;
-    schemaRegistryAddress?: Address;
-  };
-  private getEASAddress;
-  private getSchemaRegistryAddress;
-  private buildSchemaString;
-}
-/**
- * Create a new EAS client instance
- */
-declare function createEASClient(options: EASClientOptions): EASClient;
+ * 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"
+ * });
+ * ```
+ */
+declare function createEASClient(options: ClientOptions): {
+  registerSchema: (options: RegisterSchemaOptions) => Promise<string>;
+  getSchema: (uid: string) => Promise<string>;
+};
 
 //#endregion
-export { AttestationData, AttestationInfo, AttestationRequest, DeploymentResult, EASClient, EASClientOptions, EASFieldType, EAS_FIELD_TYPES, GetAttestationsOptions, GetSchemasOptions, GraphQLOperations, RegisterSchemaOptions, SchemaData, SchemaField, SchemaRequest, TransactionResult, ZERO_ADDRESS, ZERO_BYTES32, buildSchemaString, createEASClient, validateSchemaFields };
+export { ClientOptions, ClientOptionsSchema, EASFieldType, EAS_FIELD_TYPES, RegisterSchemaOptions, SchemaField, createEASClient };
 //# sourceMappingURL=eas.d.ts.map