@settlemint/sdk-viem 2.5.6 → 2.5.7-main3cd08190

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 (11) hide show
  1. package/README.md +157 -105
  2. package/dist/browser/viem.d.ts +546 -472
  3. package/dist/browser/viem.js +260 -33
  4. package/dist/browser/viem.js.map +1 -1
  5. package/dist/viem.cjs +260 -33
  6. package/dist/viem.cjs.map +1 -1
  7. package/dist/viem.d.cts +546 -472
  8. package/dist/viem.d.ts +546 -472
  9. package/dist/viem.js +260 -33
  10. package/dist/viem.js.map +1 -1
  11. package/package.json +2 -2
package/README.md CHANGED
@@ -79,21 +79,40 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
79
79
 
80
80
  > **getChainId**(`options`): `Promise`\<`number`\>
81
81
 
82
- Defined in: [sdk/viem/src/viem.ts:217](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L217)
82
+ Defined in: [sdk/viem/src/viem.ts:485](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L485)
83
83
 
84
- Get the chain id of a blockchain network.
84
+ Discovers the chain ID from an RPC endpoint without requiring prior knowledge.
85
85
 
86
86
  ##### Parameters
87
87
 
88
88
  | Parameter | Type | Description |
89
89
  | ------ | ------ | ------ |
90
- | `options` | [`GetChainIdOptions`](#getchainidoptions) | The options for the public client. |
90
+ | `options` | [`GetChainIdOptions`](#getchainidoptions) | Minimal options with RPC URL and optional authentication |
91
91
 
92
92
  ##### Returns
93
93
 
94
94
  `Promise`\<`number`\>
95
95
 
96
- The chain id.
96
+ Promise resolving to the network's chain ID as a number
97
+
98
+ ##### Remarks
99
+
100
+ UTILITY: Enables chain discovery for dynamic network configuration scenarios.
101
+ Unlike other client functions, this creates a minimal, non-cached client for one-time queries.
102
+
103
+ USE CASE: Chain ID discovery during initial network setup or validation.
104
+ Alternative to requiring users to know chain IDs in advance.
105
+
106
+ PERFORMANCE: No caching because chain IDs are typically discovered once
107
+ during setup rather than repeatedly during runtime operations.
108
+
109
+ ##### Throws
110
+
111
+ NetworkError when RPC endpoint is unreachable
112
+
113
+ ##### Throws
114
+
115
+ AuthenticationError when access token is invalid
97
116
 
98
117
  ##### Example
99
118
 
@@ -111,23 +130,42 @@ console.log(chainId);
111
130
 
112
131
  #### getPublicClient()
113
132
 
114
- > **getPublicClient**(`options`): `object`
133
+ > **getPublicClient**(`options`): \{ \} \| \{ \}
115
134
 
116
- Defined in: [sdk/viem/src/viem.ts:75](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L75)
135
+ Defined in: [sdk/viem/src/viem.ts:246](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L246)
117
136
 
118
- Get a public client. Use this if you need to read from the blockchain.
137
+ Creates an optimized public client for blockchain read operations.
119
138
 
120
139
  ##### Parameters
121
140
 
122
141
  | Parameter | Type | Description |
123
142
  | ------ | ------ | ------ |
124
- | `options` | [`ClientOptions`](#clientoptions) | The options for the public client. |
143
+ | `options` | [`ClientOptions`](#clientoptions) | Client configuration including chain details and authentication |
125
144
 
126
145
  ##### Returns
127
146
 
128
- `object`
147
+ \{ \} \| \{ \}
148
+
149
+ Cached or newly created public client with read-only blockchain access
150
+
151
+ ##### Remarks
129
152
 
130
- The public client. see [https://viem.sh/docs/clients/public](https://viem.sh/docs/clients/public)
153
+ PERFORMANCE: Implements intelligent caching to minimize client creation overhead.
154
+ Cache hit rates of 80%+ typical in production workloads with repeated chain access.
155
+
156
+ SECURITY: Each access token gets isolated cache entries to prevent cross-tenant data exposure.
157
+ Client instances are immutable once cached to prevent credential pollution.
158
+
159
+ RESOURCE MANAGEMENT: 500ms polling interval balances responsiveness with server load.
160
+ 60-second timeout prevents hanging connections in unstable network conditions.
161
+
162
+ ##### Throws
163
+
164
+ ValidationError when options don't match required schema
165
+
166
+ ##### Throws
167
+
168
+ NetworkError when RPC endpoint is unreachable during client creation
131
169
 
132
170
  ##### Example
133
171
 
@@ -150,33 +188,46 @@ console.log(block);
150
188
 
151
189
  #### getWalletClient()
152
190
 
153
- > **getWalletClient**(`options`): (`verificationOptions?`) => `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
191
+ > **getWalletClient**(`options`): `any`
154
192
 
155
- Defined in: [sdk/viem/src/viem.ts:143](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L143)
193
+ Defined in: [sdk/viem/src/viem.ts:361](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L361)
156
194
 
157
- Get a wallet client. Use this if you need to write to the blockchain.
195
+ Creates a factory function for wallet clients with runtime verification support.
158
196
 
159
197
  ##### Parameters
160
198
 
161
199
  | Parameter | Type | Description |
162
200
  | ------ | ------ | ------ |
163
- | `options` | [`ClientOptions`](#clientoptions) | The options for the wallet client. |
201
+ | `options` | [`ClientOptions`](#clientoptions) | Base client configuration (chain, RPC, auth) |
164
202
 
165
203
  ##### Returns
166
204
 
167
- A function that returns a wallet client. The function can be called with verification options for HD wallets. see [https://viem.sh/docs/clients/wallet](https://viem.sh/docs/clients/wallet)
205
+ `any`
206
+
207
+ Factory function that accepts runtime verification options
208
+
209
+ ##### Remarks
210
+
211
+ DESIGN PATTERN: Returns a factory function rather than a client instance because
212
+ wallet operations require runtime verification parameters (challenge responses, etc.)
213
+ that cannot be known at factory creation time.
168
214
 
169
- > (`verificationOptions?`): `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
215
+ SECURITY: Verification headers are injected per-operation to support:
216
+ - HD wallet challenge/response flows
217
+ - Multi-signature verification workflows
218
+ - Time-sensitive authentication tokens
170
219
 
171
- ###### Parameters
220
+ PERFORMANCE: Factory caching amortizes expensive setup (chain resolution, transport config)
221
+ while allowing runtime parameter injection for each wallet operation.
172
222
 
173
- | Parameter | Type |
174
- | ------ | ------ |
175
- | `verificationOptions?` | [`WalletVerificationOptions`](#walletverificationoptions) |
223
+ FEATURE EXTENSIONS: Automatically extends client with SettleMint-specific wallet actions:
224
+ - Wallet creation and management
225
+ - Verification challenge handling
226
+ - Multi-factor authentication flows
176
227
 
177
- ###### Returns
228
+ ##### Throws
178
229
 
179
- `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
230
+ ValidationError when options don't match required schema
180
231
 
181
232
  ##### Example
182
233
 
@@ -210,7 +261,7 @@ console.log(transactionHash);
210
261
 
211
262
  #### OTPAlgorithm
212
263
 
213
- Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
264
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
214
265
 
215
266
  Supported hash algorithms for One-Time Password (OTP) verification.
216
267
  These algorithms determine the cryptographic function used to generate OTP codes.
@@ -219,21 +270,21 @@ These algorithms determine the cryptographic function used to generate OTP codes
219
270
 
220
271
  | Enumeration Member | Value | Description | Defined in |
221
272
  | ------ | ------ | ------ | ------ |
222
- | <a id="sha1"></a> `SHA1` | `"SHA1"` | SHA-1 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:20](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L20) |
223
- | <a id="sha224"></a> `SHA224` | `"SHA224"` | SHA-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:22](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L22) |
224
- | <a id="sha256"></a> `SHA256` | `"SHA256"` | SHA-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:24](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L24) |
225
- | <a id="sha3_224"></a> `SHA3_224` | `"SHA3-224"` | SHA3-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:30](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L30) |
226
- | <a id="sha3_256"></a> `SHA3_256` | `"SHA3-256"` | SHA3-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:32](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L32) |
227
- | <a id="sha3_384"></a> `SHA3_384` | `"SHA3-384"` | SHA3-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:34](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L34) |
228
- | <a id="sha3_512"></a> `SHA3_512` | `"SHA3-512"` | SHA3-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:36](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L36) |
229
- | <a id="sha384"></a> `SHA384` | `"SHA384"` | SHA-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:26](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L26) |
230
- | <a id="sha512"></a> `SHA512` | `"SHA512"` | SHA-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:28](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
273
+ | <a id="sha1"></a> `SHA1` | `"SHA1"` | SHA-1 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:20](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L20) |
274
+ | <a id="sha224"></a> `SHA224` | `"SHA224"` | SHA-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:22](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L22) |
275
+ | <a id="sha256"></a> `SHA256` | `"SHA256"` | SHA-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:24](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L24) |
276
+ | <a id="sha3_224"></a> `SHA3_224` | `"SHA3-224"` | SHA3-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:30](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L30) |
277
+ | <a id="sha3_256"></a> `SHA3_256` | `"SHA3-256"` | SHA3-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:32](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L32) |
278
+ | <a id="sha3_384"></a> `SHA3_384` | `"SHA3-384"` | SHA3-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:34](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L34) |
279
+ | <a id="sha3_512"></a> `SHA3_512` | `"SHA3-512"` | SHA3-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:36](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L36) |
280
+ | <a id="sha384"></a> `SHA384` | `"SHA384"` | SHA-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:26](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L26) |
281
+ | <a id="sha512"></a> `SHA512` | `"SHA512"` | SHA-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:28](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
231
282
 
232
283
  ***
233
284
 
234
285
  #### WalletVerificationType
235
286
 
236
- Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
287
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
237
288
 
238
289
  Types of wallet verification methods supported by the system.
239
290
  Used to identify different verification mechanisms when creating or managing wallet verifications.
@@ -242,15 +293,15 @@ Used to identify different verification mechanisms when creating or managing wal
242
293
 
243
294
  | Enumeration Member | Value | Description | Defined in |
244
295
  | ------ | ------ | ------ | ------ |
245
- | <a id="otp"></a> `OTP` | `"OTP"` | One-Time Password verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:9](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L9) |
246
- | <a id="pincode"></a> `PINCODE` | `"PINCODE"` | PIN code verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:7](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L7) |
247
- | <a id="secret_codes"></a> `SECRET_CODES` | `"SECRET_CODES"` | Secret recovery codes verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:11](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
296
+ | <a id="otp"></a> `OTP` | `"OTP"` | One-Time Password verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:9](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L9) |
297
+ | <a id="pincode"></a> `PINCODE` | `"PINCODE"` | PIN code verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:7](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L7) |
298
+ | <a id="secret_codes"></a> `SECRET_CODES` | `"SECRET_CODES"` | Secret recovery codes verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:11](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
248
299
 
249
300
  ### Interfaces
250
301
 
251
302
  #### CreateWalletParameters
252
303
 
253
- Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
304
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
254
305
 
255
306
  Parameters for creating a wallet.
256
307
 
@@ -258,14 +309,14 @@ Parameters for creating a wallet.
258
309
 
259
310
  | Property | Type | Description | Defined in |
260
311
  | ------ | ------ | ------ | ------ |
261
- | <a id="keyvaultid"></a> `keyVaultId` | `string` | The unique name of the key vault where the wallet will be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet.action.ts#L16) |
262
- | <a id="walletinfo"></a> `walletInfo` | [`WalletInfo`](#walletinfo-1) | Information about the wallet to be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
312
+ | <a id="keyvaultid"></a> `keyVaultId` | `string` | The unique name of the key vault where the wallet will be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L16) |
313
+ | <a id="walletinfo"></a> `walletInfo` | [`WalletInfo`](#walletinfo-1) | Information about the wallet to be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
263
314
 
264
315
  ***
265
316
 
266
317
  #### CreateWalletResponse
267
318
 
268
- Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
319
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
269
320
 
270
321
  Response from creating a wallet.
271
322
 
@@ -273,16 +324,16 @@ Response from creating a wallet.
273
324
 
274
325
  | Property | Type | Description | Defined in |
275
326
  | ------ | ------ | ------ | ------ |
276
- | <a id="address"></a> `address` | `string` | The blockchain address of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet.action.ts#L30) |
277
- | <a id="derivationpath"></a> `derivationPath` | `string` | The HD derivation path used to create the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:32](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet.action.ts#L32) |
278
- | <a id="id"></a> `id` | `string` | The unique identifier of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet.action.ts#L26) |
279
- | <a id="name"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
327
+ | <a id="address"></a> `address` | `string` | The blockchain address of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L30) |
328
+ | <a id="derivationpath"></a> `derivationPath` | `string` | The HD derivation path used to create the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:32](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L32) |
329
+ | <a id="id"></a> `id` | `string` | The unique identifier of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L26) |
330
+ | <a id="name"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
280
331
 
281
332
  ***
282
333
 
283
334
  #### CreateWalletVerificationChallengesParameters
284
335
 
285
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
336
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
286
337
 
287
338
  Parameters for creating wallet verification challenges.
288
339
 
@@ -290,13 +341,13 @@ Parameters for creating wallet verification challenges.
290
341
 
291
342
  | Property | Type | Description | Defined in |
292
343
  | ------ | ------ | ------ | ------ |
293
- | <a id="addressorobject"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:10](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
344
+ | <a id="addressorobject"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:10](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
294
345
 
295
346
  ***
296
347
 
297
348
  #### CreateWalletVerificationParameters
298
349
 
299
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
350
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
300
351
 
301
352
  Parameters for creating a wallet verification.
302
353
 
@@ -304,14 +355,14 @@ Parameters for creating a wallet verification.
304
355
 
305
356
  | Property | Type | Description | Defined in |
306
357
  | ------ | ------ | ------ | ------ |
307
- | <a id="userwalletaddress"></a> `userWalletAddress` | `string` | The wallet address for which to create the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:61](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
308
- | <a id="walletverificationinfo"></a> `walletVerificationInfo` | [`WalletVerificationInfo`](#walletverificationinfo-1) | The verification information to create. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:63](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
358
+ | <a id="userwalletaddress"></a> `userWalletAddress` | `string` | The wallet address for which to create the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:61](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
359
+ | <a id="walletverificationinfo"></a> `walletVerificationInfo` | [`WalletVerificationInfo`](#walletverificationinfo-1) | The verification information to create. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:63](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
309
360
 
310
361
  ***
311
362
 
312
363
  #### CreateWalletVerificationResponse
313
364
 
314
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
365
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
315
366
 
316
367
  Response from creating a wallet verification.
317
368
 
@@ -319,16 +370,16 @@ Response from creating a wallet verification.
319
370
 
320
371
  | Property | Type | Description | Defined in |
321
372
  | ------ | ------ | ------ | ------ |
322
- | <a id="id-1"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:71](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L71) |
323
- | <a id="name-1"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:73](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L73) |
324
- | <a id="parameters"></a> `parameters` | `Record`\<`string`, `string`\> | Additional parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:77](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L77) |
325
- | <a id="verificationtype"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:75](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
373
+ | <a id="id-1"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:71](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L71) |
374
+ | <a id="name-1"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:73](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L73) |
375
+ | <a id="parameters"></a> `parameters` | `Record`\<`string`, `string`\> | Additional parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:77](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L77) |
376
+ | <a id="verificationtype"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:75](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
326
377
 
327
378
  ***
328
379
 
329
380
  #### DeleteWalletVerificationParameters
330
381
 
331
- Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
382
+ Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
332
383
 
333
384
  Parameters for deleting a wallet verification.
334
385
 
@@ -336,14 +387,14 @@ Parameters for deleting a wallet verification.
336
387
 
337
388
  | Property | Type | Description | Defined in |
338
389
  | ------ | ------ | ------ | ------ |
339
- | <a id="userwalletaddress-1"></a> `userWalletAddress` | `string` | The wallet address for which to delete the verification. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L8) |
340
- | <a id="verificationid"></a> `verificationId` | `string` | The unique identifier of the verification to delete. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:10](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
390
+ | <a id="userwalletaddress-1"></a> `userWalletAddress` | `string` | The wallet address for which to delete the verification. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L8) |
391
+ | <a id="verificationid"></a> `verificationId` | `string` | The unique identifier of the verification to delete. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:10](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
341
392
 
342
393
  ***
343
394
 
344
395
  #### DeleteWalletVerificationResponse
345
396
 
346
- Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
397
+ Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
347
398
 
348
399
  Response from deleting a wallet verification.
349
400
 
@@ -351,13 +402,13 @@ Response from deleting a wallet verification.
351
402
 
352
403
  | Property | Type | Description | Defined in |
353
404
  | ------ | ------ | ------ | ------ |
354
- | <a id="success"></a> `success` | `boolean` | Whether the deletion was successful. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
405
+ | <a id="success"></a> `success` | `boolean` | Whether the deletion was successful. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
355
406
 
356
407
  ***
357
408
 
358
409
  #### GetWalletVerificationsParameters
359
410
 
360
- Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
411
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
361
412
 
362
413
  Parameters for getting wallet verifications.
363
414
 
@@ -365,13 +416,13 @@ Parameters for getting wallet verifications.
365
416
 
366
417
  | Property | Type | Description | Defined in |
367
418
  | ------ | ------ | ------ | ------ |
368
- | <a id="userwalletaddress-2"></a> `userWalletAddress` | `string` | The wallet address for which to fetch verifications. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
419
+ | <a id="userwalletaddress-2"></a> `userWalletAddress` | `string` | The wallet address for which to fetch verifications. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
369
420
 
370
421
  ***
371
422
 
372
423
  #### VerificationResult
373
424
 
374
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L26)
425
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L26)
375
426
 
376
427
  Result of a wallet verification challenge.
377
428
 
@@ -379,13 +430,13 @@ Result of a wallet verification challenge.
379
430
 
380
431
  | Property | Type | Description | Defined in |
381
432
  | ------ | ------ | ------ | ------ |
382
- | <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28) |
433
+ | <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28) |
383
434
 
384
435
  ***
385
436
 
386
437
  #### VerifyWalletVerificationChallengeParameters
387
438
 
388
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L16)
439
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L16)
389
440
 
390
441
  Parameters for verifying a wallet verification challenge.
391
442
 
@@ -393,14 +444,14 @@ Parameters for verifying a wallet verification challenge.
393
444
 
394
445
  | Property | Type | Description | Defined in |
395
446
  | ------ | ------ | ------ | ------ |
396
- | <a id="addressorobject-1"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L18) |
397
- | <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:20](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L20) |
447
+ | <a id="addressorobject-1"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L18) |
448
+ | <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:20](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L20) |
398
449
 
399
450
  ***
400
451
 
401
452
  #### WalletInfo
402
453
 
403
- Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
454
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
404
455
 
405
456
  Information about the wallet to be created.
406
457
 
@@ -408,13 +459,13 @@ Information about the wallet to be created.
408
459
 
409
460
  | Property | Type | Description | Defined in |
410
461
  | ------ | ------ | ------ | ------ |
411
- | <a id="name-2"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
462
+ | <a id="name-2"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
412
463
 
413
464
  ***
414
465
 
415
466
  #### WalletOTPVerificationInfo
416
467
 
417
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
468
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
418
469
 
419
470
  Information for One-Time Password (OTP) verification.
420
471
 
@@ -426,18 +477,18 @@ Information for One-Time Password (OTP) verification.
426
477
 
427
478
  | Property | Type | Description | Overrides | Inherited from | Defined in |
428
479
  | ------ | ------ | ------ | ------ | ------ | ------ |
429
- | <a id="algorithm"></a> `algorithm?` | [`OTPAlgorithm`](#otpalgorithm) | The hash algorithm to use for OTP generation. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:31](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L31) |
430
- | <a id="digits"></a> `digits?` | `number` | The number of digits in the OTP code. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:33](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L33) |
431
- | <a id="issuer"></a> `issuer?` | `string` | The issuer of the OTP. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:37](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L37) |
432
- | <a id="name-3"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
433
- | <a id="period"></a> `period?` | `number` | The time period in seconds for OTP validity. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:35](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L35) |
434
- | <a id="verificationtype-1"></a> `verificationType` | [`OTP`](#otp) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:29](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
480
+ | <a id="algorithm"></a> `algorithm?` | [`OTPAlgorithm`](#otpalgorithm) | The hash algorithm to use for OTP generation. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:31](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L31) |
481
+ | <a id="digits"></a> `digits?` | `number` | The number of digits in the OTP code. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:33](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L33) |
482
+ | <a id="issuer"></a> `issuer?` | `string` | The issuer of the OTP. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:37](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L37) |
483
+ | <a id="name-3"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
484
+ | <a id="period"></a> `period?` | `number` | The time period in seconds for OTP validity. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:35](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L35) |
485
+ | <a id="verificationtype-1"></a> `verificationType` | [`OTP`](#otp) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:29](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
435
486
 
436
487
  ***
437
488
 
438
489
  #### WalletPincodeVerificationInfo
439
490
 
440
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
491
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
441
492
 
442
493
  Information for PIN code verification.
443
494
 
@@ -449,15 +500,15 @@ Information for PIN code verification.
449
500
 
450
501
  | Property | Type | Description | Overrides | Inherited from | Defined in |
451
502
  | ------ | ------ | ------ | ------ | ------ | ------ |
452
- | <a id="name-4"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
453
- | <a id="pincode-1"></a> `pincode` | `string` | The PIN code to use for verification. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:21](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L21) |
454
- | <a id="verificationtype-2"></a> `verificationType` | [`PINCODE`](#pincode) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:19](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
503
+ | <a id="name-4"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
504
+ | <a id="pincode-1"></a> `pincode` | `string` | The PIN code to use for verification. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:21](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L21) |
505
+ | <a id="verificationtype-2"></a> `verificationType` | [`PINCODE`](#pincode) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:19](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
455
506
 
456
507
  ***
457
508
 
458
509
  #### WalletSecretCodesVerificationInfo
459
510
 
460
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
511
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
461
512
 
462
513
  Information for secret recovery codes verification.
463
514
 
@@ -469,14 +520,14 @@ Information for secret recovery codes verification.
469
520
 
470
521
  | Property | Type | Description | Overrides | Inherited from | Defined in |
471
522
  | ------ | ------ | ------ | ------ | ------ | ------ |
472
- | <a id="name-5"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
473
- | <a id="verificationtype-3"></a> `verificationType` | [`SECRET_CODES`](#secret_codes) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:45](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
523
+ | <a id="name-5"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
524
+ | <a id="verificationtype-3"></a> `verificationType` | [`SECRET_CODES`](#secret_codes) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:45](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
474
525
 
475
526
  ***
476
527
 
477
528
  #### WalletVerification
478
529
 
479
- Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
530
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
480
531
 
481
532
  Represents a wallet verification.
482
533
 
@@ -484,15 +535,15 @@ Represents a wallet verification.
484
535
 
485
536
  | Property | Type | Description | Defined in |
486
537
  | ------ | ------ | ------ | ------ |
487
- | <a id="id-2"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L17) |
488
- | <a id="name-6"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:19](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L19) |
489
- | <a id="verificationtype-4"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:21](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
538
+ | <a id="id-2"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L17) |
539
+ | <a id="name-6"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:19](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L19) |
540
+ | <a id="verificationtype-4"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:21](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
490
541
 
491
542
  ***
492
543
 
493
544
  #### WalletVerificationChallenge
494
545
 
495
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
546
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
496
547
 
497
548
  Represents a wallet verification challenge.
498
549
 
@@ -500,16 +551,16 @@ Represents a wallet verification challenge.
500
551
 
501
552
  | Property | Type | Description | Defined in |
502
553
  | ------ | ------ | ------ | ------ |
503
- | <a id="challenge"></a> `challenge` | `Record`\<`string`, `string`\> | The challenge parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L24) |
504
- | <a id="id-3"></a> `id` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L18) |
505
- | <a id="name-7"></a> `name` | `string` | The name of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:20](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L20) |
506
- | <a id="verificationtype-5"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification required. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:22](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L22) |
554
+ | <a id="challenge"></a> `challenge` | `Record`\<`string`, `string`\> | The challenge parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L24) |
555
+ | <a id="id-3"></a> `id` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L18) |
556
+ | <a id="name-7"></a> `name` | `string` | The name of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:20](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L20) |
557
+ | <a id="verificationtype-5"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification required. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:22](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L22) |
507
558
 
508
559
  ***
509
560
 
510
561
  #### WalletVerificationOptions
511
562
 
512
- Defined in: [sdk/viem/src/viem.ts:101](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L101)
563
+ Defined in: [sdk/viem/src/viem.ts:293](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L293)
513
564
 
514
565
  The options for the wallet client.
515
566
 
@@ -517,8 +568,9 @@ The options for the wallet client.
517
568
 
518
569
  | Property | Type | Description | Defined in |
519
570
  | ------ | ------ | ------ | ------ |
520
- | <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:109](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L109) |
521
- | <a id="verificationid-1"></a> `verificationId?` | `string` | The verification id (used for HD wallets), if not provided, the challenge response will be validated against all active verifications. | [sdk/viem/src/viem.ts:105](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L105) |
571
+ | <a id="challengeid"></a> `challengeId?` | `string` | The challenge id (used for HD wallets) | [sdk/viem/src/viem.ts:302](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L302) |
572
+ | <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:306](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L306) |
573
+ | <a id="verificationid-1"></a> `verificationId?` | `string` | The verification id (used for HD wallets), if not provided, the challenge response will be validated against all active verifications. | [sdk/viem/src/viem.ts:297](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L297) |
522
574
 
523
575
  ### Type Aliases
524
576
 
@@ -526,7 +578,7 @@ The options for the wallet client.
526
578
 
527
579
  > **AddressOrObject** = `string` \| \{ `userWalletAddress`: `string`; `verificationId?`: `string`; \}
528
580
 
529
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L6)
581
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L6)
530
582
 
531
583
  Represents either a wallet address string or an object containing wallet address and optional verification ID.
532
584
 
@@ -536,7 +588,7 @@ Represents either a wallet address string or an object containing wallet address
536
588
 
537
589
  > **ClientOptions** = `Omit`\<`z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>, `"httpTransportConfig"`\> & `object`
538
590
 
539
- Defined in: [sdk/viem/src/viem.ts:51](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L51)
591
+ Defined in: [sdk/viem/src/viem.ts:208](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L208)
540
592
 
541
593
  Type representing the validated client options.
542
594
 
@@ -544,7 +596,7 @@ Type representing the validated client options.
544
596
 
545
597
  | Name | Type | Defined in |
546
598
  | ------ | ------ | ------ |
547
- | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:52](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L52) |
599
+ | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:209](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L209) |
548
600
 
549
601
  ***
550
602
 
@@ -552,7 +604,7 @@ Type representing the validated client options.
552
604
 
553
605
  > **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)[]
554
606
 
555
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L30)
607
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L30)
556
608
 
557
609
  Response from creating wallet verification challenges.
558
610
 
@@ -562,7 +614,7 @@ Response from creating wallet verification challenges.
562
614
 
563
615
  > **GetChainIdOptions** = `Omit`\<`z.infer`\<*typeof* [`GetChainIdOptionsSchema`](#getchainidoptionsschema)\>, `"httpTransportConfig"`\> & `object`
564
616
 
565
- Defined in: [sdk/viem/src/viem.ts:198](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L198)
617
+ Defined in: [sdk/viem/src/viem.ts:452](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L452)
566
618
 
567
619
  Type representing the validated get chain id options.
568
620
 
@@ -570,7 +622,7 @@ Type representing the validated get chain id options.
570
622
 
571
623
  | Name | Type | Defined in |
572
624
  | ------ | ------ | ------ |
573
- | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:199](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L199) |
625
+ | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:453](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L453) |
574
626
 
575
627
  ***
576
628
 
@@ -578,7 +630,7 @@ Type representing the validated get chain id options.
578
630
 
579
631
  > **GetWalletVerificationsResponse** = [`WalletVerification`](#walletverification)[]
580
632
 
581
- Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
633
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
582
634
 
583
635
  Response from getting wallet verifications.
584
636
 
@@ -588,7 +640,7 @@ Response from getting wallet verifications.
588
640
 
589
641
  > **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
590
642
 
591
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L34)
643
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L34)
592
644
 
593
645
  Response from verifying a wallet verification challenge.
594
646
 
@@ -598,7 +650,7 @@ Response from verifying a wallet verification challenge.
598
650
 
599
651
  > **WalletVerificationInfo** = [`WalletPincodeVerificationInfo`](#walletpincodeverificationinfo) \| [`WalletOTPVerificationInfo`](#walletotpverificationinfo) \| [`WalletSecretCodesVerificationInfo`](#walletsecretcodesverificationinfo)
600
652
 
601
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
653
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
602
654
 
603
655
  Union type of all possible wallet verification information types.
604
656
 
@@ -608,7 +660,7 @@ Union type of all possible wallet verification information types.
608
660
 
609
661
  > `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
610
662
 
611
- Defined in: [sdk/viem/src/viem.ts:25](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L25)
663
+ Defined in: [sdk/viem/src/viem.ts:182](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L182)
612
664
 
613
665
  Schema for the viem client options.
614
666
 
@@ -618,7 +670,7 @@ Schema for the viem client options.
618
670
 
619
671
  > `const` **GetChainIdOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
620
672
 
621
- Defined in: [sdk/viem/src/viem.ts:180](https://github.com/settlemint/sdk/blob/v2.5.6/sdk/viem/src/viem.ts#L180)
673
+ Defined in: [sdk/viem/src/viem.ts:434](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L434)
622
674
 
623
675
  Schema for the viem client options.
624
676