@settlemint/sdk-viem 2.5.10 → 2.5.11-pre338cffc
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +87 -87
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -79,7 +79,7 @@ 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:485](https://github.com/settlemint/sdk/blob/v2.5.
|
|
82
|
+
Defined in: [sdk/viem/src/viem.ts:485](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L485)
|
|
83
83
|
|
|
84
84
|
Discovers the chain ID from an RPC endpoint without requiring prior knowledge.
|
|
85
85
|
|
|
@@ -132,7 +132,7 @@ console.log(chainId);
|
|
|
132
132
|
|
|
133
133
|
> **getPublicClient**(`options`): \{ \} \| \{ \}
|
|
134
134
|
|
|
135
|
-
Defined in: [sdk/viem/src/viem.ts:246](https://github.com/settlemint/sdk/blob/v2.5.
|
|
135
|
+
Defined in: [sdk/viem/src/viem.ts:246](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L246)
|
|
136
136
|
|
|
137
137
|
Creates an optimized public client for blockchain read operations.
|
|
138
138
|
|
|
@@ -190,7 +190,7 @@ console.log(block);
|
|
|
190
190
|
|
|
191
191
|
> **getWalletClient**(`options`): `any`
|
|
192
192
|
|
|
193
|
-
Defined in: [sdk/viem/src/viem.ts:361](https://github.com/settlemint/sdk/blob/v2.5.
|
|
193
|
+
Defined in: [sdk/viem/src/viem.ts:361](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L361)
|
|
194
194
|
|
|
195
195
|
Creates a factory function for wallet clients with runtime verification support.
|
|
196
196
|
|
|
@@ -261,7 +261,7 @@ console.log(transactionHash);
|
|
|
261
261
|
|
|
262
262
|
#### OTPAlgorithm
|
|
263
263
|
|
|
264
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
265
265
|
|
|
266
266
|
Supported hash algorithms for One-Time Password (OTP) verification.
|
|
267
267
|
These algorithms determine the cryptographic function used to generate OTP codes.
|
|
@@ -270,21 +270,21 @@ These algorithms determine the cryptographic function used to generate OTP codes
|
|
|
270
270
|
|
|
271
271
|
| Enumeration Member | Value | Description | Defined in |
|
|
272
272
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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) |
|
|
282
282
|
|
|
283
283
|
***
|
|
284
284
|
|
|
285
285
|
#### WalletVerificationType
|
|
286
286
|
|
|
287
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
288
288
|
|
|
289
289
|
Types of wallet verification methods supported by the system.
|
|
290
290
|
Used to identify different verification mechanisms when creating or managing wallet verifications.
|
|
@@ -293,15 +293,15 @@ Used to identify different verification mechanisms when creating or managing wal
|
|
|
293
293
|
|
|
294
294
|
| Enumeration Member | Value | Description | Defined in |
|
|
295
295
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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) |
|
|
299
299
|
|
|
300
300
|
### Interfaces
|
|
301
301
|
|
|
302
302
|
#### CreateWalletParameters
|
|
303
303
|
|
|
304
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
305
305
|
|
|
306
306
|
Parameters for creating a wallet.
|
|
307
307
|
|
|
@@ -309,14 +309,14 @@ Parameters for creating a wallet.
|
|
|
309
309
|
|
|
310
310
|
| Property | Type | Description | Defined in |
|
|
311
311
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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) |
|
|
314
314
|
|
|
315
315
|
***
|
|
316
316
|
|
|
317
317
|
#### CreateWalletResponse
|
|
318
318
|
|
|
319
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
320
320
|
|
|
321
321
|
Response from creating a wallet.
|
|
322
322
|
|
|
@@ -324,16 +324,16 @@ Response from creating a wallet.
|
|
|
324
324
|
|
|
325
325
|
| Property | Type | Description | Defined in |
|
|
326
326
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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) |
|
|
331
331
|
|
|
332
332
|
***
|
|
333
333
|
|
|
334
334
|
#### CreateWalletVerificationChallengesParameters
|
|
335
335
|
|
|
336
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
337
337
|
|
|
338
338
|
Parameters for creating wallet verification challenges.
|
|
339
339
|
|
|
@@ -341,13 +341,13 @@ Parameters for creating wallet verification challenges.
|
|
|
341
341
|
|
|
342
342
|
| Property | Type | Description | Defined in |
|
|
343
343
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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) |
|
|
345
345
|
|
|
346
346
|
***
|
|
347
347
|
|
|
348
348
|
#### CreateWalletVerificationParameters
|
|
349
349
|
|
|
350
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
351
351
|
|
|
352
352
|
Parameters for creating a wallet verification.
|
|
353
353
|
|
|
@@ -355,14 +355,14 @@ Parameters for creating a wallet verification.
|
|
|
355
355
|
|
|
356
356
|
| Property | Type | Description | Defined in |
|
|
357
357
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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) |
|
|
360
360
|
|
|
361
361
|
***
|
|
362
362
|
|
|
363
363
|
#### CreateWalletVerificationResponse
|
|
364
364
|
|
|
365
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
366
366
|
|
|
367
367
|
Response from creating a wallet verification.
|
|
368
368
|
|
|
@@ -370,16 +370,16 @@ Response from creating a wallet verification.
|
|
|
370
370
|
|
|
371
371
|
| Property | Type | Description | Defined in |
|
|
372
372
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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) |
|
|
377
377
|
|
|
378
378
|
***
|
|
379
379
|
|
|
380
380
|
#### DeleteWalletVerificationParameters
|
|
381
381
|
|
|
382
|
-
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
383
383
|
|
|
384
384
|
Parameters for deleting a wallet verification.
|
|
385
385
|
|
|
@@ -387,14 +387,14 @@ Parameters for deleting a wallet verification.
|
|
|
387
387
|
|
|
388
388
|
| Property | Type | Description | Defined in |
|
|
389
389
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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) |
|
|
392
392
|
|
|
393
393
|
***
|
|
394
394
|
|
|
395
395
|
#### DeleteWalletVerificationResponse
|
|
396
396
|
|
|
397
|
-
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
398
398
|
|
|
399
399
|
Response from deleting a wallet verification.
|
|
400
400
|
|
|
@@ -402,13 +402,13 @@ Response from deleting a wallet verification.
|
|
|
402
402
|
|
|
403
403
|
| Property | Type | Description | Defined in |
|
|
404
404
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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) |
|
|
406
406
|
|
|
407
407
|
***
|
|
408
408
|
|
|
409
409
|
#### GetWalletVerificationsParameters
|
|
410
410
|
|
|
411
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
412
412
|
|
|
413
413
|
Parameters for getting wallet verifications.
|
|
414
414
|
|
|
@@ -416,13 +416,13 @@ Parameters for getting wallet verifications.
|
|
|
416
416
|
|
|
417
417
|
| Property | Type | Description | Defined in |
|
|
418
418
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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) |
|
|
420
420
|
|
|
421
421
|
***
|
|
422
422
|
|
|
423
423
|
#### VerificationResult
|
|
424
424
|
|
|
425
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
426
426
|
|
|
427
427
|
Result of a wallet verification challenge.
|
|
428
428
|
|
|
@@ -430,13 +430,13 @@ Result of a wallet verification challenge.
|
|
|
430
430
|
|
|
431
431
|
| Property | Type | Description | Defined in |
|
|
432
432
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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) |
|
|
434
434
|
|
|
435
435
|
***
|
|
436
436
|
|
|
437
437
|
#### VerifyWalletVerificationChallengeParameters
|
|
438
438
|
|
|
439
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
440
440
|
|
|
441
441
|
Parameters for verifying a wallet verification challenge.
|
|
442
442
|
|
|
@@ -444,14 +444,14 @@ Parameters for verifying a wallet verification challenge.
|
|
|
444
444
|
|
|
445
445
|
| Property | Type | Description | Defined in |
|
|
446
446
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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) |
|
|
449
449
|
|
|
450
450
|
***
|
|
451
451
|
|
|
452
452
|
#### WalletInfo
|
|
453
453
|
|
|
454
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
455
455
|
|
|
456
456
|
Information about the wallet to be created.
|
|
457
457
|
|
|
@@ -459,13 +459,13 @@ Information about the wallet to be created.
|
|
|
459
459
|
|
|
460
460
|
| Property | Type | Description | Defined in |
|
|
461
461
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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) |
|
|
463
463
|
|
|
464
464
|
***
|
|
465
465
|
|
|
466
466
|
#### WalletOTPVerificationInfo
|
|
467
467
|
|
|
468
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
469
469
|
|
|
470
470
|
Information for One-Time Password (OTP) verification.
|
|
471
471
|
|
|
@@ -477,18 +477,18 @@ Information for One-Time Password (OTP) verification.
|
|
|
477
477
|
|
|
478
478
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
479
479
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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) |
|
|
486
486
|
|
|
487
487
|
***
|
|
488
488
|
|
|
489
489
|
#### WalletPincodeVerificationInfo
|
|
490
490
|
|
|
491
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
492
492
|
|
|
493
493
|
Information for PIN code verification.
|
|
494
494
|
|
|
@@ -500,15 +500,15 @@ Information for PIN code verification.
|
|
|
500
500
|
|
|
501
501
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
502
502
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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) |
|
|
506
506
|
|
|
507
507
|
***
|
|
508
508
|
|
|
509
509
|
#### WalletSecretCodesVerificationInfo
|
|
510
510
|
|
|
511
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
512
512
|
|
|
513
513
|
Information for secret recovery codes verification.
|
|
514
514
|
|
|
@@ -520,14 +520,14 @@ Information for secret recovery codes verification.
|
|
|
520
520
|
|
|
521
521
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
522
522
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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) |
|
|
525
525
|
|
|
526
526
|
***
|
|
527
527
|
|
|
528
528
|
#### WalletVerification
|
|
529
529
|
|
|
530
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
531
531
|
|
|
532
532
|
Represents a wallet verification.
|
|
533
533
|
|
|
@@ -535,15 +535,15 @@ Represents a wallet verification.
|
|
|
535
535
|
|
|
536
536
|
| Property | Type | Description | Defined in |
|
|
537
537
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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) |
|
|
541
541
|
|
|
542
542
|
***
|
|
543
543
|
|
|
544
544
|
#### WalletVerificationChallenge
|
|
545
545
|
|
|
546
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
547
547
|
|
|
548
548
|
Represents a wallet verification challenge.
|
|
549
549
|
|
|
@@ -551,16 +551,16 @@ Represents a wallet verification challenge.
|
|
|
551
551
|
|
|
552
552
|
| Property | Type | Description | Defined in |
|
|
553
553
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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) |
|
|
558
558
|
|
|
559
559
|
***
|
|
560
560
|
|
|
561
561
|
#### WalletVerificationOptions
|
|
562
562
|
|
|
563
|
-
Defined in: [sdk/viem/src/viem.ts:293](https://github.com/settlemint/sdk/blob/v2.5.
|
|
563
|
+
Defined in: [sdk/viem/src/viem.ts:293](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L293)
|
|
564
564
|
|
|
565
565
|
The options for the wallet client.
|
|
566
566
|
|
|
@@ -568,9 +568,9 @@ The options for the wallet client.
|
|
|
568
568
|
|
|
569
569
|
| Property | Type | Description | Defined in |
|
|
570
570
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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) |
|
|
574
574
|
|
|
575
575
|
### Type Aliases
|
|
576
576
|
|
|
@@ -578,7 +578,7 @@ The options for the wallet client.
|
|
|
578
578
|
|
|
579
579
|
> **AddressOrObject** = `string` \| \{ `userWalletAddress`: `string`; `verificationId?`: `string`; \}
|
|
580
580
|
|
|
581
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
582
582
|
|
|
583
583
|
Represents either a wallet address string or an object containing wallet address and optional verification ID.
|
|
584
584
|
|
|
@@ -588,7 +588,7 @@ Represents either a wallet address string or an object containing wallet address
|
|
|
588
588
|
|
|
589
589
|
> **ClientOptions** = `Omit`\<`z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
590
590
|
|
|
591
|
-
Defined in: [sdk/viem/src/viem.ts:208](https://github.com/settlemint/sdk/blob/v2.5.
|
|
591
|
+
Defined in: [sdk/viem/src/viem.ts:208](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L208)
|
|
592
592
|
|
|
593
593
|
Type representing the validated client options.
|
|
594
594
|
|
|
@@ -596,7 +596,7 @@ Type representing the validated client options.
|
|
|
596
596
|
|
|
597
597
|
| Name | Type | Defined in |
|
|
598
598
|
| ------ | ------ | ------ |
|
|
599
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:209](https://github.com/settlemint/sdk/blob/v2.5.
|
|
599
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:209](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L209) |
|
|
600
600
|
|
|
601
601
|
***
|
|
602
602
|
|
|
@@ -604,7 +604,7 @@ Type representing the validated client options.
|
|
|
604
604
|
|
|
605
605
|
> **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)[]
|
|
606
606
|
|
|
607
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
608
608
|
|
|
609
609
|
Response from creating wallet verification challenges.
|
|
610
610
|
|
|
@@ -614,7 +614,7 @@ Response from creating wallet verification challenges.
|
|
|
614
614
|
|
|
615
615
|
> **GetChainIdOptions** = `Omit`\<`z.infer`\<*typeof* [`GetChainIdOptionsSchema`](#getchainidoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
616
616
|
|
|
617
|
-
Defined in: [sdk/viem/src/viem.ts:452](https://github.com/settlemint/sdk/blob/v2.5.
|
|
617
|
+
Defined in: [sdk/viem/src/viem.ts:452](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L452)
|
|
618
618
|
|
|
619
619
|
Type representing the validated get chain id options.
|
|
620
620
|
|
|
@@ -622,7 +622,7 @@ Type representing the validated get chain id options.
|
|
|
622
622
|
|
|
623
623
|
| Name | Type | Defined in |
|
|
624
624
|
| ------ | ------ | ------ |
|
|
625
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:453](https://github.com/settlemint/sdk/blob/v2.5.
|
|
625
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:453](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L453) |
|
|
626
626
|
|
|
627
627
|
***
|
|
628
628
|
|
|
@@ -630,7 +630,7 @@ Type representing the validated get chain id options.
|
|
|
630
630
|
|
|
631
631
|
> **GetWalletVerificationsResponse** = [`WalletVerification`](#walletverification)[]
|
|
632
632
|
|
|
633
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
634
634
|
|
|
635
635
|
Response from getting wallet verifications.
|
|
636
636
|
|
|
@@ -640,7 +640,7 @@ Response from getting wallet verifications.
|
|
|
640
640
|
|
|
641
641
|
> **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
|
|
642
642
|
|
|
643
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
644
644
|
|
|
645
645
|
Response from verifying a wallet verification challenge.
|
|
646
646
|
|
|
@@ -650,7 +650,7 @@ Response from verifying a wallet verification challenge.
|
|
|
650
650
|
|
|
651
651
|
> **WalletVerificationInfo** = [`WalletPincodeVerificationInfo`](#walletpincodeverificationinfo) \| [`WalletOTPVerificationInfo`](#walletotpverificationinfo) \| [`WalletSecretCodesVerificationInfo`](#walletsecretcodesverificationinfo)
|
|
652
652
|
|
|
653
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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)
|
|
654
654
|
|
|
655
655
|
Union type of all possible wallet verification information types.
|
|
656
656
|
|
|
@@ -660,7 +660,7 @@ Union type of all possible wallet verification information types.
|
|
|
660
660
|
|
|
661
661
|
> `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
662
662
|
|
|
663
|
-
Defined in: [sdk/viem/src/viem.ts:182](https://github.com/settlemint/sdk/blob/v2.5.
|
|
663
|
+
Defined in: [sdk/viem/src/viem.ts:182](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L182)
|
|
664
664
|
|
|
665
665
|
Schema for the viem client options.
|
|
666
666
|
|
|
@@ -670,7 +670,7 @@ Schema for the viem client options.
|
|
|
670
670
|
|
|
671
671
|
> `const` **GetChainIdOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
672
672
|
|
|
673
|
-
Defined in: [sdk/viem/src/viem.ts:434](https://github.com/settlemint/sdk/blob/v2.5.
|
|
673
|
+
Defined in: [sdk/viem/src/viem.ts:434](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L434)
|
|
674
674
|
|
|
675
675
|
Schema for the viem client options.
|
|
676
676
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@settlemint/sdk-viem",
|
|
3
3
|
"description": "Viem (TypeScript Interface for Ethereum) module for SettleMint SDK",
|
|
4
|
-
"version": "2.5.
|
|
4
|
+
"version": "2.5.11-pre338cffc",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"private": false,
|
|
7
7
|
"license": "FSL-1.1-MIT",
|
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {},
|
|
55
55
|
"dependencies": {
|
|
56
|
-
"@settlemint/sdk-utils": "2.5.
|
|
56
|
+
"@settlemint/sdk-utils": "2.5.11-pre338cffc",
|
|
57
57
|
"viem": "^2",
|
|
58
58
|
"zod": "^4"
|
|
59
59
|
},
|