@settlemint/sdk-viem 2.5.11 → 2.5.12

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 +185 -96
  2. package/dist/browser/viem.d.ts +3819 -129
  3. package/dist/browser/viem.js +90 -70
  4. package/dist/browser/viem.js.map +1 -1
  5. package/dist/viem.cjs +90 -70
  6. package/dist/viem.cjs.map +1 -1
  7. package/dist/viem.d.cts +3819 -129
  8. package/dist/viem.d.ts +3819 -129
  9. package/dist/viem.js +90 -70
  10. package/dist/viem.js.map +1 -1
  11. package/package.json +2 -2
package/README.md CHANGED
@@ -38,6 +38,7 @@
38
38
  - [Interfaces](#interfaces)
39
39
  - [CreateWalletParameters](#createwalletparameters)
40
40
  - [CreateWalletResponse](#createwalletresponse)
41
+ - [CreateWalletVerificationChallengeParameters](#createwalletverificationchallengeparameters)
41
42
  - [CreateWalletVerificationChallengesParameters](#createwalletverificationchallengesparameters)
42
43
  - [CreateWalletVerificationParameters](#createwalletverificationparameters)
43
44
  - [CreateWalletVerificationResponse](#createwalletverificationresponse)
@@ -51,11 +52,14 @@
51
52
  - [WalletPincodeVerificationInfo](#walletpincodeverificationinfo)
52
53
  - [WalletSecretCodesVerificationInfo](#walletsecretcodesverificationinfo)
53
54
  - [WalletVerification](#walletverification)
54
- - [WalletVerificationChallenge](#walletverificationchallenge)
55
+ - [WalletVerificationChallenge\<ChallengeData\>](#walletverificationchallengechallengedata)
56
+ - [WalletVerificationChallengeData](#walletverificationchallengedata)
55
57
  - [WalletVerificationOptions](#walletverificationoptions)
56
58
  - [Type Aliases](#type-aliases)
57
- - [AddressOrObject](#addressorobject)
59
+ - [AddressOrObject\<Extra\>](#addressorobjectextra)
60
+ - [AddressOrObjectWithChallengeId](#addressorobjectwithchallengeid)
58
61
  - [ClientOptions](#clientoptions)
62
+ - [CreateWalletVerificationChallengeResponse](#createwalletverificationchallengeresponse)
59
63
  - [CreateWalletVerificationChallengesResponse](#createwalletverificationchallengesresponse)
60
64
  - [GetChainIdOptions](#getchainidoptions)
61
65
  - [GetWalletVerificationsResponse](#getwalletverificationsresponse)
@@ -79,7 +83,7 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
79
83
 
80
84
  > **getChainId**(`options`): `Promise`\<`number`\>
81
85
 
82
- Defined in: [sdk/viem/src/viem.ts:485](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L485)
86
+ Defined in: [sdk/viem/src/viem.ts:446](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L446)
83
87
 
84
88
  Discovers the chain ID from an RPC endpoint without requiring prior knowledge.
85
89
 
@@ -132,7 +136,7 @@ console.log(chainId);
132
136
 
133
137
  > **getPublicClient**(`options`): \{ \} \| \{ \}
134
138
 
135
- Defined in: [sdk/viem/src/viem.ts:246](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L246)
139
+ Defined in: [sdk/viem/src/viem.ts:201](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L201)
136
140
 
137
141
  Creates an optimized public client for blockchain read operations.
138
142
 
@@ -188,9 +192,9 @@ console.log(block);
188
192
 
189
193
  #### getWalletClient()
190
194
 
191
- > **getWalletClient**(`options`): `any`
195
+ > **getWalletClient**(`options`): (`verificationOptions?`) => `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
192
196
 
193
- Defined in: [sdk/viem/src/viem.ts:361](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L361)
197
+ Defined in: [sdk/viem/src/viem.ts:315](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L315)
194
198
 
195
199
  Creates a factory function for wallet clients with runtime verification support.
196
200
 
@@ -202,10 +206,20 @@ Creates a factory function for wallet clients with runtime verification support.
202
206
 
203
207
  ##### Returns
204
208
 
205
- `any`
206
-
207
209
  Factory function that accepts runtime verification options
208
210
 
211
+ > (`verificationOptions?`): `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
212
+
213
+ ###### Parameters
214
+
215
+ | Parameter | Type |
216
+ | ------ | ------ |
217
+ | `verificationOptions?` | [`WalletVerificationOptions`](#walletverificationoptions) |
218
+
219
+ ###### Returns
220
+
221
+ `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
222
+
209
223
  ##### Remarks
210
224
 
211
225
  DESIGN PATTERN: Returns a factory function rather than a client instance because
@@ -261,7 +275,7 @@ console.log(transactionHash);
261
275
 
262
276
  #### OTPAlgorithm
263
277
 
264
- Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
278
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
265
279
 
266
280
  Supported hash algorithms for One-Time Password (OTP) verification.
267
281
  These algorithms determine the cryptographic function used to generate OTP codes.
@@ -270,21 +284,21 @@ These algorithms determine the cryptographic function used to generate OTP codes
270
284
 
271
285
  | Enumeration Member | Value | Description | Defined in |
272
286
  | ------ | ------ | ------ | ------ |
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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
287
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L20) |
288
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L22) |
289
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L24) |
290
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L30) |
291
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L32) |
292
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L34) |
293
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L36) |
294
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L26) |
295
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
282
296
 
283
297
  ***
284
298
 
285
299
  #### WalletVerificationType
286
300
 
287
- Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
301
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
288
302
 
289
303
  Types of wallet verification methods supported by the system.
290
304
  Used to identify different verification mechanisms when creating or managing wallet verifications.
@@ -293,15 +307,15 @@ Used to identify different verification mechanisms when creating or managing wal
293
307
 
294
308
  | Enumeration Member | Value | Description | Defined in |
295
309
  | ------ | ------ | ------ | ------ |
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.11/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.11/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.11/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
310
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L9) |
311
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L7) |
312
+ | <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.12/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
299
313
 
300
314
  ### Interfaces
301
315
 
302
316
  #### CreateWalletParameters
303
317
 
304
- Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
318
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
305
319
 
306
320
  Parameters for creating a wallet.
307
321
 
@@ -309,14 +323,14 @@ Parameters for creating a wallet.
309
323
 
310
324
  | Property | Type | Description | Defined in |
311
325
  | ------ | ------ | ------ | ------ |
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.11/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.11/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
326
+ | <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.12/sdk/viem/src/custom-actions/create-wallet.action.ts#L16) |
327
+ | <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.12/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
314
328
 
315
329
  ***
316
330
 
317
331
  #### CreateWalletResponse
318
332
 
319
- Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
333
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
320
334
 
321
335
  Response from creating a wallet.
322
336
 
@@ -324,16 +338,31 @@ Response from creating a wallet.
324
338
 
325
339
  | Property | Type | Description | Defined in |
326
340
  | ------ | ------ | ------ | ------ |
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.11/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.11/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.11/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.11/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
341
+ | <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.12/sdk/viem/src/custom-actions/create-wallet.action.ts#L30) |
342
+ | <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.12/sdk/viem/src/custom-actions/create-wallet.action.ts#L32) |
343
+ | <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.12/sdk/viem/src/custom-actions/create-wallet.action.ts#L26) |
344
+ | <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.12/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
345
+
346
+ ***
347
+
348
+ #### CreateWalletVerificationChallengeParameters
349
+
350
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L7)
351
+
352
+ Parameters for creating wallet verification challenges.
353
+
354
+ ##### Properties
355
+
356
+ | Property | Type | Description | Defined in |
357
+ | ------ | ------ | ------ | ------ |
358
+ | <a id="userwalletaddress"></a> `userWalletAddress` | `string` | The wallet address. | [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L9) |
359
+ | <a id="verificationid"></a> `verificationId` | `string` | The verification ID. | [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:11](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L11) |
331
360
 
332
361
  ***
333
362
 
334
363
  #### CreateWalletVerificationChallengesParameters
335
364
 
336
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
365
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
337
366
 
338
367
  Parameters for creating wallet verification challenges.
339
368
 
@@ -341,13 +370,13 @@ Parameters for creating wallet verification challenges.
341
370
 
342
371
  | Property | Type | Description | Defined in |
343
372
  | ------ | ------ | ------ | ------ |
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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
373
+ | <a id="addressorobject"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2)\<\{ `amount?`: `number`; \}\> | 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.12/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
345
374
 
346
375
  ***
347
376
 
348
377
  #### CreateWalletVerificationParameters
349
378
 
350
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
379
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
351
380
 
352
381
  Parameters for creating a wallet verification.
353
382
 
@@ -355,14 +384,14 @@ Parameters for creating a wallet verification.
355
384
 
356
385
  | Property | Type | Description | Defined in |
357
386
  | ------ | ------ | ------ | ------ |
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.11/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.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
387
+ | <a id="userwalletaddress-1"></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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
388
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
360
389
 
361
390
  ***
362
391
 
363
392
  #### CreateWalletVerificationResponse
364
393
 
365
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
394
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
366
395
 
367
396
  Response from creating a wallet verification.
368
397
 
@@ -370,16 +399,16 @@ Response from creating a wallet verification.
370
399
 
371
400
  | Property | Type | Description | Defined in |
372
401
  | ------ | ------ | ------ | ------ |
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.11/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.11/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.11/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.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
402
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L71) |
403
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L73) |
404
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L77) |
405
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
377
406
 
378
407
  ***
379
408
 
380
409
  #### DeleteWalletVerificationParameters
381
410
 
382
- Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
411
+ Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
383
412
 
384
413
  Parameters for deleting a wallet verification.
385
414
 
@@ -387,14 +416,14 @@ Parameters for deleting a wallet verification.
387
416
 
388
417
  | Property | Type | Description | Defined in |
389
418
  | ------ | ------ | ------ | ------ |
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.11/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.11/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
419
+ | <a id="userwalletaddress-2"></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.12/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L8) |
420
+ | <a id="verificationid-1"></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.12/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
392
421
 
393
422
  ***
394
423
 
395
424
  #### DeleteWalletVerificationResponse
396
425
 
397
- Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
426
+ Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
398
427
 
399
428
  Response from deleting a wallet verification.
400
429
 
@@ -402,13 +431,13 @@ Response from deleting a wallet verification.
402
431
 
403
432
  | Property | Type | Description | Defined in |
404
433
  | ------ | ------ | ------ | ------ |
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.11/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
434
+ | <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.12/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
406
435
 
407
436
  ***
408
437
 
409
438
  #### GetWalletVerificationsParameters
410
439
 
411
- Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
440
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
412
441
 
413
442
  Parameters for getting wallet verifications.
414
443
 
@@ -416,13 +445,13 @@ Parameters for getting wallet verifications.
416
445
 
417
446
  | Property | Type | Description | Defined in |
418
447
  | ------ | ------ | ------ | ------ |
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.11/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
448
+ | <a id="userwalletaddress-3"></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.12/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
420
449
 
421
450
  ***
422
451
 
423
452
  #### VerificationResult
424
453
 
425
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L26)
454
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:38](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L38)
426
455
 
427
456
  Result of a wallet verification challenge.
428
457
 
@@ -430,13 +459,13 @@ Result of a wallet verification challenge.
430
459
 
431
460
  | Property | Type | Description | Defined in |
432
461
  | ------ | ------ | ------ | ------ |
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.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28) |
462
+ | <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:40](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L40) |
434
463
 
435
464
  ***
436
465
 
437
466
  #### VerifyWalletVerificationChallengeParameters
438
467
 
439
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L16)
468
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28)
440
469
 
441
470
  Parameters for verifying a wallet verification challenge.
442
471
 
@@ -444,14 +473,14 @@ Parameters for verifying a wallet verification challenge.
444
473
 
445
474
  | Property | Type | Description | Defined in |
446
475
  | ------ | ------ | ------ | ------ |
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.11/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.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L20) |
476
+ | <a id="addressorobject-1"></a> `addressOrObject` | [`AddressOrObjectWithChallengeId`](#addressorobjectwithchallengeid) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L30) |
477
+ | <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:32](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L32) |
449
478
 
450
479
  ***
451
480
 
452
481
  #### WalletInfo
453
482
 
454
- Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
483
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
455
484
 
456
485
  Information about the wallet to be created.
457
486
 
@@ -459,13 +488,13 @@ Information about the wallet to be created.
459
488
 
460
489
  | Property | Type | Description | Defined in |
461
490
  | ------ | ------ | ------ | ------ |
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.11/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
491
+ | <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.12/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
463
492
 
464
493
  ***
465
494
 
466
495
  #### WalletOTPVerificationInfo
467
496
 
468
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
497
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
469
498
 
470
499
  Information for One-Time Password (OTP) verification.
471
500
 
@@ -477,18 +506,18 @@ Information for One-Time Password (OTP) verification.
477
506
 
478
507
  | Property | Type | Description | Overrides | Inherited from | Defined in |
479
508
  | ------ | ------ | ------ | ------ | ------ | ------ |
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.11/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.11/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.11/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.11/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.11/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.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
509
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L31) |
510
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L33) |
511
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L37) |
512
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
513
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L35) |
514
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
486
515
 
487
516
  ***
488
517
 
489
518
  #### WalletPincodeVerificationInfo
490
519
 
491
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
520
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
492
521
 
493
522
  Information for PIN code verification.
494
523
 
@@ -500,15 +529,15 @@ Information for PIN code verification.
500
529
 
501
530
  | Property | Type | Description | Overrides | Inherited from | Defined in |
502
531
  | ------ | ------ | ------ | ------ | ------ | ------ |
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.11/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.11/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.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
532
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
533
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L21) |
534
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
506
535
 
507
536
  ***
508
537
 
509
538
  #### WalletSecretCodesVerificationInfo
510
539
 
511
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
540
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
512
541
 
513
542
  Information for secret recovery codes verification.
514
543
 
@@ -520,14 +549,14 @@ Information for secret recovery codes verification.
520
549
 
521
550
  | Property | Type | Description | Overrides | Inherited from | Defined in |
522
551
  | ------ | ------ | ------ | ------ | ------ | ------ |
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.11/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.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
552
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
553
+ | <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.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
525
554
 
526
555
  ***
527
556
 
528
557
  #### WalletVerification
529
558
 
530
- Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
559
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
531
560
 
532
561
  Represents a wallet verification.
533
562
 
@@ -535,32 +564,56 @@ Represents a wallet verification.
535
564
 
536
565
  | Property | Type | Description | Defined in |
537
566
  | ------ | ------ | ------ | ------ |
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.11/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.11/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.11/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
567
+ | <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.12/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L17) |
568
+ | <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.12/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L19) |
569
+ | <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.12/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
541
570
 
542
571
  ***
543
572
 
544
- #### WalletVerificationChallenge
573
+ #### WalletVerificationChallenge\<ChallengeData\>
545
574
 
546
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
575
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts:6](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L6)
547
576
 
548
577
  Represents a wallet verification challenge.
549
578
 
579
+ ##### Type Parameters
580
+
581
+ | Type Parameter |
582
+ | ------ |
583
+ | `ChallengeData` |
584
+
550
585
  ##### Properties
551
586
 
552
587
  | Property | Type | Description | Defined in |
553
588
  | ------ | ------ | ------ | ------ |
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.11/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.11/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.11/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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L22) |
589
+ | <a id="challenge"></a> `challenge` | `ChallengeData` | The challenge parameters specific to the verification type. | [sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts:16](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L16) |
590
+ | <a id="id-3"></a> `id` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts:8](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L8) |
591
+ | <a id="name-7"></a> `name` | `string` | The name of the challenge. | [sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts:10](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L10) |
592
+ | <a id="verificationid-2"></a> `verificationId` | `string` | The verification ID. | [sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts:12](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L12) |
593
+ | <a id="verificationtype-5"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification required. | [sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts:14](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L14) |
594
+
595
+ ***
596
+
597
+ #### WalletVerificationChallengeData
598
+
599
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L17)
600
+
601
+ Data specific to a wallet verification challenge.
602
+
603
+ ##### Properties
604
+
605
+ | Property | Type | Description | Defined in |
606
+ | ------ | ------ | ------ | ------ |
607
+ | <a id="challengeid"></a> `challengeId` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:21](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L21) |
608
+ | <a id="id-4"></a> `id` | `string` | The verification ID (for backward compatibility). | [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:19](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L19) |
609
+ | <a id="salt"></a> `salt?` | `string` | Optional salt for PINCODE verification type. | [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:23](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L23) |
610
+ | <a id="secret"></a> `secret?` | `string` | Optional secret for PINCODE verification type. | [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:25](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L25) |
558
611
 
559
612
  ***
560
613
 
561
614
  #### WalletVerificationOptions
562
615
 
563
- Defined in: [sdk/viem/src/viem.ts:293](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L293)
616
+ Defined in: [sdk/viem/src/viem.ts:248](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L248)
564
617
 
565
618
  The options for the wallet client.
566
619
 
@@ -568,27 +621,53 @@ The options for the wallet client.
568
621
 
569
622
  | Property | Type | Description | Defined in |
570
623
  | ------ | ------ | ------ | ------ |
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.11/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.11/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.11/sdk/viem/src/viem.ts#L297) |
624
+ | <a id="challengeid-1"></a> `challengeId?` | `string` | The challenge id (used for HD wallets) | [sdk/viem/src/viem.ts:256](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L256) |
625
+ | <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:260](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L260) |
626
+ | <a id="verificationid-3"></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:252](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L252) |
574
627
 
575
628
  ### Type Aliases
576
629
 
577
- #### AddressOrObject
630
+ #### AddressOrObject\<Extra\>
578
631
 
579
- > **AddressOrObject** = `string` \| \{ `userWalletAddress`: `string`; `verificationId?`: `string`; \}
632
+ > **AddressOrObject**\<`Extra`\> = `string` \| `object` & `Extra`
580
633
 
581
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L6)
634
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L8)
582
635
 
583
636
  Represents either a wallet address string or an object containing wallet address and optional verification ID.
584
637
 
638
+ ##### Type Parameters
639
+
640
+ | Type Parameter | Default type |
641
+ | ------ | ------ |
642
+ | `Extra` | `object` |
643
+
644
+ ***
645
+
646
+ #### AddressOrObjectWithChallengeId
647
+
648
+ > **AddressOrObjectWithChallengeId** = [`AddressOrObject`](#addressorobject-2) \| \{ `challengeId`: `string`; \}
649
+
650
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L18)
651
+
652
+ Represents either a wallet address string, an object containing wallet address and optional verification ID or a challenge ID.
653
+
654
+ ##### Type declaration
655
+
656
+ [`AddressOrObject`](#addressorobject-2)
657
+
658
+ \{ `challengeId`: `string`; \}
659
+
660
+ | Name | Type | Description | Defined in |
661
+ | ------ | ------ | ------ | ------ |
662
+ | `challengeId` | `string` | ID of the challenge to verify against | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:22](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L22) |
663
+
585
664
  ***
586
665
 
587
666
  #### ClientOptions
588
667
 
589
668
  > **ClientOptions** = `Omit`\<`z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>, `"httpTransportConfig"`\> & `object`
590
669
 
591
- Defined in: [sdk/viem/src/viem.ts:208](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L208)
670
+ Defined in: [sdk/viem/src/viem.ts:163](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L163)
592
671
 
593
672
  Type representing the validated client options.
594
673
 
@@ -596,15 +675,25 @@ Type representing the validated client options.
596
675
 
597
676
  | Name | Type | Defined in |
598
677
  | ------ | ------ | ------ |
599
- | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:209](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L209) |
678
+ | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:164](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L164) |
679
+
680
+ ***
681
+
682
+ #### CreateWalletVerificationChallengeResponse
683
+
684
+ > **CreateWalletVerificationChallengeResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)\<[`WalletVerificationChallengeData`](#walletverificationchallengedata)\>
685
+
686
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:31](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L31)
687
+
688
+ Response from creating wallet verification challenge.
600
689
 
601
690
  ***
602
691
 
603
692
  #### CreateWalletVerificationChallengesResponse
604
693
 
605
- > **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)[]
694
+ > **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)\<`Record`\<`string`, `string`\>\>[]
606
695
 
607
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L30)
696
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
608
697
 
609
698
  Response from creating wallet verification challenges.
610
699
 
@@ -614,7 +703,7 @@ Response from creating wallet verification challenges.
614
703
 
615
704
  > **GetChainIdOptions** = `Omit`\<`z.infer`\<*typeof* [`GetChainIdOptionsSchema`](#getchainidoptionsschema)\>, `"httpTransportConfig"`\> & `object`
616
705
 
617
- Defined in: [sdk/viem/src/viem.ts:452](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L452)
706
+ Defined in: [sdk/viem/src/viem.ts:413](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L413)
618
707
 
619
708
  Type representing the validated get chain id options.
620
709
 
@@ -622,7 +711,7 @@ Type representing the validated get chain id options.
622
711
 
623
712
  | Name | Type | Defined in |
624
713
  | ------ | ------ | ------ |
625
- | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:453](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L453) |
714
+ | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:414](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L414) |
626
715
 
627
716
  ***
628
717
 
@@ -630,7 +719,7 @@ Type representing the validated get chain id options.
630
719
 
631
720
  > **GetWalletVerificationsResponse** = [`WalletVerification`](#walletverification)[]
632
721
 
633
- Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
722
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
634
723
 
635
724
  Response from getting wallet verifications.
636
725
 
@@ -640,7 +729,7 @@ Response from getting wallet verifications.
640
729
 
641
730
  > **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
642
731
 
643
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L34)
732
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:46](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L46)
644
733
 
645
734
  Response from verifying a wallet verification challenge.
646
735
 
@@ -650,7 +739,7 @@ Response from verifying a wallet verification challenge.
650
739
 
651
740
  > **WalletVerificationInfo** = [`WalletPincodeVerificationInfo`](#walletpincodeverificationinfo) \| [`WalletOTPVerificationInfo`](#walletotpverificationinfo) \| [`WalletSecretCodesVerificationInfo`](#walletsecretcodesverificationinfo)
652
741
 
653
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
742
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
654
743
 
655
744
  Union type of all possible wallet verification information types.
656
745
 
@@ -660,7 +749,7 @@ Union type of all possible wallet verification information types.
660
749
 
661
750
  > `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
662
751
 
663
- Defined in: [sdk/viem/src/viem.ts:182](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L182)
752
+ Defined in: [sdk/viem/src/viem.ts:137](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L137)
664
753
 
665
754
  Schema for the viem client options.
666
755
 
@@ -670,7 +759,7 @@ Schema for the viem client options.
670
759
 
671
760
  > `const` **GetChainIdOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
672
761
 
673
- Defined in: [sdk/viem/src/viem.ts:434](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L434)
762
+ Defined in: [sdk/viem/src/viem.ts:395](https://github.com/settlemint/sdk/blob/v2.5.12/sdk/viem/src/viem.ts#L395)
674
763
 
675
764
  Schema for the viem client options.
676
765