@settlemint/sdk-viem 2.1.5 → 2.2.0-pr26d1316a
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 +361 -36
- package/dist/viem.cjs +1 -1
- package/dist/viem.cjs.map +1 -1
- package/dist/viem.d.cts +312 -32
- package/dist/viem.d.ts +312 -32
- package/dist/viem.mjs +1 -1
- package/dist/viem.mjs.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -36,7 +36,29 @@
|
|
|
36
36
|
- [WalletVerificationType](#walletverificationtype)
|
|
37
37
|
- [Interfaces](#interfaces)
|
|
38
38
|
- [ClientOptions](#clientoptions)
|
|
39
|
+
- [CreateWalletParameters](#createwalletparameters)
|
|
40
|
+
- [CreateWalletResponse](#createwalletresponse)
|
|
41
|
+
- [CreateWalletVerificationChallengesParameters](#createwalletverificationchallengesparameters)
|
|
42
|
+
- [CreateWalletVerificationParameters](#createwalletverificationparameters)
|
|
43
|
+
- [CreateWalletVerificationResponse](#createwalletverificationresponse)
|
|
44
|
+
- [DeleteWalletVerificationParameters](#deletewalletverificationparameters)
|
|
45
|
+
- [DeleteWalletVerificationResponse](#deletewalletverificationresponse)
|
|
46
|
+
- [GetWalletVerificationsParameters](#getwalletverificationsparameters)
|
|
47
|
+
- [VerificationResult](#verificationresult)
|
|
48
|
+
- [VerifyWalletVerificationChallengeParameters](#verifywalletverificationchallengeparameters)
|
|
49
|
+
- [WalletInfo](#walletinfo)
|
|
50
|
+
- [WalletOTPVerificationInfo](#walletotpverificationinfo)
|
|
51
|
+
- [WalletPincodeVerificationInfo](#walletpincodeverificationinfo)
|
|
52
|
+
- [WalletSecretCodesVerificationInfo](#walletsecretcodesverificationinfo)
|
|
53
|
+
- [WalletVerification](#walletverification)
|
|
54
|
+
- [WalletVerificationChallenge](#walletverificationchallenge)
|
|
39
55
|
- [WalletVerificationOptions](#walletverificationoptions)
|
|
56
|
+
- [Type Aliases](#type-aliases)
|
|
57
|
+
- [AddressOrObject](#addressorobject)
|
|
58
|
+
- [CreateWalletVerificationChallengesResponse](#createwalletverificationchallengesresponse)
|
|
59
|
+
- [GetWalletVerificationsResponse](#getwalletverificationsresponse)
|
|
60
|
+
- [VerifyWalletVerificationChallengeResponse](#verifywalletverificationchallengeresponse)
|
|
61
|
+
- [WalletVerificationInfo](#walletverificationinfo)
|
|
40
62
|
- [Contributing](#contributing)
|
|
41
63
|
- [License](#license)
|
|
42
64
|
|
|
@@ -52,7 +74,7 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
|
|
|
52
74
|
|
|
53
75
|
> **getPublicClient**(`options`): `object`
|
|
54
76
|
|
|
55
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
77
|
+
Defined in: [sdk/viem/src/viem.ts:64](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L64)
|
|
56
78
|
|
|
57
79
|
Get a public client. Use this if you need to read from the blockchain.
|
|
58
80
|
|
|
@@ -66,7 +88,7 @@ Get a public client. Use this if you need to read from the blockchain.
|
|
|
66
88
|
|
|
67
89
|
`object`
|
|
68
90
|
|
|
69
|
-
The public client.
|
|
91
|
+
The public client. see [https://viem.sh/docs/clients/public](https://viem.sh/docs/clients/public)
|
|
70
92
|
|
|
71
93
|
##### Example
|
|
72
94
|
|
|
@@ -89,18 +111,12 @@ console.log(block);
|
|
|
89
111
|
|
|
90
112
|
#### getWalletClient()
|
|
91
113
|
|
|
92
|
-
> **getWalletClient
|
|
114
|
+
> **getWalletClient**(`options`): (`verificationOptions?`) => `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
|
|
93
115
|
|
|
94
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
116
|
+
Defined in: [sdk/viem/src/viem.ts:126](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L126)
|
|
95
117
|
|
|
96
118
|
Get a wallet client. Use this if you need to write to the blockchain.
|
|
97
119
|
|
|
98
|
-
##### Type Parameters
|
|
99
|
-
|
|
100
|
-
| Type Parameter |
|
|
101
|
-
| ------ |
|
|
102
|
-
| `C` *extends* `Chain` |
|
|
103
|
-
|
|
104
120
|
##### Parameters
|
|
105
121
|
|
|
106
122
|
| Parameter | Type | Description |
|
|
@@ -109,9 +125,9 @@ Get a wallet client. Use this if you need to write to the blockchain.
|
|
|
109
125
|
|
|
110
126
|
##### Returns
|
|
111
127
|
|
|
112
|
-
A function that returns a wallet client. The function can be called with verification options.
|
|
128
|
+
A function that returns a wallet client. The function can be called with verification options for HD wallets. see [https://viem.sh/docs/clients/wallet](https://viem.sh/docs/clients/wallet)
|
|
113
129
|
|
|
114
|
-
> (`verificationOptions?`): `Client`\<`
|
|
130
|
+
> (`verificationOptions?`): `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
|
|
115
131
|
|
|
116
132
|
###### Parameters
|
|
117
133
|
|
|
@@ -121,7 +137,7 @@ A function that returns a wallet client. The function can be called with verific
|
|
|
121
137
|
|
|
122
138
|
###### Returns
|
|
123
139
|
|
|
124
|
-
`Client`\<`
|
|
140
|
+
`Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
|
|
125
141
|
|
|
126
142
|
##### Example
|
|
127
143
|
|
|
@@ -155,7 +171,7 @@ console.log(transactionHash);
|
|
|
155
171
|
|
|
156
172
|
#### OTPAlgorithm
|
|
157
173
|
|
|
158
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.
|
|
174
|
+
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
|
|
159
175
|
|
|
160
176
|
Supported hash algorithms for One-Time Password (OTP) verification.
|
|
161
177
|
These algorithms determine the cryptographic function used to generate OTP codes.
|
|
@@ -164,21 +180,21 @@ These algorithms determine the cryptographic function used to generate OTP codes
|
|
|
164
180
|
|
|
165
181
|
| Enumeration Member | Value | Description | Defined in |
|
|
166
182
|
| ------ | ------ | ------ | ------ |
|
|
167
|
-
| <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.
|
|
168
|
-
| <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.
|
|
169
|
-
| <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.
|
|
170
|
-
| <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.
|
|
171
|
-
| <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.
|
|
172
|
-
| <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.
|
|
173
|
-
| <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.
|
|
174
|
-
| <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.
|
|
175
|
-
| <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.
|
|
183
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L20) |
|
|
184
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L22) |
|
|
185
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L24) |
|
|
186
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L30) |
|
|
187
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L32) |
|
|
188
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L34) |
|
|
189
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L36) |
|
|
190
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L26) |
|
|
191
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
|
|
176
192
|
|
|
177
193
|
***
|
|
178
194
|
|
|
179
195
|
#### WalletVerificationType
|
|
180
196
|
|
|
181
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.
|
|
197
|
+
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
|
|
182
198
|
|
|
183
199
|
Types of wallet verification methods supported by the system.
|
|
184
200
|
Used to identify different verification mechanisms when creating or managing wallet verifications.
|
|
@@ -187,15 +203,15 @@ Used to identify different verification mechanisms when creating or managing wal
|
|
|
187
203
|
|
|
188
204
|
| Enumeration Member | Value | Description | Defined in |
|
|
189
205
|
| ------ | ------ | ------ | ------ |
|
|
190
|
-
| <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.
|
|
191
|
-
| <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.
|
|
192
|
-
| <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.
|
|
206
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L9) |
|
|
207
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L7) |
|
|
208
|
+
| <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.2.0/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
|
|
193
209
|
|
|
194
210
|
### Interfaces
|
|
195
211
|
|
|
196
212
|
#### ClientOptions
|
|
197
213
|
|
|
198
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
214
|
+
Defined in: [sdk/viem/src/viem.ts:21](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L21)
|
|
199
215
|
|
|
200
216
|
The options for the viem client.
|
|
201
217
|
|
|
@@ -203,17 +219,276 @@ The options for the viem client.
|
|
|
203
219
|
|
|
204
220
|
| Property | Type | Description | Defined in |
|
|
205
221
|
| ------ | ------ | ------ | ------ |
|
|
206
|
-
| <a id="accesstoken"></a> `accessToken` | `string` | The access token | [sdk/viem/src/viem.ts:
|
|
207
|
-
| <a id="chainid"></a> `chainId` | `string` | The chain id | [sdk/viem/src/viem.ts:
|
|
208
|
-
| <a id="chainname"></a> `chainName` | `string` | The chain name | [sdk/viem/src/viem.ts:
|
|
209
|
-
| <a id="httptransportconfig"></a> `httpTransportConfig?` | `HttpTransportConfig` | The http transport config | [sdk/viem/src/viem.ts:
|
|
210
|
-
| <a id="rpcurl"></a> `rpcUrl` | `string` | The json rpc url | [sdk/viem/src/viem.ts:
|
|
222
|
+
| <a id="accesstoken"></a> `accessToken` | `string` | The access token | [sdk/viem/src/viem.ts:25](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L25) |
|
|
223
|
+
| <a id="chainid"></a> `chainId` | `string` | The chain id | [sdk/viem/src/viem.ts:29](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L29) |
|
|
224
|
+
| <a id="chainname"></a> `chainName` | `string` | The chain name | [sdk/viem/src/viem.ts:33](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L33) |
|
|
225
|
+
| <a id="httptransportconfig"></a> `httpTransportConfig?` | `HttpTransportConfig` | The http transport config | [sdk/viem/src/viem.ts:41](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L41) |
|
|
226
|
+
| <a id="rpcurl"></a> `rpcUrl` | `string` | The json rpc url | [sdk/viem/src/viem.ts:37](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L37) |
|
|
227
|
+
|
|
228
|
+
***
|
|
229
|
+
|
|
230
|
+
#### CreateWalletParameters
|
|
231
|
+
|
|
232
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
|
|
233
|
+
|
|
234
|
+
Parameters for creating a wallet.
|
|
235
|
+
|
|
236
|
+
##### Properties
|
|
237
|
+
|
|
238
|
+
| Property | Type | Description | Defined in |
|
|
239
|
+
| ------ | ------ | ------ | ------ |
|
|
240
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet.action.ts#L16) |
|
|
241
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
|
|
242
|
+
|
|
243
|
+
***
|
|
244
|
+
|
|
245
|
+
#### CreateWalletResponse
|
|
246
|
+
|
|
247
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
|
|
248
|
+
|
|
249
|
+
Response from creating a wallet.
|
|
250
|
+
|
|
251
|
+
##### Properties
|
|
252
|
+
|
|
253
|
+
| Property | Type | Description | Defined in |
|
|
254
|
+
| ------ | ------ | ------ | ------ |
|
|
255
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet.action.ts#L30) |
|
|
256
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet.action.ts#L32) |
|
|
257
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet.action.ts#L26) |
|
|
258
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
|
|
259
|
+
|
|
260
|
+
***
|
|
261
|
+
|
|
262
|
+
#### CreateWalletVerificationChallengesParameters
|
|
263
|
+
|
|
264
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
|
|
265
|
+
|
|
266
|
+
Parameters for creating wallet verification challenges.
|
|
267
|
+
|
|
268
|
+
##### Properties
|
|
269
|
+
|
|
270
|
+
| Property | Type | Description | Defined in |
|
|
271
|
+
| ------ | ------ | ------ | ------ |
|
|
272
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
|
|
273
|
+
|
|
274
|
+
***
|
|
275
|
+
|
|
276
|
+
#### CreateWalletVerificationParameters
|
|
277
|
+
|
|
278
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
|
|
279
|
+
|
|
280
|
+
Parameters for creating a wallet verification.
|
|
281
|
+
|
|
282
|
+
##### Properties
|
|
283
|
+
|
|
284
|
+
| Property | Type | Description | Defined in |
|
|
285
|
+
| ------ | ------ | ------ | ------ |
|
|
286
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
|
|
287
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
|
|
288
|
+
|
|
289
|
+
***
|
|
290
|
+
|
|
291
|
+
#### CreateWalletVerificationResponse
|
|
292
|
+
|
|
293
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
|
|
294
|
+
|
|
295
|
+
Response from creating a wallet verification.
|
|
296
|
+
|
|
297
|
+
##### Properties
|
|
298
|
+
|
|
299
|
+
| Property | Type | Description | Defined in |
|
|
300
|
+
| ------ | ------ | ------ | ------ |
|
|
301
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L71) |
|
|
302
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L73) |
|
|
303
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L77) |
|
|
304
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
|
|
305
|
+
|
|
306
|
+
***
|
|
307
|
+
|
|
308
|
+
#### DeleteWalletVerificationParameters
|
|
309
|
+
|
|
310
|
+
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
|
|
311
|
+
|
|
312
|
+
Parameters for deleting a wallet verification.
|
|
313
|
+
|
|
314
|
+
##### Properties
|
|
315
|
+
|
|
316
|
+
| Property | Type | Description | Defined in |
|
|
317
|
+
| ------ | ------ | ------ | ------ |
|
|
318
|
+
| <a id="userwalletaddress-1"></a> `userWalletAddress` | `string` | The wallet address for which to delete the verification. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:8](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L8) |
|
|
319
|
+
| <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.2.0/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
|
|
320
|
+
|
|
321
|
+
***
|
|
322
|
+
|
|
323
|
+
#### DeleteWalletVerificationResponse
|
|
324
|
+
|
|
325
|
+
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
|
|
326
|
+
|
|
327
|
+
Response from deleting a wallet verification.
|
|
328
|
+
|
|
329
|
+
##### Properties
|
|
330
|
+
|
|
331
|
+
| Property | Type | Description | Defined in |
|
|
332
|
+
| ------ | ------ | ------ | ------ |
|
|
333
|
+
| <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.2.0/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
|
|
334
|
+
|
|
335
|
+
***
|
|
336
|
+
|
|
337
|
+
#### GetWalletVerificationsParameters
|
|
338
|
+
|
|
339
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
|
|
340
|
+
|
|
341
|
+
Parameters for getting wallet verifications.
|
|
342
|
+
|
|
343
|
+
##### Properties
|
|
344
|
+
|
|
345
|
+
| Property | Type | Description | Defined in |
|
|
346
|
+
| ------ | ------ | ------ | ------ |
|
|
347
|
+
| <a id="userwalletaddress-2"></a> `userWalletAddress` | `string` | The wallet address for which to fetch verifications. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:9](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
|
|
348
|
+
|
|
349
|
+
***
|
|
350
|
+
|
|
351
|
+
#### VerificationResult
|
|
352
|
+
|
|
353
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L26)
|
|
354
|
+
|
|
355
|
+
Result of a wallet verification challenge.
|
|
356
|
+
|
|
357
|
+
##### Properties
|
|
358
|
+
|
|
359
|
+
| Property | Type | Description | Defined in |
|
|
360
|
+
| ------ | ------ | ------ | ------ |
|
|
361
|
+
| <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:28](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28) |
|
|
362
|
+
|
|
363
|
+
***
|
|
364
|
+
|
|
365
|
+
#### VerifyWalletVerificationChallengeParameters
|
|
366
|
+
|
|
367
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L16)
|
|
368
|
+
|
|
369
|
+
Parameters for verifying a wallet verification challenge.
|
|
370
|
+
|
|
371
|
+
##### Properties
|
|
372
|
+
|
|
373
|
+
| Property | Type | Description | Defined in |
|
|
374
|
+
| ------ | ------ | ------ | ------ |
|
|
375
|
+
| <a id="addressorobject-1"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L18) |
|
|
376
|
+
| <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:20](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L20) |
|
|
377
|
+
|
|
378
|
+
***
|
|
379
|
+
|
|
380
|
+
#### WalletInfo
|
|
381
|
+
|
|
382
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
|
|
383
|
+
|
|
384
|
+
Information about the wallet to be created.
|
|
385
|
+
|
|
386
|
+
##### Properties
|
|
387
|
+
|
|
388
|
+
| Property | Type | Description | Defined in |
|
|
389
|
+
| ------ | ------ | ------ | ------ |
|
|
390
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
|
|
391
|
+
|
|
392
|
+
***
|
|
393
|
+
|
|
394
|
+
#### WalletOTPVerificationInfo
|
|
395
|
+
|
|
396
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
|
|
397
|
+
|
|
398
|
+
Information for One-Time Password (OTP) verification.
|
|
399
|
+
|
|
400
|
+
##### Extends
|
|
401
|
+
|
|
402
|
+
- `BaseWalletVerificationInfo`
|
|
403
|
+
|
|
404
|
+
##### Properties
|
|
405
|
+
|
|
406
|
+
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
407
|
+
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
408
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L31) |
|
|
409
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L33) |
|
|
410
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L37) |
|
|
411
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
|
|
412
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L35) |
|
|
413
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
|
|
414
|
+
|
|
415
|
+
***
|
|
416
|
+
|
|
417
|
+
#### WalletPincodeVerificationInfo
|
|
418
|
+
|
|
419
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
|
|
420
|
+
|
|
421
|
+
Information for PIN code verification.
|
|
422
|
+
|
|
423
|
+
##### Extends
|
|
424
|
+
|
|
425
|
+
- `BaseWalletVerificationInfo`
|
|
426
|
+
|
|
427
|
+
##### Properties
|
|
428
|
+
|
|
429
|
+
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
430
|
+
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
431
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
|
|
432
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L21) |
|
|
433
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
|
|
434
|
+
|
|
435
|
+
***
|
|
436
|
+
|
|
437
|
+
#### WalletSecretCodesVerificationInfo
|
|
438
|
+
|
|
439
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
|
|
440
|
+
|
|
441
|
+
Information for secret recovery codes verification.
|
|
442
|
+
|
|
443
|
+
##### Extends
|
|
444
|
+
|
|
445
|
+
- `BaseWalletVerificationInfo`
|
|
446
|
+
|
|
447
|
+
##### Properties
|
|
448
|
+
|
|
449
|
+
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
450
|
+
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
451
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
|
|
452
|
+
| <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.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
|
|
453
|
+
|
|
454
|
+
***
|
|
455
|
+
|
|
456
|
+
#### WalletVerification
|
|
457
|
+
|
|
458
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
|
|
459
|
+
|
|
460
|
+
Represents a wallet verification.
|
|
461
|
+
|
|
462
|
+
##### Properties
|
|
463
|
+
|
|
464
|
+
| Property | Type | Description | Defined in |
|
|
465
|
+
| ------ | ------ | ------ | ------ |
|
|
466
|
+
| <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.2.0/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L17) |
|
|
467
|
+
| <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.2.0/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L19) |
|
|
468
|
+
| <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.2.0/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
|
|
469
|
+
|
|
470
|
+
***
|
|
471
|
+
|
|
472
|
+
#### WalletVerificationChallenge
|
|
473
|
+
|
|
474
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
|
|
475
|
+
|
|
476
|
+
Represents a wallet verification challenge.
|
|
477
|
+
|
|
478
|
+
##### Properties
|
|
479
|
+
|
|
480
|
+
| Property | Type | Description | Defined in |
|
|
481
|
+
| ------ | ------ | ------ | ------ |
|
|
482
|
+
| <a id="challenge"></a> `challenge` | `Record`\<`string`, `string`\> | The challenge parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:24](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L24) |
|
|
483
|
+
| <a id="id-3"></a> `id` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:18](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L18) |
|
|
484
|
+
| <a id="name-7"></a> `name` | `string` | The name of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:20](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L20) |
|
|
485
|
+
| <a id="verificationtype-5"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification required. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:22](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L22) |
|
|
211
486
|
|
|
212
487
|
***
|
|
213
488
|
|
|
214
489
|
#### WalletVerificationOptions
|
|
215
490
|
|
|
216
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
491
|
+
Defined in: [sdk/viem/src/viem.ts:84](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L84)
|
|
217
492
|
|
|
218
493
|
The options for the wallet client.
|
|
219
494
|
|
|
@@ -221,8 +496,58 @@ The options for the wallet client.
|
|
|
221
496
|
|
|
222
497
|
| Property | Type | Description | Defined in |
|
|
223
498
|
| ------ | ------ | ------ | ------ |
|
|
224
|
-
| <a id="challengeresponse"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:
|
|
225
|
-
| <a id="verificationid"></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:
|
|
499
|
+
| <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:92](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L92) |
|
|
500
|
+
| <a id="verificationid-1"></a> `verificationId?` | `string` | The verification id (used for HD wallets), if not provided, the challenge response will be validated against all active verifications. | [sdk/viem/src/viem.ts:88](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/viem.ts#L88) |
|
|
501
|
+
|
|
502
|
+
### Type Aliases
|
|
503
|
+
|
|
504
|
+
#### AddressOrObject
|
|
505
|
+
|
|
506
|
+
> **AddressOrObject** = `string` \| \{ `userWalletAddress`: `string`; `verificationId?`: `string`; \}
|
|
507
|
+
|
|
508
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L6)
|
|
509
|
+
|
|
510
|
+
Represents either a wallet address string or an object containing wallet address and optional verification ID.
|
|
511
|
+
|
|
512
|
+
***
|
|
513
|
+
|
|
514
|
+
#### CreateWalletVerificationChallengesResponse
|
|
515
|
+
|
|
516
|
+
> **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)[]
|
|
517
|
+
|
|
518
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L30)
|
|
519
|
+
|
|
520
|
+
Response from creating wallet verification challenges.
|
|
521
|
+
|
|
522
|
+
***
|
|
523
|
+
|
|
524
|
+
#### GetWalletVerificationsResponse
|
|
525
|
+
|
|
526
|
+
> **GetWalletVerificationsResponse** = [`WalletVerification`](#walletverification)[]
|
|
527
|
+
|
|
528
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
|
|
529
|
+
|
|
530
|
+
Response from getting wallet verifications.
|
|
531
|
+
|
|
532
|
+
***
|
|
533
|
+
|
|
534
|
+
#### VerifyWalletVerificationChallengeResponse
|
|
535
|
+
|
|
536
|
+
> **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
|
|
537
|
+
|
|
538
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L34)
|
|
539
|
+
|
|
540
|
+
Response from verifying a wallet verification challenge.
|
|
541
|
+
|
|
542
|
+
***
|
|
543
|
+
|
|
544
|
+
#### WalletVerificationInfo
|
|
545
|
+
|
|
546
|
+
> **WalletVerificationInfo** = [`WalletPincodeVerificationInfo`](#walletpincodeverificationinfo) \| [`WalletOTPVerificationInfo`](#walletotpverificationinfo) \| [`WalletSecretCodesVerificationInfo`](#walletsecretcodesverificationinfo)
|
|
547
|
+
|
|
548
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
|
|
549
|
+
|
|
550
|
+
Union type of all possible wallet verification information types.
|
|
226
551
|
|
|
227
552
|
## Contributing
|
|
228
553
|
|
package/dist/viem.cjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var g=Object.create;var s=Object.defineProperty;var y=Object.getOwnPropertyDescriptor;var
|
|
1
|
+
"use strict";var g=Object.create;var s=Object.defineProperty;var y=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var x=Object.getPrototypeOf,O=Object.prototype.hasOwnProperty;var I=(e,t)=>{for(var i in t)s(e,i,{get:t[i],enumerable:!0})},p=(e,t,i,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let l of R(t))!O.call(e,l)&&l!==i&&s(e,l,{get:()=>t[l],enumerable:!(n=y(t,l))||n.enumerable});return e};var P=(e,t,i)=>(i=e!=null?g(x(e)):{},p(t||!e||!e.__esModule?s(i,"default",{value:e,enumerable:!0}):i,e)),S=e=>p(s({},"__esModule",{value:!0}),e);var b={};I(b,{OTPAlgorithm:()=>f,WalletVerificationType:()=>c,getPublicClient:()=>T,getWalletClient:()=>A});module.exports=S(b);var r=require("viem"),v=P(require("viem/chains"),1);function W(e){return{createWalletVerificationChallenges(t){return e.request({method:"user_createWalletVerificationChallenges",params:[t.addressOrObject]})}}}function m(e){return{createWalletVerification(t){return e.request({method:"user_createWalletVerification",params:[t.userWalletAddress,t.walletVerificationInfo]})}}}function d(e){return{createWallet(t){return e.request({method:"user_createWallet",params:[t.keyVaultId,t.walletInfo]})}}}function V(e){return{deleteWalletVerification(t){return e.request({method:"user_deleteWalletVerification",params:[t.userWalletAddress,t.verificationId]})}}}function h(e){return{getWalletVerifications(t){return e.request({method:"user_walletVerifications",params:[t.userWalletAddress]})}}}function C(e){return{verifyWalletVerificationChallenge(t){return e.request({method:"user_verifyWalletVerificationChallenge",params:[t.addressOrObject,t.challengeResponse]})}}}var c=(n=>(n.PINCODE="PINCODE",n.OTP="OTP",n.SECRET_CODES="SECRET_CODES",n))(c||{}),f=(a=>(a.SHA1="SHA1",a.SHA224="SHA224",a.SHA256="SHA256",a.SHA384="SHA384",a.SHA512="SHA512",a.SHA3_224="SHA3-224",a.SHA3_256="SHA3-256",a.SHA3_384="SHA3-384",a.SHA3_512="SHA3-512",a))(f||{});var T=e=>(0,r.createPublicClient)({chain:u(e),transport:(0,r.http)(e.rpcUrl,{batch:!0,timeout:6e4,...e.httpTransportConfig,fetchOptions:{...e?.httpTransportConfig?.fetchOptions,headers:{...e?.httpTransportConfig?.fetchOptions?.headers,"x-auth-token":e.accessToken}}})}),A=e=>{let t=u(e);return i=>(0,r.createWalletClient)({chain:t,transport:(0,r.http)(e.rpcUrl,{batch:!0,timeout:6e4,...e.httpTransportConfig,fetchOptions:{...e?.httpTransportConfig?.fetchOptions,headers:{...e?.httpTransportConfig?.fetchOptions?.headers,"x-auth-token":e.accessToken,"x-auth-challenge-response":i?.challengeResponse??"","x-auth-verification-id":i?.verificationId??""}}})}).extend(r.publicActions).extend(d).extend(h).extend(m).extend(V).extend(W).extend(C)};function u({chainId:e,chainName:t,rpcUrl:i}){return Object.values(v).find(l=>l.id.toString()===e)??(0,r.defineChain)({id:Number(e),name:t,rpcUrls:{default:{http:[i]}},nativeCurrency:{decimals:18,name:"Ether",symbol:"ETH"}})}0&&(module.exports={OTPAlgorithm,WalletVerificationType,getPublicClient,getWalletClient});
|
|
2
2
|
//# sourceMappingURL=viem.cjs.map
|