@settlemint/sdk-eas 2.3.13 → 2.3.14

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.
Files changed (2) hide show
  1. package/README.md +23 -23
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -53,7 +53,7 @@ The SettleMint EAS SDK provides a lightweight wrapper for the Ethereum Attestati
53
53
 
54
54
  > **createEASClient**(`options`): `object`
55
55
 
56
- Defined in: [sdk/eas/src/eas.ts:36](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/eas.ts#L36)
56
+ Defined in: [sdk/eas/src/eas.ts:36](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/eas.ts#L36)
57
57
 
58
58
  Creates an EAS client for interacting with the Ethereum Attestation Service.
59
59
 
@@ -77,8 +77,8 @@ An object containing the EAS client instance
77
77
 
78
78
  | Name | Type | Defined in |
79
79
  | ------ | ------ | ------ |
80
- | `getSchema()` | (`uid`) => `Promise`\<`string`\> | [sdk/eas/src/eas.ts:96](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/eas.ts#L96) |
81
- | `registerSchema()` | (`options`) => `Promise`\<`string`\> | [sdk/eas/src/eas.ts:95](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/eas.ts#L95) |
80
+ | `getSchema()` | (`uid`) => `Promise`\<`string`\> | [sdk/eas/src/eas.ts:96](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/eas.ts#L96) |
81
+ | `registerSchema()` | (`options`) => `Promise`\<`string`\> | [sdk/eas/src/eas.ts:95](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/eas.ts#L95) |
82
82
 
83
83
  ##### Throws
84
84
 
@@ -103,7 +103,7 @@ const client = createEASClient({
103
103
 
104
104
  #### RegisterSchemaOptions
105
105
 
106
- Defined in: [sdk/eas/src/types.ts:34](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L34)
106
+ Defined in: [sdk/eas/src/types.ts:34](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L34)
107
107
 
108
108
  Options for registering a new schema in the EAS Schema Registry.
109
109
 
@@ -111,15 +111,15 @@ Options for registering a new schema in the EAS Schema Registry.
111
111
 
112
112
  | Property | Type | Description | Defined in |
113
113
  | ------ | ------ | ------ | ------ |
114
- | <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.13/sdk/eas/src/types.ts#L36) |
115
- | <a id="resolveraddress"></a> `resolverAddress` | `string` | Address of the resolver contract that will handle attestations | [sdk/eas/src/types.ts:38](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L38) |
116
- | <a id="revocable"></a> `revocable` | `boolean` | Whether attestations using this schema can be revoked | [sdk/eas/src/types.ts:40](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L40) |
114
+ | <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.14/sdk/eas/src/types.ts#L36) |
115
+ | <a id="resolveraddress"></a> `resolverAddress` | `string` | Address of the resolver contract that will handle attestations | [sdk/eas/src/types.ts:38](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L38) |
116
+ | <a id="revocable"></a> `revocable` | `boolean` | Whether attestations using this schema can be revoked | [sdk/eas/src/types.ts:40](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L40) |
117
117
 
118
118
  ***
119
119
 
120
120
  #### SchemaField
121
121
 
122
- Defined in: [sdk/eas/src/types.ts:22](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L22)
122
+ Defined in: [sdk/eas/src/types.ts:22](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L22)
123
123
 
124
124
  Represents a single field in an EAS schema.
125
125
 
@@ -127,9 +127,9 @@ Represents a single field in an EAS schema.
127
127
 
128
128
  | Property | Type | Description | Defined in |
129
129
  | ------ | ------ | ------ | ------ |
130
- | <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.13/sdk/eas/src/types.ts#L28) |
131
- | <a id="name"></a> `name` | `string` | The name of the field | [sdk/eas/src/types.ts:24](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L24) |
132
- | <a id="type"></a> `type` | `"string"` \| `"address"` \| `"bool"` \| `"bytes"` \| `"bytes32"` \| `"int8"` \| `"int256"` \| `"uint8"` \| `"uint256"` | The Solidity type of the field | [sdk/eas/src/types.ts:26](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L26) |
130
+ | <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.14/sdk/eas/src/types.ts#L28) |
131
+ | <a id="name"></a> `name` | `string` | The name of the field | [sdk/eas/src/types.ts:24](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L24) |
132
+ | <a id="type"></a> `type` | `"string"` \| `"address"` \| `"bool"` \| `"bytes"` \| `"bytes32"` \| `"int8"` \| `"int256"` \| `"uint8"` \| `"uint256"` | The Solidity type of the field | [sdk/eas/src/types.ts:26](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L26) |
133
133
 
134
134
  ### Type Aliases
135
135
 
@@ -137,7 +137,7 @@ Represents a single field in an EAS schema.
137
137
 
138
138
  > **ClientOptions** = `z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>
139
139
 
140
- Defined in: [sdk/eas/src/client-options.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/client-options.schema.ts#L28)
140
+ Defined in: [sdk/eas/src/client-options.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/client-options.schema.ts#L28)
141
141
 
142
142
  Configuration options for creating an EAS client.
143
143
  Combines EAS-specific options with base Viem client options.
@@ -148,7 +148,7 @@ Combines EAS-specific options with base Viem client options.
148
148
 
149
149
  > `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodString`; `attestationAddress`: `ZodString`; `chainId`: `ZodString`; `chainName`: `ZodString`; `rpcUrl`: `ZodString`; `schemaRegistryAddress`: `ZodString`; \}, `$strip`\>
150
150
 
151
- Defined in: [sdk/eas/src/client-options.schema.ts:9](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/client-options.schema.ts#L9)
151
+ Defined in: [sdk/eas/src/client-options.schema.ts:9](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/client-options.schema.ts#L9)
152
152
 
153
153
  Schema for validating EAS client configuration options.
154
154
  Extends the base Viem client options with EAS-specific requirements.
@@ -159,7 +159,7 @@ Extends the base Viem client options with EAS-specific requirements.
159
159
 
160
160
  > `const` **EAS\_FIELD\_TYPES**: `object`
161
161
 
162
- Defined in: [sdk/eas/src/types.ts:5](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L5)
162
+ Defined in: [sdk/eas/src/types.ts:5](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L5)
163
163
 
164
164
  Supported field types for EAS schema fields.
165
165
  Maps to the Solidity types that can be used in EAS schemas.
@@ -168,15 +168,15 @@ Maps to the Solidity types that can be used in EAS schemas.
168
168
 
169
169
  | Name | Type | Default value | Defined in |
170
170
  | ------ | ------ | ------ | ------ |
171
- | <a id="address"></a> `address` | `"address"` | `"address"` | [sdk/eas/src/types.ts:7](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L7) |
172
- | <a id="bool"></a> `bool` | `"bool"` | `"bool"` | [sdk/eas/src/types.ts:8](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L8) |
173
- | <a id="bytes"></a> `bytes` | `"bytes"` | `"bytes"` | [sdk/eas/src/types.ts:9](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L9) |
174
- | <a id="bytes32"></a> `bytes32` | `"bytes32"` | `"bytes32"` | [sdk/eas/src/types.ts:10](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L10) |
175
- | <a id="int256"></a> `int256` | `"int256"` | `"int256"` | [sdk/eas/src/types.ts:12](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L12) |
176
- | <a id="int8"></a> `int8` | `"int8"` | `"int8"` | [sdk/eas/src/types.ts:14](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L14) |
177
- | <a id="string"></a> `string` | `"string"` | `"string"` | [sdk/eas/src/types.ts:6](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L6) |
178
- | <a id="uint256"></a> `uint256` | `"uint256"` | `"uint256"` | [sdk/eas/src/types.ts:11](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L11) |
179
- | <a id="uint8"></a> `uint8` | `"uint8"` | `"uint8"` | [sdk/eas/src/types.ts:13](https://github.com/settlemint/sdk/blob/v2.3.13/sdk/eas/src/types.ts#L13) |
171
+ | <a id="address"></a> `address` | `"address"` | `"address"` | [sdk/eas/src/types.ts:7](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L7) |
172
+ | <a id="bool"></a> `bool` | `"bool"` | `"bool"` | [sdk/eas/src/types.ts:8](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L8) |
173
+ | <a id="bytes"></a> `bytes` | `"bytes"` | `"bytes"` | [sdk/eas/src/types.ts:9](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L9) |
174
+ | <a id="bytes32"></a> `bytes32` | `"bytes32"` | `"bytes32"` | [sdk/eas/src/types.ts:10](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L10) |
175
+ | <a id="int256"></a> `int256` | `"int256"` | `"int256"` | [sdk/eas/src/types.ts:12](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L12) |
176
+ | <a id="int8"></a> `int8` | `"int8"` | `"int8"` | [sdk/eas/src/types.ts:14](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L14) |
177
+ | <a id="string"></a> `string` | `"string"` | `"string"` | [sdk/eas/src/types.ts:6](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L6) |
178
+ | <a id="uint256"></a> `uint256` | `"uint256"` | `"uint256"` | [sdk/eas/src/types.ts:11](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L11) |
179
+ | <a id="uint8"></a> `uint8` | `"uint8"` | `"uint8"` | [sdk/eas/src/types.ts:13](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/eas/src/types.ts#L13) |
180
180
 
181
181
  ## Contributing
182
182
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@settlemint/sdk-eas",
3
3
  "description": "Ethereum Attestation Service (EAS) integration for SettleMint SDK",
4
- "version": "2.3.13",
4
+ "version": "2.3.14",
5
5
  "type": "module",
6
6
  "private": false,
7
7
  "license": "FSL-1.1-MIT",
@@ -52,8 +52,8 @@
52
52
  "devDependencies": {},
53
53
  "dependencies": {
54
54
  "@ethereum-attestation-service/eas-sdk": "^2",
55
- "@settlemint/sdk-utils": "2.3.13",
56
- "@settlemint/sdk-viem": "2.3.13",
55
+ "@settlemint/sdk-utils": "2.3.14",
56
+ "@settlemint/sdk-viem": "2.3.14",
57
57
  "ethers": "^6",
58
58
  "viem": "^2"
59
59
  },