@settlemint/sdk-viem 2.5.11-prd7e167ef → 2.5.11-pref0571c5
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 +129 -40
- package/dist/browser/viem.d.ts +3951 -308
- package/dist/browser/viem.js +60 -56
- package/dist/browser/viem.js.map +1 -1
- package/dist/viem.cjs +60 -56
- package/dist/viem.cjs.map +1 -1
- package/dist/viem.d.cts +3951 -308
- package/dist/viem.d.ts +3951 -308
- package/dist/viem.js +60 -56
- 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,14 @@
|
|
|
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)
|
|
60
|
+
- [AddressOrObjectWithChallengeId](#addressorobjectwithchallengeid)
|
|
58
61
|
- [ClientOptions](#clientoptions)
|
|
62
|
+
- [CreateWalletVerificationChallengeResponse](#createwalletverificationchallengeresponse)
|
|
59
63
|
- [CreateWalletVerificationChallengesResponse](#createwalletverificationchallengesresponse)
|
|
60
64
|
- [GetChainIdOptions](#getchainidoptions)
|
|
61
65
|
- [GetWalletVerificationsResponse](#getwalletverificationsresponse)
|
|
@@ -79,7 +83,7 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
|
|
|
79
83
|
|
|
80
84
|
> **getChainId**(`options`): `Promise`\<`number`\>
|
|
81
85
|
|
|
82
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
86
|
+
Defined in: [sdk/viem/src/viem.ts:446](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L446)
|
|
83
87
|
|
|
84
88
|
Discovers the chain ID from an RPC endpoint without requiring prior knowledge.
|
|
85
89
|
|
|
@@ -132,7 +136,7 @@ console.log(chainId);
|
|
|
132
136
|
|
|
133
137
|
> **getPublicClient**(`options`): \{ \} \| \{ \}
|
|
134
138
|
|
|
135
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
139
|
+
Defined in: [sdk/viem/src/viem.ts:201](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L201)
|
|
136
140
|
|
|
137
141
|
Creates an optimized public client for blockchain read operations.
|
|
138
142
|
|
|
@@ -188,9 +192,9 @@ console.log(block);
|
|
|
188
192
|
|
|
189
193
|
#### getWalletClient()
|
|
190
194
|
|
|
191
|
-
> **getWalletClient**(`options`): `
|
|
195
|
+
> **getWalletClient**(`options`): (`verificationOptions?`) => `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
|
|
192
196
|
|
|
193
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
197
|
+
Defined in: [sdk/viem/src/viem.ts:315](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L315)
|
|
194
198
|
|
|
195
199
|
Creates a factory function for wallet clients with runtime verification support.
|
|
196
200
|
|
|
@@ -202,10 +206,20 @@ Creates a factory function for wallet clients with runtime verification support.
|
|
|
202
206
|
|
|
203
207
|
##### Returns
|
|
204
208
|
|
|
205
|
-
`any`
|
|
206
|
-
|
|
207
209
|
Factory function that accepts runtime verification options
|
|
208
210
|
|
|
211
|
+
> (`verificationOptions?`): `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
|
|
212
|
+
|
|
213
|
+
###### Parameters
|
|
214
|
+
|
|
215
|
+
| Parameter | Type |
|
|
216
|
+
| ------ | ------ |
|
|
217
|
+
| `verificationOptions?` | [`WalletVerificationOptions`](#walletverificationoptions) |
|
|
218
|
+
|
|
219
|
+
###### Returns
|
|
220
|
+
|
|
221
|
+
`Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
|
|
222
|
+
|
|
209
223
|
##### Remarks
|
|
210
224
|
|
|
211
225
|
DESIGN PATTERN: Returns a factory function rather than a client instance because
|
|
@@ -331,6 +345,21 @@ Response from creating a wallet.
|
|
|
331
345
|
|
|
332
346
|
***
|
|
333
347
|
|
|
348
|
+
#### CreateWalletVerificationChallengeParameters
|
|
349
|
+
|
|
350
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L7)
|
|
351
|
+
|
|
352
|
+
Parameters for creating wallet verification challenges.
|
|
353
|
+
|
|
354
|
+
##### Properties
|
|
355
|
+
|
|
356
|
+
| Property | Type | Description | Defined in |
|
|
357
|
+
| ------ | ------ | ------ | ------ |
|
|
358
|
+
| <a id="userwalletaddress"></a> `userWalletAddress` | `string` | The wallet address. | [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.11/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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L11) |
|
|
360
|
+
|
|
361
|
+
***
|
|
362
|
+
|
|
334
363
|
#### CreateWalletVerificationChallengesParameters
|
|
335
364
|
|
|
336
365
|
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 +370,7 @@ Parameters for creating wallet verification challenges.
|
|
|
341
370
|
|
|
342
371
|
| Property | Type | Description | Defined in |
|
|
343
372
|
| ------ | ------ | ------ | ------ |
|
|
344
|
-
| <a id="addressorobject"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:10](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
|
|
373
|
+
| <a id="addressorobject"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2)\<\{ `amount?`: `number`; \}\> | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:10](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
|
|
345
374
|
|
|
346
375
|
***
|
|
347
376
|
|
|
@@ -355,7 +384,7 @@ Parameters for creating a wallet verification.
|
|
|
355
384
|
|
|
356
385
|
| Property | Type | Description | Defined in |
|
|
357
386
|
| ------ | ------ | ------ | ------ |
|
|
358
|
-
| <a id="userwalletaddress"></a> `userWalletAddress` | `string` | The wallet address for which to create the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:61](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
|
|
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.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
|
|
359
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.11/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
|
|
360
389
|
|
|
361
390
|
***
|
|
@@ -387,8 +416,8 @@ Parameters for deleting a wallet verification.
|
|
|
387
416
|
|
|
388
417
|
| Property | Type | Description | Defined in |
|
|
389
418
|
| ------ | ------ | ------ | ------ |
|
|
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) |
|
|
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.11/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.11/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
|
|
392
421
|
|
|
393
422
|
***
|
|
394
423
|
|
|
@@ -416,13 +445,13 @@ Parameters for getting wallet verifications.
|
|
|
416
445
|
|
|
417
446
|
| Property | Type | Description | Defined in |
|
|
418
447
|
| ------ | ------ | ------ | ------ |
|
|
419
|
-
| <a id="userwalletaddress-
|
|
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.11/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
|
|
420
449
|
|
|
421
450
|
***
|
|
422
451
|
|
|
423
452
|
#### VerificationResult
|
|
424
453
|
|
|
425
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
454
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:38](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L38)
|
|
426
455
|
|
|
427
456
|
Result of a wallet verification challenge.
|
|
428
457
|
|
|
@@ -430,13 +459,13 @@ Result of a wallet verification challenge.
|
|
|
430
459
|
|
|
431
460
|
| Property | Type | Description | Defined in |
|
|
432
461
|
| ------ | ------ | ------ | ------ |
|
|
433
|
-
| <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
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.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L40) |
|
|
434
463
|
|
|
435
464
|
***
|
|
436
465
|
|
|
437
466
|
#### VerifyWalletVerificationChallengeParameters
|
|
438
467
|
|
|
439
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
468
|
+
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)
|
|
440
469
|
|
|
441
470
|
Parameters for verifying a wallet verification challenge.
|
|
442
471
|
|
|
@@ -444,8 +473,8 @@ Parameters for verifying a wallet verification challenge.
|
|
|
444
473
|
|
|
445
474
|
| Property | Type | Description | Defined in |
|
|
446
475
|
| ------ | ------ | ------ | ------ |
|
|
447
|
-
| <a id="addressorobject-1"></a> `addressOrObject` | [`
|
|
448
|
-
| <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
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.11/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.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L32) |
|
|
449
478
|
|
|
450
479
|
***
|
|
451
480
|
|
|
@@ -541,26 +570,50 @@ Represents a wallet verification.
|
|
|
541
570
|
|
|
542
571
|
***
|
|
543
572
|
|
|
544
|
-
#### WalletVerificationChallenge
|
|
573
|
+
#### WalletVerificationChallenge\<ChallengeData\>
|
|
545
574
|
|
|
546
|
-
Defined in: [sdk/viem/src/custom-actions/
|
|
575
|
+
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
576
|
|
|
548
577
|
Represents a wallet verification challenge.
|
|
549
578
|
|
|
579
|
+
##### Type Parameters
|
|
580
|
+
|
|
581
|
+
| Type Parameter |
|
|
582
|
+
| ------ |
|
|
583
|
+
| `ChallengeData` |
|
|
584
|
+
|
|
550
585
|
##### Properties
|
|
551
586
|
|
|
552
587
|
| Property | Type | Description | Defined in |
|
|
553
588
|
| ------ | ------ | ------ | ------ |
|
|
554
|
-
| <a id="challenge"></a> `challenge` | `
|
|
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="
|
|
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.11/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.11/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.11/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.11/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.11/sdk/viem/src/custom-actions/types/wallet-verification-challenge.ts#L14) |
|
|
594
|
+
|
|
595
|
+
***
|
|
596
|
+
|
|
597
|
+
#### WalletVerificationChallengeData
|
|
598
|
+
|
|
599
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L17)
|
|
600
|
+
|
|
601
|
+
Data specific to a wallet verification challenge.
|
|
602
|
+
|
|
603
|
+
##### Properties
|
|
604
|
+
|
|
605
|
+
| Property | Type | Description | Defined in |
|
|
606
|
+
| ------ | ------ | ------ | ------ |
|
|
607
|
+
| <a id="challengeid"></a> `challengeId` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:21](https://github.com/settlemint/sdk/blob/v2.5.11/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.11/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.11/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.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L25) |
|
|
558
611
|
|
|
559
612
|
***
|
|
560
613
|
|
|
561
614
|
#### WalletVerificationOptions
|
|
562
615
|
|
|
563
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
616
|
+
Defined in: [sdk/viem/src/viem.ts:248](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L248)
|
|
564
617
|
|
|
565
618
|
The options for the wallet client.
|
|
566
619
|
|
|
@@ -568,27 +621,53 @@ The options for the wallet client.
|
|
|
568
621
|
|
|
569
622
|
| Property | Type | Description | Defined in |
|
|
570
623
|
| ------ | ------ | ------ | ------ |
|
|
571
|
-
| <a id="challengeid"></a> `challengeId?` | `string` | The challenge id (used for HD wallets) | [sdk/viem/src/viem.ts:
|
|
572
|
-
| <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:
|
|
573
|
-
| <a id="verificationid-
|
|
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.11/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.11/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.11/sdk/viem/src/viem.ts#L252) |
|
|
574
627
|
|
|
575
628
|
### Type Aliases
|
|
576
629
|
|
|
577
|
-
#### AddressOrObject
|
|
630
|
+
#### AddressOrObject\<Extra\>
|
|
578
631
|
|
|
579
|
-
> **AddressOrObject
|
|
632
|
+
> **AddressOrObject**\<`Extra`\> = `string` \| `object` & `Extra`
|
|
580
633
|
|
|
581
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
634
|
+
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
635
|
|
|
583
636
|
Represents either a wallet address string or an object containing wallet address and optional verification ID.
|
|
584
637
|
|
|
638
|
+
##### Type Parameters
|
|
639
|
+
|
|
640
|
+
| Type Parameter | Default type |
|
|
641
|
+
| ------ | ------ |
|
|
642
|
+
| `Extra` | `object` |
|
|
643
|
+
|
|
644
|
+
***
|
|
645
|
+
|
|
646
|
+
#### AddressOrObjectWithChallengeId
|
|
647
|
+
|
|
648
|
+
> **AddressOrObjectWithChallengeId** = [`AddressOrObject`](#addressorobject-2) \| \{ `challengeId`: `string`; \}
|
|
649
|
+
|
|
650
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L18)
|
|
651
|
+
|
|
652
|
+
Represents either a wallet address string, an object containing wallet address and optional verification ID or a challenge ID.
|
|
653
|
+
|
|
654
|
+
##### Type declaration
|
|
655
|
+
|
|
656
|
+
[`AddressOrObject`](#addressorobject-2)
|
|
657
|
+
|
|
658
|
+
\{ `challengeId`: `string`; \}
|
|
659
|
+
|
|
660
|
+
| Name | Type | Description | Defined in |
|
|
661
|
+
| ------ | ------ | ------ | ------ |
|
|
662
|
+
| `challengeId` | `string` | ID of the challenge to verify against | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:22](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L22) |
|
|
663
|
+
|
|
585
664
|
***
|
|
586
665
|
|
|
587
666
|
#### ClientOptions
|
|
588
667
|
|
|
589
668
|
> **ClientOptions** = `Omit`\<`z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
590
669
|
|
|
591
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
670
|
+
Defined in: [sdk/viem/src/viem.ts:163](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L163)
|
|
592
671
|
|
|
593
672
|
Type representing the validated client options.
|
|
594
673
|
|
|
@@ -596,15 +675,25 @@ Type representing the validated client options.
|
|
|
596
675
|
|
|
597
676
|
| Name | Type | Defined in |
|
|
598
677
|
| ------ | ------ | ------ |
|
|
599
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:
|
|
678
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:164](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L164) |
|
|
679
|
+
|
|
680
|
+
***
|
|
681
|
+
|
|
682
|
+
#### CreateWalletVerificationChallengeResponse
|
|
683
|
+
|
|
684
|
+
> **CreateWalletVerificationChallengeResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)\<[`WalletVerificationChallengeData`](#walletverificationchallengedata)\>
|
|
685
|
+
|
|
686
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:31](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts#L31)
|
|
687
|
+
|
|
688
|
+
Response from creating wallet verification challenge.
|
|
600
689
|
|
|
601
690
|
***
|
|
602
691
|
|
|
603
692
|
#### CreateWalletVerificationChallengesResponse
|
|
604
693
|
|
|
605
|
-
> **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)[]
|
|
694
|
+
> **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)\<`Record`\<`string`, `string`\>\>[]
|
|
606
695
|
|
|
607
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:
|
|
696
|
+
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
697
|
|
|
609
698
|
Response from creating wallet verification challenges.
|
|
610
699
|
|
|
@@ -614,7 +703,7 @@ Response from creating wallet verification challenges.
|
|
|
614
703
|
|
|
615
704
|
> **GetChainIdOptions** = `Omit`\<`z.infer`\<*typeof* [`GetChainIdOptionsSchema`](#getchainidoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
616
705
|
|
|
617
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
706
|
+
Defined in: [sdk/viem/src/viem.ts:413](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L413)
|
|
618
707
|
|
|
619
708
|
Type representing the validated get chain id options.
|
|
620
709
|
|
|
@@ -622,7 +711,7 @@ Type representing the validated get chain id options.
|
|
|
622
711
|
|
|
623
712
|
| Name | Type | Defined in |
|
|
624
713
|
| ------ | ------ | ------ |
|
|
625
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:
|
|
714
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:414](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L414) |
|
|
626
715
|
|
|
627
716
|
***
|
|
628
717
|
|
|
@@ -640,7 +729,7 @@ Response from getting wallet verifications.
|
|
|
640
729
|
|
|
641
730
|
> **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
|
|
642
731
|
|
|
643
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:
|
|
732
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:46](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L46)
|
|
644
733
|
|
|
645
734
|
Response from verifying a wallet verification challenge.
|
|
646
735
|
|
|
@@ -660,7 +749,7 @@ Union type of all possible wallet verification information types.
|
|
|
660
749
|
|
|
661
750
|
> `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
662
751
|
|
|
663
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
752
|
+
Defined in: [sdk/viem/src/viem.ts:137](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L137)
|
|
664
753
|
|
|
665
754
|
Schema for the viem client options.
|
|
666
755
|
|
|
@@ -670,7 +759,7 @@ Schema for the viem client options.
|
|
|
670
759
|
|
|
671
760
|
> `const` **GetChainIdOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
672
761
|
|
|
673
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
762
|
+
Defined in: [sdk/viem/src/viem.ts:395](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/viem/src/viem.ts#L395)
|
|
674
763
|
|
|
675
764
|
Schema for the viem client options.
|
|
676
765
|
|