@settlemint/sdk-eas 2.3.2-pr3dad35bd → 2.3.2-pr472d8b55

package/dist/browser/eas.d.ts

@@ -0,0 +1,97 @@
+import { z } from "zod/v4";
+
+//#region src/client-options.schema.d.ts
+/**
+* Schema for validating EAS client configuration options.
+* Extends the base Viem client options with EAS-specific requirements.
+*/
+/**
+ * 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.
+ */
+declare const EAS_FIELD_TYPES: {
+  readonly string: "string";
+  readonly address: "address";
+  readonly bool: "bool";
+  readonly bytes: "bytes";
+  readonly bytes32: "bytes32";
+  readonly uint256: "uint256";
+  readonly int256: "int256";
+  readonly uint8: "uint8";
+  readonly int8: "int8";
+};
+type EASFieldType = keyof typeof EAS_FIELD_TYPES;
+/**
+ * Represents a single field in an EAS schema.
+ */
+interface SchemaField {
+  /** The name of the field */
+  name: string;
+  /** The Solidity type of the field */
+  type: EASFieldType;
+  /** Optional description of the field's purpose */
+  description?: string;
+}
+/**
+ * Options for registering a new schema in the EAS Schema Registry.
+ */
+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;
+}
+
+//#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>;
+};
+
+//#endregion
+export { ClientOptions, ClientOptionsSchema, EASFieldType, EAS_FIELD_TYPES, RegisterSchemaOptions, SchemaField, createEASClient };
+//# sourceMappingURL=eas.d.ts.map