@settlemint/sdk-eas 2.3.5-pr37a28299 → 2.3.5-pr4254bb99

package/dist/browser/eas.d.ts

@@ -1,30 +1,15 @@
-import { z } from "zod/v4";
+import { createPortalClient } from "@settlemint/sdk-portal";
+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.
+* Common address constants
 */
 /**
- * Schema for validating EAS client configuration options.
- * Extends the base Viem client options with EAS-specific requirements.
+ * Common address constants
  */
-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
+declare const ZERO_ADDRESS: Address;
+declare const ZERO_BYTES32: Hex;
 /**
  * Supported field types for EAS schema fields.
  * Maps to the Solidity types that can be used in EAS schemas.
@@ -53,45 +38,317 @@ interface SchemaField {
   description?: string;
 }
 /**
- * Options for registering a new schema in the EAS Schema Registry.
+ * 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
  */
-interface RegisterSchemaOptions {
-  /** Array of fields that make up the schema */
-  fields: SchemaField[];
-  /** Address of the resolver contract that will handle attestations */
-  resolverAddress: string;
+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;
   /** 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;
+}
+/**
+ * @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/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"
- * });
- * ```
- */
-declare function createEASClient(options: ClientOptions): {
-  registerSchema: (options: RegisterSchemaOptions) => Promise<string>;
-  getSchema: (uid: string) => Promise<string>;
-};
+ * 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
+   * @param deployerAddress - Address to deploy contracts from
+   * @param forwarderAddress - Optional forwarder address for meta-transactions (defaults to zero address)
+   * @param gasLimit - Optional gas limit for deployment transactions
+   */
+  deploy(deployerAddress: Address, forwarderAddress?: Address, gasLimit?: string): Promise<DeploymentResult>;
+  /**
+   * Get the EAS contract address
+   */
+  private getEASAddress;
+  /**
+   * Get the Schema Registry contract address
+   */
+  private getSchemaRegistryAddress;
+  /**
+   * Register a new schema in the EAS Schema Registry
+   * @param request - Schema registration request
+   * @param fromAddress - Address to send transaction from
+   * @param gasLimit - Optional gas limit for the transaction
+   */
+  registerSchema(request: SchemaRequest, fromAddress: Address, gasLimit?: string): Promise<TransactionResult>;
+  /**
+   * Create an attestation
+   * @param request - Attestation request
+   * @param fromAddress - Address to send transaction from
+   * @param gasLimit - Optional gas limit for the transaction
+   */
+  attest(request: AttestationRequest, fromAddress: Address, gasLimit?: string): Promise<TransactionResult>;
+  /**
+   * Create multiple attestations in a single transaction
+   * @param requests - Array of attestation requests
+   * @param fromAddress - Address to send transaction from
+   * @param gasLimit - Optional gas limit for the transaction
+   */
+  multiAttest(requests: AttestationRequest[], fromAddress: Address, gasLimit?: string): Promise<TransactionResult>;
+  /**
+   * Revoke an attestation
+   * @param uid - UID of the attestation to revoke
+   * @param fromAddress - Address to send transaction from
+   * @param value - Optional value to send with revocation
+   * @param gasLimit - Optional gas limit for the transaction
+   */
+  revoke(uid: Hex, fromAddress: Address, value?: bigint, gasLimit?: string): Promise<TransactionResult>;
+  /**
+   * Get a schema by UID
+   */
+  getSchema(uid: Hex): Promise<SchemaData>;
+  /**
+   * Get all schemas with pagination
+   */
+  getSchemas(options?: GetSchemasOptions): Promise<SchemaData[]>;
+  /**
+   * Get an attestation by UID
+   */
+  getAttestation(uid: Hex): Promise<AttestationInfo>;
+  /**
+   * Get attestations with pagination and filtering
+   */
+  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(): ReturnType<typeof createPortalClient>["client"];
+  /**
+   * Get current contract addresses
+   */
+  getContractAddresses(): {
+    easAddress?: Address;
+    schemaRegistryAddress?: Address;
+  };
+  /**
+   * Build schema string from fields
+   */
+  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, ZERO_ADDRESS, ZERO_BYTES32, buildSchemaString, createEASClient, validateSchemaFields };
 //# sourceMappingURL=eas.d.ts.map