feat(eas): restore all work on EAS portal implementation

Author: robbeverhelst

sdk/eas/README.md

@@ -90,25 +90,223 @@ Will throw an error if the options fail validation
 import { createEASClient } from '@settlemint/sdk-eas';
 
 const client = createEASClient({
-  schemaRegistryAddress: "0x1234567890123456789012345678901234567890",
-  attestationAddress: "0x1234567890123456789012345678901234567890",
+  instance: "https://attestation-portal-ee231.gke-europe.settlemint.com/graphql",
+  accessToken: "your-portal-access-token",
+  debug: true,
+});
+
+// Deploy contracts
+const deployment = await client.deploy("0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6");
+
+// Register schema
+const schema = await client.registerSchema({
+  fields: [
+    { name: "user", type: "address" },
+    { name: "score", type: "uint256" },
+  ],
+  resolver: ZERO_ADDRESS, // No resolver
+  revocable: true,
+}, "0x8ba1f109551bD432803012645Hac136c22C177ec");
+
+// Create attestation
+const attestation = await client.attest({
+  schema: schema.hash,
+  data: {
+    recipient: "0x9876543210987654321098765432109876543210",
+    expirationTime: BigInt(0), // No expiration
+    revocable: true,
+    refUID: ZERO_BYTES32, // No reference
+    data: "0x1234",
+    value: BigInt(0),
+  },
+}, "0x8ba1f109551bD432803012645Hac136c22C177ec");
+```
+
+## Configuration Constants
+
+The SDK provides configurable constants instead of hardcoded values:
+
+### Address Constants
+
+```typescript
+import { ZERO_ADDRESS, ZERO_BYTES32 } from "@settlemint/sdk-eas";
+
+// Use ZERO_ADDRESS for:
+ZERO_ADDRESS // "0x0000000000000000000000000000000000000000"
+
+// Use ZERO_BYTES32 for:
+ZERO_BYTES32 // "0x0000000000000000000000000000000000000000000000000000000000000000"
+```
+
+### Configurable Parameters
+
+#### 1. Forwarder Address (Contract Deployment)
+
+```typescript
+// Option 1: No meta-transaction forwarder (default)
+await client.deploy(deployerAddress); // Uses ZERO_ADDRESS
+
+// Option 2: Custom forwarder for meta-transactions
+await client.deploy(deployerAddress, "0x1234567890123456789012345678901234567890");
+```
+
+#### 2. Resolver Address (Schema Registration)
+
+```typescript
+// Option 1: No resolver (most common)
+await client.registerSchema({
+  fields: [...],
+  resolver: ZERO_ADDRESS, // No custom validation
+  revocable: true,
+}, fromAddress);
+
+// Option 2: Custom resolver contract
+await client.registerSchema({
+  fields: [...],
+  resolver: "0x5678901234567890123456789012345678901234", // Custom validation
+  revocable: true,
+}, fromAddress);
+```
+
+#### 3. Reference UID (Attestation Creation)
+
+```typescript
+// Option 1: Standalone attestation (most common)
+await client.attest({
+  schema: schemaUID,
+  data: {
+    recipient: recipientAddress,
+    refUID: ZERO_BYTES32, // No reference to other attestations
+    // ... other fields
+  },
+}, fromAddress);
+
+// Option 2: Reference another attestation
+await client.attest({
+  schema: schemaUID,
+  data: {
+    recipient: recipientAddress,
+    refUID: "0x1234567890123456789012345678901234567890123456789012345678901234", // Links to parent
+    // ... other fields
+  },
+}, fromAddress);
+```
+
+#### 4. Expiration Time
+
+```typescript
+// Option 1: No expiration (permanent)
+expirationTime: BigInt(0)
+
+// Option 2: Expires in 24 hours
+expirationTime: BigInt(Math.floor(Date.now() / 1000) + 86400)
+
+// Option 3: Specific timestamp
+expirationTime: BigInt(1735689600) // January 1, 2025
+```
+
+#### 5. Value (ETH Amount)
+
+```typescript
+// Option 1: No ETH sent (most common)
+value: BigInt(0)
+
+// Option 2: Send ETH with attestation
+value: BigInt("1000000000000000000") // 1 ETH in wei
+```
+
+## API Reference
+
+### Functions
+
+#### createEASClient()
+
+> **createEASClient**(`options`): [`EASPortalClient`](#easportalclient)
+
+Creates a Portal-based EAS client for interacting with the Ethereum Attestation Service.
+Defined in: [sdk/eas/src/eas.ts:36](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/eas/src/eas.ts#L36)
+
+Creates an EAS client for interacting with the Ethereum Attestation Service.
+
+##### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`PortalClientOptions`](#portalclientoptions) | Configuration options for the Portal-based client |
+
+##### Returns
+
+[`EASPortalClient`](#easportalclient)
+
+An EAS Portal client instance
+`object`
+
+An object containing the EAS client instance
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `getSchema()` | (`uid`) => `Promise`\<`string`\> | [sdk/eas/src/eas.ts:96](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/eas/src/eas.ts#L96) |
+| `registerSchema()` | (`options`) => `Promise`\<`string`\> | [sdk/eas/src/eas.ts:95](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/eas/src/eas.ts#L95) |
+
+##### Throws
+
+Will throw an error if the options fail validation
+
+##### Example
+
+```ts
+import { createEASClient } from '@settlemint/sdk-eas';
+
+const client = createEASClient({
+  instance: "https://portal.settlemint.com",
   accessToken: "your-access-token",
-  chainId: "1",
-  chainName: "Ethereum",
-  rpcUrl: "http://localhost:8545"
+  easContractAddress: "0x...",
+  schemaRegistryContractAddress: "0x...",
 });
 ```
 
+### Classes
+
+#### EASPortalClient
+
+The main client class for interacting with EAS contracts via Portal.
+
+##### Methods
+
+- `registerSchema(request: SchemaRequest): Promise<TransactionResult>` - Register a new schema
+- `attest(request: AttestationRequest): Promise<TransactionResult>` - Create an attestation
+- `multiAttest(requests: AttestationRequest[]): Promise<TransactionResult>` - Create multiple attestations
+- `revoke(uid: Hex, value?: bigint): Promise<TransactionResult>` - Revoke an attestation
+- `getAttestation(uid: Hex): Promise<AttestationData>` - Retrieve attestation data
+- `getSchema(uid: Hex): Promise<SchemaData>` - Retrieve schema data
+- `isValidAttestation(uid: Hex): Promise<boolean>` - Check if attestation is valid
+- `getTimestamp(): Promise<bigint>` - Get current contract timestamp
+- `getPortalClient(): unknown` - Access underlying Portal client
+- `getOptions(): PortalClientOptions` - Get client configuration
+- `getAbis(): { easAbi: Abi; schemaRegistryAbi: Abi }` - Get current ABIs
+
 ### Interfaces
 
-#### RegisterSchemaOptions
+#### PortalClientOptions
 
+Configuration options for the EAS Portal client.
 Defined in: [sdk/eas/src/types.ts:34](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/eas/src/types.ts#L34)
 
 Options for registering a new schema in the EAS Schema Registry.
 
 ##### Properties
 
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `instance` | `string` | Portal instance URL or path |
+| `accessToken` | `string` | Access token for Portal authentication |
+| `easContractAddress` | `string` | The address of the EAS Attestation contract |
+| `schemaRegistryContractAddress` | `string` | The address of the EAS Schema Registry contract |
+| `abiSource?` | [`AbiSource`](#abisource) | ABI source configuration (defaults to hardcoded) |
+| `wsUrl?` | `string` | Optional WebSocket URL for real-time monitoring |
+| `timeout?` | `number` | Request timeout in milliseconds (default: 30000) |
+| `debug?` | `boolean` | Enable debug logging (default: false) |
+| `cache?` | `string` | Cache configuration for GraphQL requests |
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
 | <a id="fields"></a> `fields` | [`SchemaField`](#schemafield)[] | Array of fields that make up the schema | [sdk/eas/src/types.ts:36](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/eas/src/types.ts#L36) |
@@ -125,6 +323,11 @@ Represents a single field in an EAS schema.
 
 ##### Properties
 
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `name` | `string` | The name of the field |
+| `type` | `EASFieldType` | The Solidity type of the field |
+| `description?` | `string` | Optional description of the field's purpose |
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
 | <a id="description"></a> `description?` | `string` | Optional description of the field's purpose | [sdk/eas/src/types.ts:28](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/eas/src/types.ts#L28) |
@@ -133,6 +336,16 @@ Represents a single field in an EAS schema.
 
 ### Type Aliases
 
+#### AbiSource
+
+Configuration for ABI sources with priority system.
+
+```typescript
+type AbiSource =
+  | { type: "hardcoded" }
+  | { type: "custom"; easAbi: Abi; schemaRegistryAbi: Abi }
+  | { type: "predeployed"; abiNames?: string[] };
+```
 #### ClientOptions
 
 > **ClientOptions** = `z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>
@@ -157,13 +370,66 @@ Extends the base Viem client options with EAS-specific requirements.
 
 #### EAS\_FIELD\_TYPES
 
+Supported field types for EAS schema fields. Maps to the Solidity types that can be used in EAS schemas.
 > `const` **EAS\_FIELD\_TYPES**: `object`
 
 Defined in: [sdk/eas/src/types.ts:5](https://github.com/settlemint/sdk/blob/v2.3.8/sdk/eas/src/types.ts#L5)
 
 Supported field types for EAS schema fields.
 Maps to the Solidity types that can be used in EAS schemas.
 
+```typescript
+interface SchemaRequest {
+  fields?: SchemaField[];     // Alternative to schema string
+  schema?: string;           // Alternative to fields
+  resolver: Address;         // Use ZERO_ADDRESS for no resolver
+  revocable: boolean;        // Whether attestations can be revoked
+}
+
+async registerSchema(
+  request: SchemaRequest,
+  fromAddress: Address,
+  gasLimit?: string
+): Promise<TransactionResult>
+```
+
+### Attestation Creation
+
+```typescript
+import { EASErrorCode, EASPortalError } from "@settlemint/sdk-eas";
+
+try {
+  await client.getAttestation("invalid-uid");
+} catch (error) {
+  if (error instanceof EASPortalError) {
+    switch (error.code) {
+      case EASErrorCode.ATTESTATION_NOT_FOUND:
+        console.log("Attestation not found");
+        break;
+      case EASErrorCode.TRANSACTION_FAILED:
+        console.log("Transaction failed");
+        break;
+      case EASErrorCode.SCHEMA_NOT_FOUND:
+        console.log("Schema not found");
+        break;
+      // ... other error codes
+    }
+  }
+}
+```
+
+### Available Error Codes
+
+- `INVALID_SCHEMA` - Schema validation failed
+- `SCHEMA_NOT_FOUND` - Schema not found
+- `ATTESTATION_NOT_FOUND` - Attestation not found
+- `UNAUTHORIZED` - Unauthorized access
+- `TRANSACTION_FAILED` - Transaction execution failed
+- `INVALID_SIGNATURE` - Invalid signature
+- `EXPIRED_ATTESTATION` - Attestation has expired
+- `NON_REVOCABLE` - Attestation cannot be revoked
+- `ALREADY_REVOKED` - Attestation already revoked
+- `PORTAL_ERROR` - Portal-specific error
 ##### Type declaration
 
 | Name | Type | Default value | Defined in |