@settlemint/sdk-viem 2.5.11-pr0988a19d → 2.5.11-pr12260624
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 +108 -40
- package/dist/browser/viem.d.ts +3943 -307
- package/dist/browser/viem.js +19 -18
- package/dist/browser/viem.js.map +1 -1
- package/dist/viem.cjs +19 -18
- package/dist/viem.cjs.map +1 -1
- package/dist/viem.d.cts +3943 -307
- package/dist/viem.d.ts +3943 -307
- package/dist/viem.js +19 -18
- package/dist/viem.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -38,6 +38,7 @@
|
|
|
38
38
|
- [Interfaces](#interfaces)
|
|
39
39
|
- [CreateWalletParameters](#createwalletparameters)
|
|
40
40
|
- [CreateWalletResponse](#createwalletresponse)
|
|
41
|
+
- [CreateWalletVerificationChallengeParameters](#createwalletverificationchallengeparameters)
|
|
41
42
|
- [CreateWalletVerificationChallengesParameters](#createwalletverificationchallengesparameters)
|
|
42
43
|
- [CreateWalletVerificationParameters](#createwalletverificationparameters)
|
|
43
44
|
- [CreateWalletVerificationResponse](#createwalletverificationresponse)
|
|
@@ -51,11 +52,13 @@
|
|
|
51
52
|
- [WalletPincodeVerificationInfo](#walletpincodeverificationinfo)
|
|
52
53
|
- [WalletSecretCodesVerificationInfo](#walletsecretcodesverificationinfo)
|
|
53
54
|
- [WalletVerification](#walletverification)
|
|
54
|
-
- [WalletVerificationChallenge](#
|
|
55
|
+
- [WalletVerificationChallenge\<ChallengeData\>](#walletverificationchallengechallengedata)
|
|
56
|
+
- [WalletVerificationChallengeData](#walletverificationchallengedata)
|
|
55
57
|
- [WalletVerificationOptions](#walletverificationoptions)
|
|
56
58
|
- [Type Aliases](#type-aliases)
|
|
57
|
-
- [AddressOrObject](#
|
|
59
|
+
- [AddressOrObject\<Extra\>](#addressorobjectextra)
|
|
58
60
|
- [ClientOptions](#clientoptions)
|
|
61
|
+
- [CreateWalletVerificationChallengeResponse](#createwalletverificationchallengeresponse)
|
|
59
62
|
- [CreateWalletVerificationChallengesResponse](#createwalletverificationchallengesresponse)
|
|
60
63
|
- [GetChainIdOptions](#getchainidoptions)
|
|
61
64
|
- [GetWalletVerificationsResponse](#getwalletverificationsresponse)
|
|
@@ -79,7 +82,7 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
|
|
|
79
82
|
|
|
80
83
|
> **getChainId**(`options`): `Promise`\<`number`\>
|
|
81
84
|
|
|
82
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
85
|
+
Defined in: [sdk/viem/src/viem.ts:494](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L494)
|
|
83
86
|
|
|
84
87
|
Discovers the chain ID from an RPC endpoint without requiring prior knowledge.
|
|
85
88
|
|
|
@@ -132,7 +135,7 @@ console.log(chainId);
|
|
|
132
135
|
|
|
133
136
|
> **getPublicClient**(`options`): \{ \} \| \{ \}
|
|
134
137
|
|
|
135
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
138
|
+
Defined in: [sdk/viem/src/viem.ts:249](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L249)
|
|
136
139
|
|
|
137
140
|
Creates an optimized public client for blockchain read operations.
|
|
138
141
|
|
|
@@ -188,9 +191,9 @@ console.log(block);
|
|
|
188
191
|
|
|
189
192
|
#### getWalletClient()
|
|
190
193
|
|
|
191
|
-
> **getWalletClient**(`options`): `
|
|
194
|
+
> **getWalletClient**(`options`): (`verificationOptions?`) => `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
|
|
192
195
|
|
|
193
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
196
|
+
Defined in: [sdk/viem/src/viem.ts:363](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L363)
|
|
194
197
|
|
|
195
198
|
Creates a factory function for wallet clients with runtime verification support.
|
|
196
199
|
|
|
@@ -202,10 +205,20 @@ Creates a factory function for wallet clients with runtime verification support.
|
|
|
202
205
|
|
|
203
206
|
##### Returns
|
|
204
207
|
|
|
205
|
-
`any`
|
|
206
|
-
|
|
207
208
|
Factory function that accepts runtime verification options
|
|
208
209
|
|
|
210
|
+
> (`verificationOptions?`): `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
|
|
211
|
+
|
|
212
|
+
###### Parameters
|
|
213
|
+
|
|
214
|
+
| Parameter | Type |
|
|
215
|
+
| ------ | ------ |
|
|
216
|
+
| `verificationOptions?` | [`WalletVerificationOptions`](#walletverificationoptions) |
|
|
217
|
+
|
|
218
|
+
###### Returns
|
|
219
|
+
|
|
220
|
+
`Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
|
|
221
|
+
|
|
209
222
|
##### Remarks
|
|
210
223
|
|
|
211
224
|
DESIGN PATTERN: Returns a factory function rather than a client instance because
|
|
@@ -331,6 +344,21 @@ Response from creating a wallet.
|
|
|
331
344
|
|
|
332
345
|
***
|
|
333
346
|
|
|
347
|
+
#### CreateWalletVerificationChallengeParameters
|
|
348
|
+
|
|
349
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L7)
|
|
350
|
+
|
|
351
|
+
Parameters for creating wallet verification challenges.
|
|
352
|
+
|
|
353
|
+
##### Properties
|
|
354
|
+
|
|
355
|
+
| Property | Type | Description | Defined in |
|
|
356
|
+
| ------ | ------ | ------ | ------ |
|
|
357
|
+
| <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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L9) |
|
|
358
|
+
| <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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L11) |
|
|
359
|
+
|
|
360
|
+
***
|
|
361
|
+
|
|
334
362
|
#### CreateWalletVerificationChallengesParameters
|
|
335
363
|
|
|
336
364
|
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)
|
|
@@ -341,7 +369,7 @@ Parameters for creating wallet verification challenges.
|
|
|
341
369
|
|
|
342
370
|
| Property | Type | Description | Defined in |
|
|
343
371
|
| ------ | ------ | ------ | ------ |
|
|
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) |
|
|
372
|
+
| <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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
|
|
345
373
|
|
|
346
374
|
***
|
|
347
375
|
|
|
@@ -355,7 +383,7 @@ Parameters for creating a wallet verification.
|
|
|
355
383
|
|
|
356
384
|
| Property | Type | Description | Defined in |
|
|
357
385
|
| ------ | ------ | ------ | ------ |
|
|
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) |
|
|
386
|
+
| <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.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
|
|
359
387
|
| <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
388
|
|
|
361
389
|
***
|
|
@@ -387,8 +415,8 @@ Parameters for deleting a wallet verification.
|
|
|
387
415
|
|
|
388
416
|
| Property | Type | Description | Defined in |
|
|
389
417
|
| ------ | ------ | ------ | ------ |
|
|
390
|
-
| <a id="userwalletaddress-
|
|
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) |
|
|
418
|
+
| <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.11/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L8) |
|
|
419
|
+
| <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.11/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
|
|
392
420
|
|
|
393
421
|
***
|
|
394
422
|
|
|
@@ -416,13 +444,13 @@ Parameters for getting wallet verifications.
|
|
|
416
444
|
|
|
417
445
|
| Property | Type | Description | Defined in |
|
|
418
446
|
| ------ | ------ | ------ | ------ |
|
|
419
|
-
| <a id="userwalletaddress-
|
|
447
|
+
| <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.11/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
|
|
420
448
|
|
|
421
449
|
***
|
|
422
450
|
|
|
423
451
|
#### VerificationResult
|
|
424
452
|
|
|
425
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
453
|
+
Defined in: [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)
|
|
426
454
|
|
|
427
455
|
Result of a wallet verification challenge.
|
|
428
456
|
|
|
@@ -430,13 +458,13 @@ Result of a wallet verification challenge.
|
|
|
430
458
|
|
|
431
459
|
| Property | Type | Description | Defined in |
|
|
432
460
|
| ------ | ------ | ------ | ------ |
|
|
433
|
-
| <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
461
|
+
| <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L30) |
|
|
434
462
|
|
|
435
463
|
***
|
|
436
464
|
|
|
437
465
|
#### VerifyWalletVerificationChallengeParameters
|
|
438
466
|
|
|
439
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
467
|
+
Defined in: [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)
|
|
440
468
|
|
|
441
469
|
Parameters for verifying a wallet verification challenge.
|
|
442
470
|
|
|
@@ -444,8 +472,8 @@ Parameters for verifying a wallet verification challenge.
|
|
|
444
472
|
|
|
445
473
|
| Property | Type | Description | Defined in |
|
|
446
474
|
| ------ | ------ | ------ | ------ |
|
|
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:
|
|
448
|
-
| <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
475
|
+
| <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:20](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L20) |
|
|
476
|
+
| <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:22](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L22) |
|
|
449
477
|
|
|
450
478
|
***
|
|
451
479
|
|
|
@@ -541,26 +569,50 @@ Represents a wallet verification.
|
|
|
541
569
|
|
|
542
570
|
***
|
|
543
571
|
|
|
544
|
-
#### WalletVerificationChallenge
|
|
572
|
+
#### WalletVerificationChallenge\<ChallengeData\>
|
|
545
573
|
|
|
546
|
-
Defined in: [sdk/viem/src/custom-actions/
|
|
574
|
+
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts:6](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L6)
|
|
547
575
|
|
|
548
576
|
Represents a wallet verification challenge.
|
|
549
577
|
|
|
578
|
+
##### Type Parameters
|
|
579
|
+
|
|
580
|
+
| Type Parameter |
|
|
581
|
+
| ------ |
|
|
582
|
+
| `ChallengeData` |
|
|
583
|
+
|
|
550
584
|
##### Properties
|
|
551
585
|
|
|
552
586
|
| Property | Type | Description | Defined in |
|
|
553
587
|
| ------ | ------ | ------ | ------ |
|
|
554
|
-
| <a id="challenge"></a> `challenge` | `
|
|
555
|
-
| <a id="id-3"></a> `id` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/
|
|
556
|
-
| <a id="name-7"></a> `name` | `string` | The name of the challenge. | [sdk/viem/src/custom-actions/
|
|
557
|
-
| <a id="
|
|
588
|
+
| <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.11/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L16) |
|
|
589
|
+
| <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.11/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L8) |
|
|
590
|
+
| <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.11/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L10) |
|
|
591
|
+
| <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.11/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L12) |
|
|
592
|
+
| <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.11/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L14) |
|
|
593
|
+
|
|
594
|
+
***
|
|
595
|
+
|
|
596
|
+
#### WalletVerificationChallengeData
|
|
597
|
+
|
|
598
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L17)
|
|
599
|
+
|
|
600
|
+
Data specific to a wallet verification challenge.
|
|
601
|
+
|
|
602
|
+
##### Properties
|
|
603
|
+
|
|
604
|
+
| Property | Type | Description | Defined in |
|
|
605
|
+
| ------ | ------ | ------ | ------ |
|
|
606
|
+
| <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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L21) |
|
|
607
|
+
| <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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L19) |
|
|
608
|
+
| <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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L23) |
|
|
609
|
+
| <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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L25) |
|
|
558
610
|
|
|
559
611
|
***
|
|
560
612
|
|
|
561
613
|
#### WalletVerificationOptions
|
|
562
614
|
|
|
563
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
615
|
+
Defined in: [sdk/viem/src/viem.ts:296](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L296)
|
|
564
616
|
|
|
565
617
|
The options for the wallet client.
|
|
566
618
|
|
|
@@ -568,27 +620,33 @@ The options for the wallet client.
|
|
|
568
620
|
|
|
569
621
|
| Property | Type | Description | Defined in |
|
|
570
622
|
| ------ | ------ | ------ | ------ |
|
|
571
|
-
| <a id="challengeid"></a> `challengeId?` | `string` | The challenge id (used for HD wallets) | [sdk/viem/src/viem.ts:
|
|
572
|
-
| <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:
|
|
573
|
-
| <a id="verificationid-
|
|
623
|
+
| <a id="challengeid-1"></a> `challengeId?` | `string` | The challenge id (used for HD wallets) | [sdk/viem/src/viem.ts:304](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L304) |
|
|
624
|
+
| <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:308](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L308) |
|
|
625
|
+
| <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:300](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L300) |
|
|
574
626
|
|
|
575
627
|
### Type Aliases
|
|
576
628
|
|
|
577
|
-
#### AddressOrObject
|
|
629
|
+
#### AddressOrObject\<Extra\>
|
|
578
630
|
|
|
579
|
-
> **AddressOrObject
|
|
631
|
+
> **AddressOrObject**\<`Extra`\> = `string` \| `object` & `Extra`
|
|
580
632
|
|
|
581
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
633
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L8)
|
|
582
634
|
|
|
583
635
|
Represents either a wallet address string or an object containing wallet address and optional verification ID.
|
|
584
636
|
|
|
637
|
+
##### Type Parameters
|
|
638
|
+
|
|
639
|
+
| Type Parameter | Default type |
|
|
640
|
+
| ------ | ------ |
|
|
641
|
+
| `Extra` | `object` |
|
|
642
|
+
|
|
585
643
|
***
|
|
586
644
|
|
|
587
645
|
#### ClientOptions
|
|
588
646
|
|
|
589
647
|
> **ClientOptions** = `Omit`\<`z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
590
648
|
|
|
591
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
649
|
+
Defined in: [sdk/viem/src/viem.ts:211](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L211)
|
|
592
650
|
|
|
593
651
|
Type representing the validated client options.
|
|
594
652
|
|
|
@@ -596,15 +654,25 @@ Type representing the validated client options.
|
|
|
596
654
|
|
|
597
655
|
| Name | Type | Defined in |
|
|
598
656
|
| ------ | ------ | ------ |
|
|
599
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:
|
|
657
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:212](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L212) |
|
|
658
|
+
|
|
659
|
+
***
|
|
660
|
+
|
|
661
|
+
#### CreateWalletVerificationChallengeResponse
|
|
662
|
+
|
|
663
|
+
> **CreateWalletVerificationChallengeResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)\<[`WalletVerificationChallengeData`](#walletverificationchallengedata)\>
|
|
664
|
+
|
|
665
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:31](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L31)
|
|
666
|
+
|
|
667
|
+
Response from creating wallet verification challenge.
|
|
600
668
|
|
|
601
669
|
***
|
|
602
670
|
|
|
603
671
|
#### CreateWalletVerificationChallengesResponse
|
|
604
672
|
|
|
605
|
-
> **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)[]
|
|
673
|
+
> **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)\<`Record`\<`string`, `string`\>\>[]
|
|
606
674
|
|
|
607
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:
|
|
675
|
+
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)
|
|
608
676
|
|
|
609
677
|
Response from creating wallet verification challenges.
|
|
610
678
|
|
|
@@ -614,7 +682,7 @@ Response from creating wallet verification challenges.
|
|
|
614
682
|
|
|
615
683
|
> **GetChainIdOptions** = `Omit`\<`z.infer`\<*typeof* [`GetChainIdOptionsSchema`](#getchainidoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
616
684
|
|
|
617
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
685
|
+
Defined in: [sdk/viem/src/viem.ts:461](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L461)
|
|
618
686
|
|
|
619
687
|
Type representing the validated get chain id options.
|
|
620
688
|
|
|
@@ -622,7 +690,7 @@ Type representing the validated get chain id options.
|
|
|
622
690
|
|
|
623
691
|
| Name | Type | Defined in |
|
|
624
692
|
| ------ | ------ | ------ |
|
|
625
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:
|
|
693
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:462](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L462) |
|
|
626
694
|
|
|
627
695
|
***
|
|
628
696
|
|
|
@@ -640,7 +708,7 @@ Response from getting wallet verifications.
|
|
|
640
708
|
|
|
641
709
|
> **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
|
|
642
710
|
|
|
643
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
711
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:36](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L36)
|
|
644
712
|
|
|
645
713
|
Response from verifying a wallet verification challenge.
|
|
646
714
|
|
|
@@ -660,7 +728,7 @@ Union type of all possible wallet verification information types.
|
|
|
660
728
|
|
|
661
729
|
> `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
662
730
|
|
|
663
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
731
|
+
Defined in: [sdk/viem/src/viem.ts:185](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L185)
|
|
664
732
|
|
|
665
733
|
Schema for the viem client options.
|
|
666
734
|
|
|
@@ -670,7 +738,7 @@ Schema for the viem client options.
|
|
|
670
738
|
|
|
671
739
|
> `const` **GetChainIdOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
672
740
|
|
|
673
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
741
|
+
Defined in: [sdk/viem/src/viem.ts:443](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L443)
|
|
674
742
|
|
|
675
743
|
Schema for the viem client options.
|
|
676
744
|
|