@settlemint/sdk-eas 2.3.0 → 2.3.1

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 +17 -17
  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.0/sdk/eas/src/eas.ts#L36)
56
+ Defined in: [sdk/eas/src/eas.ts:36](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/eas.ts#L36)
57
57
 
58
58
  Creates an EAS client for interacting with the Ethereum Attestation Service.
59
59
 
@@ -71,8 +71,8 @@ An object containing the EAS client instance
71
71
 
72
72
  | Name | Type | Defined in |
73
73
  | ------ | ------ | ------ |
74
- | `getSchema()` | (`uid`) => `Promise`\<`string`\> | [sdk/eas/src/eas.ts:96](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/eas.ts#L96) |
75
- | `registerSchema()` | (`options`) => `Promise`\<`string`\> | [sdk/eas/src/eas.ts:95](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/eas.ts#L95) |
74
+ | `getSchema()` | (`uid`) => `Promise`\<`string`\> | [sdk/eas/src/eas.ts:96](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/eas.ts#L96) |
75
+ | `registerSchema()` | (`options`) => `Promise`\<`string`\> | [sdk/eas/src/eas.ts:95](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/eas.ts#L95) |
76
76
 
77
77
  ##### Throws
78
78
 
@@ -97,7 +97,7 @@ const client = createEASClient({
97
97
 
98
98
  #### RegisterSchemaOptions
99
99
 
100
- Defined in: [sdk/eas/src/types.ts:39](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L39)
100
+ Defined in: [sdk/eas/src/types.ts:39](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L39)
101
101
 
102
102
  Options for registering a new schema in the EAS Schema Registry.
103
103
 
@@ -105,7 +105,7 @@ Options for registering a new schema in the EAS Schema Registry.
105
105
 
106
106
  #### SchemaField
107
107
 
108
- Defined in: [sdk/eas/src/types.ts:26](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L26)
108
+ Defined in: [sdk/eas/src/types.ts:26](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L26)
109
109
 
110
110
  Represents a single field in an EAS schema.
111
111
 
@@ -115,7 +115,7 @@ Represents a single field in an EAS schema.
115
115
 
116
116
  > **ClientOptions** = `z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\> & `Pick`\<`ViemClientOptions`, `"accessToken"` \| `"chainId"` \| `"chainName"` \| `"rpcUrl"`\>
117
117
 
118
- Defined in: [sdk/eas/src/client-options.schema.ts:32](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/client-options.schema.ts#L32)
118
+ Defined in: [sdk/eas/src/client-options.schema.ts:32](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/client-options.schema.ts#L32)
119
119
 
120
120
  Configuration options for creating an EAS client.
121
121
  Combines EAS-specific options with base Viem client options.
@@ -126,7 +126,7 @@ Combines EAS-specific options with base Viem client options.
126
126
 
127
127
  > `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodString`; `attestationAddress`: `ZodEffects`\<`ZodString`, `` `0x${string}` ``, `string`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `rpcUrl`: `ZodString`; `schemaRegistryAddress`: `ZodEffects`\<`ZodString`, `` `0x${string}` ``, `string`\>; \}, `"strip"`, `ZodTypeAny`, \{ `accessToken`: `string`; `attestationAddress`: `` `0x${string}` ``; `chainId`: `string`; `chainName`: `string`; `rpcUrl`: `string`; `schemaRegistryAddress`: `` `0x${string}` ``; \}, \{ `accessToken`: `string`; `attestationAddress`: `string`; `chainId`: `string`; `chainName`: `string`; `rpcUrl`: `string`; `schemaRegistryAddress`: `string`; \}\>
128
128
 
129
- Defined in: [sdk/eas/src/client-options.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/client-options.schema.ts#L10)
129
+ Defined in: [sdk/eas/src/client-options.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/client-options.schema.ts#L10)
130
130
 
131
131
  Schema for validating EAS client configuration options.
132
132
  Extends the base Viem client options with EAS-specific requirements.
@@ -137,7 +137,7 @@ Extends the base Viem client options with EAS-specific requirements.
137
137
 
138
138
  > `const` **EAS\_FIELD\_TYPES**: `object`
139
139
 
140
- Defined in: [sdk/eas/src/types.ts:5](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L5)
140
+ Defined in: [sdk/eas/src/types.ts:5](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L5)
141
141
 
142
142
  Supported field types for EAS schema fields.
143
143
  Maps to the Solidity types that can be used in EAS schemas.
@@ -146,15 +146,15 @@ Maps to the Solidity types that can be used in EAS schemas.
146
146
 
147
147
  | Name | Type | Default value | Defined in |
148
148
  | ------ | ------ | ------ | ------ |
149
- | <a id="address"></a> `address` | `"address"` | `"address"` | [sdk/eas/src/types.ts:7](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L7) |
150
- | <a id="bool"></a> `bool` | `"bool"` | `"bool"` | [sdk/eas/src/types.ts:8](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L8) |
151
- | <a id="bytes"></a> `bytes` | `"bytes"` | `"bytes"` | [sdk/eas/src/types.ts:9](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L9) |
152
- | <a id="bytes32"></a> `bytes32` | `"bytes32"` | `"bytes32"` | [sdk/eas/src/types.ts:10](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L10) |
153
- | <a id="int256"></a> `int256` | `"int256"` | `"int256"` | [sdk/eas/src/types.ts:12](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L12) |
154
- | <a id="int8"></a> `int8` | `"int8"` | `"int8"` | [sdk/eas/src/types.ts:14](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L14) |
155
- | <a id="string"></a> `string` | `"string"` | `"string"` | [sdk/eas/src/types.ts:6](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L6) |
156
- | <a id="uint256"></a> `uint256` | `"uint256"` | `"uint256"` | [sdk/eas/src/types.ts:11](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L11) |
157
- | <a id="uint8"></a> `uint8` | `"uint8"` | `"uint8"` | [sdk/eas/src/types.ts:13](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/eas/src/types.ts#L13) |
149
+ | <a id="address"></a> `address` | `"address"` | `"address"` | [sdk/eas/src/types.ts:7](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L7) |
150
+ | <a id="bool"></a> `bool` | `"bool"` | `"bool"` | [sdk/eas/src/types.ts:8](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L8) |
151
+ | <a id="bytes"></a> `bytes` | `"bytes"` | `"bytes"` | [sdk/eas/src/types.ts:9](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L9) |
152
+ | <a id="bytes32"></a> `bytes32` | `"bytes32"` | `"bytes32"` | [sdk/eas/src/types.ts:10](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L10) |
153
+ | <a id="int256"></a> `int256` | `"int256"` | `"int256"` | [sdk/eas/src/types.ts:12](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L12) |
154
+ | <a id="int8"></a> `int8` | `"int8"` | `"int8"` | [sdk/eas/src/types.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L14) |
155
+ | <a id="string"></a> `string` | `"string"` | `"string"` | [sdk/eas/src/types.ts:6](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L6) |
156
+ | <a id="uint256"></a> `uint256` | `"uint256"` | `"uint256"` | [sdk/eas/src/types.ts:11](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L11) |
157
+ | <a id="uint8"></a> `uint8` | `"uint8"` | `"uint8"` | [sdk/eas/src/types.ts:13](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/eas/src/types.ts#L13) |
158
158
 
159
159
  ## Contributing
160
160
 
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.0",
4
+ "version": "2.3.1",
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.0",
56
- "@settlemint/sdk-viem": "2.3.0",
55
+ "@settlemint/sdk-utils": "2.3.1",
56
+ "@settlemint/sdk-viem": "2.3.1",
57
57
  "ethers": "^6",
58
58
  "viem": "^2"
59
59
  },