@settlemint/sdk-eas 2.4.0-pr74203735 → 2.4.0-pr7cd97e38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -74,7 +74,7 @@ The SettleMint EAS SDK provides a lightweight wrapper for the Ethereum Attestati
74
74
 
75
75
  import type { Address, Hex } from "viem";
76
76
  import { decodeAbiParameters, encodeAbiParameters, parseAbiParameters } from "viem";
77
- import { createEASClient, ZERO_ADDRESS, ZERO_BYTES32 } from "../eas.ts"; // Replace this path with "@settlemint/sdk-eas";
77
+ import { ZERO_ADDRESS, ZERO_BYTES32, createEASClient } from "../eas.ts"; // Replace this path with "@settlemint/sdk-eas";
78
78
 
79
79
  const CONFIG = {
80
80
  instance: process.env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT,
@@ -123,7 +123,7 @@ async function runEASWorkflow() {
123
123
  console.log("🚀 Simple EAS SDK Workflow");
124
124
  console.log("===========================\n");
125
125
 
126
- let _deployedAddresses: { easAddress: Address; schemaRegistryAddress: Address };
126
+ let deployedAddresses: { easAddress: Address; schemaRegistryAddress: Address };
127
127
 
128
128
  // Step 1: Initialize EAS Client
129
129
  console.log("📋 Step 1: Initialize EAS Client");
@@ -145,7 +145,7 @@ async function runEASWorkflow() {
145
145
  console.log(` EAS: ${deployment.easAddress}`);
146
146
  console.log(` Schema Registry: ${deployment.schemaRegistryAddress}\n`);
147
147
 
148
- _deployedAddresses = {
148
+ deployedAddresses = {
149
149
  easAddress: deployment.easAddress,
150
150
  schemaRegistryAddress: deployment.schemaRegistryAddress,
151
151
  };
@@ -670,7 +670,7 @@ TODO: Implement using The Graph subgraph for EAS data queries
670
670
 
671
671
  ###### getAttestations()
672
672
 
673
- > **getAttestations**(`_options?`): `Promise`\<[`AttestationInfo`](#attestationinfo)[]\>
673
+ > **getAttestations**(`options?`): `Promise`\<[`AttestationInfo`](#attestationinfo)[]\>
674
674
 
675
675
  Defined in: [sdk/eas/src/eas.ts:539](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/eas/src/eas.ts#L539)
676
676
 
@@ -682,7 +682,7 @@ TODO: Implement using The Graph subgraph for EAS data queries
682
682
 
683
683
  | Parameter | Type |
684
684
  | ------ | ------ |
685
- | `_options?` | [`GetAttestationsOptions`](#getattestationsoptions) |
685
+ | `options?` | [`GetAttestationsOptions`](#getattestationsoptions) |
686
686
 
687
687
  ###### Returns
688
688
 
@@ -757,7 +757,7 @@ TODO: Implement using The Graph subgraph for EAS data queries
757
757
 
758
758
  ###### getSchemas()
759
759
 
760
- > **getSchemas**(`_options?`): `Promise`\<[`SchemaData`](#schemadata)[]\>
760
+ > **getSchemas**(`options?`): `Promise`\<[`SchemaData`](#schemadata)[]\>
761
761
 
762
762
  Defined in: [sdk/eas/src/eas.ts:519](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/eas/src/eas.ts#L519)
763
763
 
@@ -769,7 +769,7 @@ TODO: Implement using The Graph subgraph for EAS data queries
769
769
 
770
770
  | Parameter | Type |
771
771
  | ------ | ------ |
772
- | `_options?` | [`GetSchemasOptions`](#getschemasoptions) |
772
+ | `options?` | [`GetSchemasOptions`](#getschemasoptions) |
773
773
 
774
774
  ###### Returns
775
775
 
@@ -791,7 +791,7 @@ TODO: Fix Portal GraphQL query parameter encoding or use The Graph subgraph
791
791
 
792
792
  ###### isValidAttestation()
793
793
 
794
- > **isValidAttestation**(`_uid`): `Promise`\<`boolean`\>
794
+ > **isValidAttestation**(`uid`): `Promise`\<`boolean`\>
795
795
 
796
796
  Defined in: [sdk/eas/src/eas.ts:548](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/eas/src/eas.ts#L548)
797
797
 
@@ -803,7 +803,7 @@ TODO: Implement using The Graph subgraph for EAS data queries
803
803
 
804
804
  | Parameter | Type |
805
805
  | ------ | ------ |
806
- | `_uid` | `` `0x${string}` `` |
806
+ | `uid` | `` `0x${string}` `` |
807
807
 
808
808
  ###### Returns
809
809
 
@@ -1136,22 +1136,12 @@ Transaction result
1136
1136
 
1137
1137
  #### EASClientOptions
1138
1138
 
1139
- > **EASClientOptions** = `object`
1139
+ > **EASClientOptions** = `z.infer`\<*typeof* [`EASClientOptionsSchema`](#easclientoptionsschema)\>
1140
1140
 
1141
1141
  Defined in: [sdk/eas/src/schema.ts:44](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/eas/src/schema.ts#L44)
1142
1142
 
1143
1143
  Configuration options for the EAS client
1144
1144
 
1145
- ##### Type declaration
1146
-
1147
- | Name | Type | Default value | Description | Defined in |
1148
- | ------ | ------ | ------ | ------ | ------ |
1149
- | <a id="accesstoken"></a> `accessToken?` | `string` | - | The application access token | [sdk/eas/src/utils/validation.ts:21](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/eas/src/utils/validation.ts#L21) |
1150
- | <a id="debug"></a> `debug?` | `boolean` | - | Whether to enable debug mode | [sdk/eas/src/utils/validation.ts:33](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/eas/src/utils/validation.ts#L33) |
1151
- | <a id="eascontractaddress"></a> `easContractAddress?` | `` `0x${string}` `` | - | The EAS contract address | [sdk/eas/src/utils/validation.ts:25](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/eas/src/utils/validation.ts#L25) |
1152
- | <a id="instance"></a> `instance` | `string` | `UrlSchema` | The EAS instance URL | [sdk/eas/src/utils/validation.ts:17](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/eas/src/utils/validation.ts#L17) |
1153
- | <a id="schemaregistrycontractaddress"></a> `schemaRegistryContractAddress?` | `` `0x${string}` `` | - | The schema registry contract address | [sdk/eas/src/utils/validation.ts:29](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/eas/src/utils/validation.ts#L29) |
1154
-
1155
1145
  ### Variables
1156
1146
 
1157
1147
  #### EAS\_FIELD\_TYPES
@@ -1181,7 +1171,7 @@ Maps to the Solidity types that can be used in EAS schemas.
1181
1171
 
1182
1172
  #### EASClientOptionsSchema
1183
1173
 
1184
- > `const` **EASClientOptionsSchema**: `ZodObject`\<[`EASClientOptions`](#easclientoptions)\>
1174
+ > `const` **EASClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `debug`: `ZodOptional`\<`ZodBoolean`\>; `easContractAddress`: `ZodOptional`\<`ZodCustom`\<`` `0x${string}` ``, `` `0x${string}` ``\>\>; `instance`: `ZodString`; `schemaRegistryContractAddress`: `ZodOptional`\<`ZodCustom`\<`` `0x${string}` ``, `` `0x${string}` ``\>\>; \}, `$strip`\>
1185
1175
 
1186
1176
  Defined in: [sdk/eas/src/utils/validation.ts:13](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/eas/src/utils/validation.ts#L13)
1187
1177
 
@@ -4310,7 +4310,7 @@ declare class EASClient {
4310
4310
  *
4311
4311
  * TODO: Implement using The Graph subgraph for EAS data queries
4312
4312
  */
4313
- getSchemas(_options?: GetSchemasOptions): Promise<SchemaData[]>;
4313
+ getSchemas(options?: GetSchemasOptions): Promise<SchemaData[]>;
4314
4314
  /**
4315
4315
  * Get an attestation by UID
4316
4316
  *
@@ -4322,13 +4322,13 @@ declare class EASClient {
4322
4322
  *
4323
4323
  * TODO: Implement using The Graph subgraph for EAS data queries
4324
4324
  */
4325
- getAttestations(_options?: GetAttestationsOptions): Promise<AttestationInfo[]>;
4325
+ getAttestations(options?: GetAttestationsOptions): Promise<AttestationInfo[]>;
4326
4326
  /**
4327
4327
  * Check if an attestation is valid
4328
4328
  *
4329
4329
  * TODO: Implement using The Graph subgraph for EAS data queries
4330
4330
  */
4331
- isValidAttestation(_uid: Hex): Promise<boolean>;
4331
+ isValidAttestation(uid: Hex): Promise<boolean>;
4332
4332
  /**
4333
4333
  * Get the current timestamp from the contract
4334
4334
  *
@@ -11266,7 +11266,7 @@ var EASClient = class {
11266
11266
  *
11267
11267
  * TODO: Implement using The Graph subgraph for EAS data queries
11268
11268
  */
11269
- async getSchemas(_options) {
11269
+ async getSchemas(options) {
11270
11270
  throw new Error("Schema listing not implemented yet. Use The Graph subgraph for reading schema data.");
11271
11271
  }
11272
11272
  /**
@@ -11282,7 +11282,7 @@ var EASClient = class {
11282
11282
  *
11283
11283
  * TODO: Implement using The Graph subgraph for EAS data queries
11284
11284
  */
11285
- async getAttestations(_options) {
11285
+ async getAttestations(options) {
11286
11286
  throw new Error("Attestation listing not implemented yet. Use The Graph subgraph for reading attestation data.");
11287
11287
  }
11288
11288
  /**
@@ -11290,7 +11290,7 @@ var EASClient = class {
11290
11290
  *
11291
11291
  * TODO: Implement using The Graph subgraph for EAS data queries
11292
11292
  */
11293
- async isValidAttestation(_uid) {
11293
+ async isValidAttestation(uid) {
11294
11294
  return false;
11295
11295
  }
11296
11296
  /**