@settlemint/sdk-viem 2.5.12 → 2.5.13
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 +99 -99
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -83,7 +83,7 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
|
|
|
83
83
|
|
|
84
84
|
> **getChainId**(`options`): `Promise`\<`number`\>
|
|
85
85
|
|
|
86
|
-
Defined in: [sdk/viem/src/viem.ts:446](https://github.com/settlemint/sdk/blob/v2.5.
|
|
86
|
+
Defined in: [sdk/viem/src/viem.ts:446](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/viem.ts#L446)
|
|
87
87
|
|
|
88
88
|
Discovers the chain ID from an RPC endpoint without requiring prior knowledge.
|
|
89
89
|
|
|
@@ -136,7 +136,7 @@ console.log(chainId);
|
|
|
136
136
|
|
|
137
137
|
> **getPublicClient**(`options`): \{ \} \| \{ \}
|
|
138
138
|
|
|
139
|
-
Defined in: [sdk/viem/src/viem.ts:201](https://github.com/settlemint/sdk/blob/v2.5.
|
|
139
|
+
Defined in: [sdk/viem/src/viem.ts:201](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/viem.ts#L201)
|
|
140
140
|
|
|
141
141
|
Creates an optimized public client for blockchain read operations.
|
|
142
142
|
|
|
@@ -194,7 +194,7 @@ console.log(block);
|
|
|
194
194
|
|
|
195
195
|
> **getWalletClient**(`options`): (`verificationOptions?`) => `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
|
|
196
196
|
|
|
197
|
-
Defined in: [sdk/viem/src/viem.ts:315](https://github.com/settlemint/sdk/blob/v2.5.
|
|
197
|
+
Defined in: [sdk/viem/src/viem.ts:315](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/viem.ts#L315)
|
|
198
198
|
|
|
199
199
|
Creates a factory function for wallet clients with runtime verification support.
|
|
200
200
|
|
|
@@ -275,7 +275,7 @@ console.log(transactionHash);
|
|
|
275
275
|
|
|
276
276
|
#### OTPAlgorithm
|
|
277
277
|
|
|
278
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.
|
|
278
|
+
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
|
|
279
279
|
|
|
280
280
|
Supported hash algorithms for One-Time Password (OTP) verification.
|
|
281
281
|
These algorithms determine the cryptographic function used to generate OTP codes.
|
|
@@ -284,21 +284,21 @@ These algorithms determine the cryptographic function used to generate OTP codes
|
|
|
284
284
|
|
|
285
285
|
| Enumeration Member | Value | Description | Defined in |
|
|
286
286
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.13/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.13/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.13/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.13/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.13/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.13/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.13/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.13/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.13/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
|
|
296
296
|
|
|
297
297
|
***
|
|
298
298
|
|
|
299
299
|
#### WalletVerificationType
|
|
300
300
|
|
|
301
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.
|
|
301
|
+
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
|
|
302
302
|
|
|
303
303
|
Types of wallet verification methods supported by the system.
|
|
304
304
|
Used to identify different verification mechanisms when creating or managing wallet verifications.
|
|
@@ -307,15 +307,15 @@ Used to identify different verification mechanisms when creating or managing wal
|
|
|
307
307
|
|
|
308
308
|
| Enumeration Member | Value | Description | Defined in |
|
|
309
309
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.13/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.13/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.13/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
|
|
313
313
|
|
|
314
314
|
### Interfaces
|
|
315
315
|
|
|
316
316
|
#### CreateWalletParameters
|
|
317
317
|
|
|
318
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.
|
|
318
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
|
|
319
319
|
|
|
320
320
|
Parameters for creating a wallet.
|
|
321
321
|
|
|
@@ -323,14 +323,14 @@ Parameters for creating a wallet.
|
|
|
323
323
|
|
|
324
324
|
| Property | Type | Description | Defined in |
|
|
325
325
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.13/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.13/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
|
|
328
328
|
|
|
329
329
|
***
|
|
330
330
|
|
|
331
331
|
#### CreateWalletResponse
|
|
332
332
|
|
|
333
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.
|
|
333
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
|
|
334
334
|
|
|
335
335
|
Response from creating a wallet.
|
|
336
336
|
|
|
@@ -338,16 +338,16 @@ Response from creating a wallet.
|
|
|
338
338
|
|
|
339
339
|
| Property | Type | Description | Defined in |
|
|
340
340
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.13/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.13/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.13/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.13/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
|
|
345
345
|
|
|
346
346
|
***
|
|
347
347
|
|
|
348
348
|
#### CreateWalletVerificationChallengeParameters
|
|
349
349
|
|
|
350
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.
|
|
350
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L7)
|
|
351
351
|
|
|
352
352
|
Parameters for creating wallet verification challenges.
|
|
353
353
|
|
|
@@ -355,14 +355,14 @@ Parameters for creating wallet verification challenges.
|
|
|
355
355
|
|
|
356
356
|
| Property | Type | Description | Defined in |
|
|
357
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.
|
|
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.
|
|
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.13/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.13/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L11) |
|
|
360
360
|
|
|
361
361
|
***
|
|
362
362
|
|
|
363
363
|
#### CreateWalletVerificationChallengesParameters
|
|
364
364
|
|
|
365
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.
|
|
365
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
|
|
366
366
|
|
|
367
367
|
Parameters for creating wallet verification challenges.
|
|
368
368
|
|
|
@@ -370,13 +370,13 @@ Parameters for creating wallet verification challenges.
|
|
|
370
370
|
|
|
371
371
|
| Property | Type | Description | Defined in |
|
|
372
372
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.13/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
|
|
374
374
|
|
|
375
375
|
***
|
|
376
376
|
|
|
377
377
|
#### CreateWalletVerificationParameters
|
|
378
378
|
|
|
379
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.
|
|
379
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
|
|
380
380
|
|
|
381
381
|
Parameters for creating a wallet verification.
|
|
382
382
|
|
|
@@ -384,14 +384,14 @@ Parameters for creating a wallet verification.
|
|
|
384
384
|
|
|
385
385
|
| Property | Type | Description | Defined in |
|
|
386
386
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.13/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.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
|
|
389
389
|
|
|
390
390
|
***
|
|
391
391
|
|
|
392
392
|
#### CreateWalletVerificationResponse
|
|
393
393
|
|
|
394
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.
|
|
394
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
|
|
395
395
|
|
|
396
396
|
Response from creating a wallet verification.
|
|
397
397
|
|
|
@@ -399,16 +399,16 @@ Response from creating a wallet verification.
|
|
|
399
399
|
|
|
400
400
|
| Property | Type | Description | Defined in |
|
|
401
401
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.13/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.13/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.13/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.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
|
|
406
406
|
|
|
407
407
|
***
|
|
408
408
|
|
|
409
409
|
#### DeleteWalletVerificationParameters
|
|
410
410
|
|
|
411
|
-
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
411
|
+
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
|
|
412
412
|
|
|
413
413
|
Parameters for deleting a wallet verification.
|
|
414
414
|
|
|
@@ -416,14 +416,14 @@ Parameters for deleting a wallet verification.
|
|
|
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 delete the verification. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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.
|
|
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.13/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.13/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
|
|
421
421
|
|
|
422
422
|
***
|
|
423
423
|
|
|
424
424
|
#### DeleteWalletVerificationResponse
|
|
425
425
|
|
|
426
|
-
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
426
|
+
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
|
|
427
427
|
|
|
428
428
|
Response from deleting a wallet verification.
|
|
429
429
|
|
|
@@ -431,13 +431,13 @@ Response from deleting a wallet verification.
|
|
|
431
431
|
|
|
432
432
|
| Property | Type | Description | Defined in |
|
|
433
433
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.13/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
|
|
435
435
|
|
|
436
436
|
***
|
|
437
437
|
|
|
438
438
|
#### GetWalletVerificationsParameters
|
|
439
439
|
|
|
440
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.
|
|
440
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
|
|
441
441
|
|
|
442
442
|
Parameters for getting wallet verifications.
|
|
443
443
|
|
|
@@ -445,13 +445,13 @@ Parameters for getting wallet verifications.
|
|
|
445
445
|
|
|
446
446
|
| Property | Type | Description | Defined in |
|
|
447
447
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.13/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
|
|
449
449
|
|
|
450
450
|
***
|
|
451
451
|
|
|
452
452
|
#### VerificationResult
|
|
453
453
|
|
|
454
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:38](https://github.com/settlemint/sdk/blob/v2.5.
|
|
454
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:38](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L38)
|
|
455
455
|
|
|
456
456
|
Result of a wallet verification challenge.
|
|
457
457
|
|
|
@@ -459,13 +459,13 @@ Result of a wallet verification challenge.
|
|
|
459
459
|
|
|
460
460
|
| Property | Type | Description | Defined in |
|
|
461
461
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.13/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L40) |
|
|
463
463
|
|
|
464
464
|
***
|
|
465
465
|
|
|
466
466
|
#### VerifyWalletVerificationChallengeParameters
|
|
467
467
|
|
|
468
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.
|
|
468
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28)
|
|
469
469
|
|
|
470
470
|
Parameters for verifying a wallet verification challenge.
|
|
471
471
|
|
|
@@ -473,14 +473,14 @@ Parameters for verifying a wallet verification challenge.
|
|
|
473
473
|
|
|
474
474
|
| Property | Type | Description | Defined in |
|
|
475
475
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.13/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.13/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L32) |
|
|
478
478
|
|
|
479
479
|
***
|
|
480
480
|
|
|
481
481
|
#### WalletInfo
|
|
482
482
|
|
|
483
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
483
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
|
|
484
484
|
|
|
485
485
|
Information about the wallet to be created.
|
|
486
486
|
|
|
@@ -488,13 +488,13 @@ Information about the wallet to be created.
|
|
|
488
488
|
|
|
489
489
|
| Property | Type | Description | Defined in |
|
|
490
490
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.13/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
|
|
492
492
|
|
|
493
493
|
***
|
|
494
494
|
|
|
495
495
|
#### WalletOTPVerificationInfo
|
|
496
496
|
|
|
497
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.
|
|
497
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
|
|
498
498
|
|
|
499
499
|
Information for One-Time Password (OTP) verification.
|
|
500
500
|
|
|
@@ -506,18 +506,18 @@ Information for One-Time Password (OTP) verification.
|
|
|
506
506
|
|
|
507
507
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
508
508
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.13/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.13/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.13/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.13/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.13/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.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
|
|
515
515
|
|
|
516
516
|
***
|
|
517
517
|
|
|
518
518
|
#### WalletPincodeVerificationInfo
|
|
519
519
|
|
|
520
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.
|
|
520
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
|
|
521
521
|
|
|
522
522
|
Information for PIN code verification.
|
|
523
523
|
|
|
@@ -529,15 +529,15 @@ Information for PIN code verification.
|
|
|
529
529
|
|
|
530
530
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
531
531
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.13/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.13/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.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
|
|
535
535
|
|
|
536
536
|
***
|
|
537
537
|
|
|
538
538
|
#### WalletSecretCodesVerificationInfo
|
|
539
539
|
|
|
540
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.
|
|
540
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
|
|
541
541
|
|
|
542
542
|
Information for secret recovery codes verification.
|
|
543
543
|
|
|
@@ -549,14 +549,14 @@ Information for secret recovery codes verification.
|
|
|
549
549
|
|
|
550
550
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
551
551
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.13/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.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
|
|
554
554
|
|
|
555
555
|
***
|
|
556
556
|
|
|
557
557
|
#### WalletVerification
|
|
558
558
|
|
|
559
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.
|
|
559
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
|
|
560
560
|
|
|
561
561
|
Represents a wallet verification.
|
|
562
562
|
|
|
@@ -564,15 +564,15 @@ Represents a wallet verification.
|
|
|
564
564
|
|
|
565
565
|
| Property | Type | Description | Defined in |
|
|
566
566
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.13/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.13/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.13/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
|
|
570
570
|
|
|
571
571
|
***
|
|
572
572
|
|
|
573
573
|
#### WalletVerificationChallenge\<ChallengeData\>
|
|
574
574
|
|
|
575
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
575
|
+
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts:6](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L6)
|
|
576
576
|
|
|
577
577
|
Represents a wallet verification challenge.
|
|
578
578
|
|
|
@@ -586,17 +586,17 @@ Represents a wallet verification challenge.
|
|
|
586
586
|
|
|
587
587
|
| Property | Type | Description | Defined in |
|
|
588
588
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.13/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.13/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.13/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.13/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.13/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L14) |
|
|
594
594
|
|
|
595
595
|
***
|
|
596
596
|
|
|
597
597
|
#### WalletVerificationChallengeData
|
|
598
598
|
|
|
599
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.
|
|
599
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L17)
|
|
600
600
|
|
|
601
601
|
Data specific to a wallet verification challenge.
|
|
602
602
|
|
|
@@ -604,16 +604,16 @@ Data specific to a wallet verification challenge.
|
|
|
604
604
|
|
|
605
605
|
| Property | Type | Description | Defined in |
|
|
606
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.13/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.13/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.13/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.13/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L25) |
|
|
611
611
|
|
|
612
612
|
***
|
|
613
613
|
|
|
614
614
|
#### WalletVerificationOptions
|
|
615
615
|
|
|
616
|
-
Defined in: [sdk/viem/src/viem.ts:248](https://github.com/settlemint/sdk/blob/v2.5.
|
|
616
|
+
Defined in: [sdk/viem/src/viem.ts:248](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/viem.ts#L248)
|
|
617
617
|
|
|
618
618
|
The options for the wallet client.
|
|
619
619
|
|
|
@@ -621,9 +621,9 @@ The options for the wallet client.
|
|
|
621
621
|
|
|
622
622
|
| Property | Type | Description | Defined in |
|
|
623
623
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.13/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.13/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.13/sdk/viem/src/viem.ts#L252) |
|
|
627
627
|
|
|
628
628
|
### Type Aliases
|
|
629
629
|
|
|
@@ -631,7 +631,7 @@ The options for the wallet client.
|
|
|
631
631
|
|
|
632
632
|
> **AddressOrObject**\<`Extra`\> = `string` \| `object` & `Extra`
|
|
633
633
|
|
|
634
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.
|
|
634
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L8)
|
|
635
635
|
|
|
636
636
|
Represents either a wallet address string or an object containing wallet address and optional verification ID.
|
|
637
637
|
|
|
@@ -647,7 +647,7 @@ Represents either a wallet address string or an object containing wallet address
|
|
|
647
647
|
|
|
648
648
|
> **AddressOrObjectWithChallengeId** = [`AddressOrObject`](#addressorobject-2) \| \{ `challengeId`: `string`; \}
|
|
649
649
|
|
|
650
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.
|
|
650
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L18)
|
|
651
651
|
|
|
652
652
|
Represents either a wallet address string, an object containing wallet address and optional verification ID or a challenge ID.
|
|
653
653
|
|
|
@@ -659,7 +659,7 @@ Represents either a wallet address string, an object containing wallet address a
|
|
|
659
659
|
|
|
660
660
|
| Name | Type | Description | Defined in |
|
|
661
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.
|
|
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.13/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L22) |
|
|
663
663
|
|
|
664
664
|
***
|
|
665
665
|
|
|
@@ -667,7 +667,7 @@ Represents either a wallet address string, an object containing wallet address a
|
|
|
667
667
|
|
|
668
668
|
> **ClientOptions** = `Omit`\<`z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
669
669
|
|
|
670
|
-
Defined in: [sdk/viem/src/viem.ts:163](https://github.com/settlemint/sdk/blob/v2.5.
|
|
670
|
+
Defined in: [sdk/viem/src/viem.ts:163](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/viem.ts#L163)
|
|
671
671
|
|
|
672
672
|
Type representing the validated client options.
|
|
673
673
|
|
|
@@ -675,7 +675,7 @@ Type representing the validated client options.
|
|
|
675
675
|
|
|
676
676
|
| Name | Type | Defined in |
|
|
677
677
|
| ------ | ------ | ------ |
|
|
678
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:164](https://github.com/settlemint/sdk/blob/v2.5.
|
|
678
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:164](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/viem.ts#L164) |
|
|
679
679
|
|
|
680
680
|
***
|
|
681
681
|
|
|
@@ -683,7 +683,7 @@ Type representing the validated client options.
|
|
|
683
683
|
|
|
684
684
|
> **CreateWalletVerificationChallengeResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)\<[`WalletVerificationChallengeData`](#walletverificationchallengedata)\>
|
|
685
685
|
|
|
686
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:31](https://github.com/settlemint/sdk/blob/v2.5.
|
|
686
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:31](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L31)
|
|
687
687
|
|
|
688
688
|
Response from creating wallet verification challenge.
|
|
689
689
|
|
|
@@ -693,7 +693,7 @@ Response from creating wallet verification challenge.
|
|
|
693
693
|
|
|
694
694
|
> **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)\<`Record`\<`string`, `string`\>\>[]
|
|
695
695
|
|
|
696
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
696
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
|
|
697
697
|
|
|
698
698
|
Response from creating wallet verification challenges.
|
|
699
699
|
|
|
@@ -703,7 +703,7 @@ Response from creating wallet verification challenges.
|
|
|
703
703
|
|
|
704
704
|
> **GetChainIdOptions** = `Omit`\<`z.infer`\<*typeof* [`GetChainIdOptionsSchema`](#getchainidoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
705
705
|
|
|
706
|
-
Defined in: [sdk/viem/src/viem.ts:413](https://github.com/settlemint/sdk/blob/v2.5.
|
|
706
|
+
Defined in: [sdk/viem/src/viem.ts:413](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/viem.ts#L413)
|
|
707
707
|
|
|
708
708
|
Type representing the validated get chain id options.
|
|
709
709
|
|
|
@@ -711,7 +711,7 @@ Type representing the validated get chain id options.
|
|
|
711
711
|
|
|
712
712
|
| Name | Type | Defined in |
|
|
713
713
|
| ------ | ------ | ------ |
|
|
714
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:414](https://github.com/settlemint/sdk/blob/v2.5.
|
|
714
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:414](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/viem.ts#L414) |
|
|
715
715
|
|
|
716
716
|
***
|
|
717
717
|
|
|
@@ -719,7 +719,7 @@ Type representing the validated get chain id options.
|
|
|
719
719
|
|
|
720
720
|
> **GetWalletVerificationsResponse** = [`WalletVerification`](#walletverification)[]
|
|
721
721
|
|
|
722
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.
|
|
722
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
|
|
723
723
|
|
|
724
724
|
Response from getting wallet verifications.
|
|
725
725
|
|
|
@@ -729,7 +729,7 @@ Response from getting wallet verifications.
|
|
|
729
729
|
|
|
730
730
|
> **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
|
|
731
731
|
|
|
732
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:46](https://github.com/settlemint/sdk/blob/v2.5.
|
|
732
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:46](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L46)
|
|
733
733
|
|
|
734
734
|
Response from verifying a wallet verification challenge.
|
|
735
735
|
|
|
@@ -739,7 +739,7 @@ Response from verifying a wallet verification challenge.
|
|
|
739
739
|
|
|
740
740
|
> **WalletVerificationInfo** = [`WalletPincodeVerificationInfo`](#walletpincodeverificationinfo) \| [`WalletOTPVerificationInfo`](#walletotpverificationinfo) \| [`WalletSecretCodesVerificationInfo`](#walletsecretcodesverificationinfo)
|
|
741
741
|
|
|
742
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.
|
|
742
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
|
|
743
743
|
|
|
744
744
|
Union type of all possible wallet verification information types.
|
|
745
745
|
|
|
@@ -749,7 +749,7 @@ Union type of all possible wallet verification information types.
|
|
|
749
749
|
|
|
750
750
|
> `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
751
751
|
|
|
752
|
-
Defined in: [sdk/viem/src/viem.ts:137](https://github.com/settlemint/sdk/blob/v2.5.
|
|
752
|
+
Defined in: [sdk/viem/src/viem.ts:137](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/viem.ts#L137)
|
|
753
753
|
|
|
754
754
|
Schema for the viem client options.
|
|
755
755
|
|
|
@@ -759,7 +759,7 @@ Schema for the viem client options.
|
|
|
759
759
|
|
|
760
760
|
> `const` **GetChainIdOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
761
761
|
|
|
762
|
-
Defined in: [sdk/viem/src/viem.ts:395](https://github.com/settlemint/sdk/blob/v2.5.
|
|
762
|
+
Defined in: [sdk/viem/src/viem.ts:395](https://github.com/settlemint/sdk/blob/v2.5.13/sdk/viem/src/viem.ts#L395)
|
|
763
763
|
|
|
764
764
|
Schema for the viem client options.
|
|
765
765
|
|
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.13",
|
|
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.13",
|
|
57
57
|
"viem": "^2",
|
|
58
58
|
"zod": "^4"
|
|
59
59
|
},
|