@settlemint/sdk-viem 2.5.6 → 2.5.7
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 +91 -101
- package/dist/browser/viem.d.ts +522 -501
- package/dist/browser/viem.js +106 -7
- package/dist/browser/viem.js.map +1 -1
- package/dist/viem.cjs +106 -7
- package/dist/viem.cjs.map +1 -1
- package/dist/viem.d.cts +522 -501
- package/dist/viem.d.ts +522 -501
- package/dist/viem.js +106 -7
- package/dist/viem.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -79,7 +79,7 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
|
|
|
79
79
|
|
|
80
80
|
> **getChainId**(`options`): `Promise`\<`number`\>
|
|
81
81
|
|
|
82
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
82
|
+
Defined in: [sdk/viem/src/viem.ts:347](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L347)
|
|
83
83
|
|
|
84
84
|
Get the chain id of a blockchain network.
|
|
85
85
|
|
|
@@ -111,9 +111,9 @@ console.log(chainId);
|
|
|
111
111
|
|
|
112
112
|
#### getPublicClient()
|
|
113
113
|
|
|
114
|
-
> **getPublicClient**(`options`):
|
|
114
|
+
> **getPublicClient**(`options`): \{ \} \| \{ \}
|
|
115
115
|
|
|
116
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
116
|
+
Defined in: [sdk/viem/src/viem.ts:169](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L169)
|
|
117
117
|
|
|
118
118
|
Get a public client. Use this if you need to read from the blockchain.
|
|
119
119
|
|
|
@@ -125,7 +125,7 @@ Get a public client. Use this if you need to read from the blockchain.
|
|
|
125
125
|
|
|
126
126
|
##### Returns
|
|
127
127
|
|
|
128
|
-
|
|
128
|
+
\{ \} \| \{ \}
|
|
129
129
|
|
|
130
130
|
The public client. see [https://viem.sh/docs/clients/public](https://viem.sh/docs/clients/public)
|
|
131
131
|
|
|
@@ -150,9 +150,9 @@ console.log(block);
|
|
|
150
150
|
|
|
151
151
|
#### getWalletClient()
|
|
152
152
|
|
|
153
|
-
> **getWalletClient**(`options`):
|
|
153
|
+
> **getWalletClient**(`options`): `any`
|
|
154
154
|
|
|
155
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
155
|
+
Defined in: [sdk/viem/src/viem.ts:255](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L255)
|
|
156
156
|
|
|
157
157
|
Get a wallet client. Use this if you need to write to the blockchain.
|
|
158
158
|
|
|
@@ -164,19 +164,9 @@ Get a wallet client. Use this if you need to write to the blockchain.
|
|
|
164
164
|
|
|
165
165
|
##### Returns
|
|
166
166
|
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
> (`verificationOptions?`): `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
|
|
170
|
-
|
|
171
|
-
###### Parameters
|
|
167
|
+
`any`
|
|
172
168
|
|
|
173
|
-
|
|
174
|
-
| ------ | ------ |
|
|
175
|
-
| `verificationOptions?` | [`WalletVerificationOptions`](#walletverificationoptions) |
|
|
176
|
-
|
|
177
|
-
###### Returns
|
|
178
|
-
|
|
179
|
-
`Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
|
|
169
|
+
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)
|
|
180
170
|
|
|
181
171
|
##### Example
|
|
182
172
|
|
|
@@ -210,7 +200,7 @@ console.log(transactionHash);
|
|
|
210
200
|
|
|
211
201
|
#### OTPAlgorithm
|
|
212
202
|
|
|
213
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.
|
|
203
|
+
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
|
|
214
204
|
|
|
215
205
|
Supported hash algorithms for One-Time Password (OTP) verification.
|
|
216
206
|
These algorithms determine the cryptographic function used to generate OTP codes.
|
|
@@ -219,21 +209,21 @@ These algorithms determine the cryptographic function used to generate OTP codes
|
|
|
219
209
|
|
|
220
210
|
| Enumeration Member | Value | Description | Defined in |
|
|
221
211
|
| ------ | ------ | ------ | ------ |
|
|
222
|
-
| <a id="sha1"></a> `SHA1` | `"SHA1"` | SHA-1 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:20](https://github.com/settlemint/sdk/blob/v2.5.
|
|
223
|
-
| <a id="sha224"></a> `SHA224` | `"SHA224"` | SHA-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:22](https://github.com/settlemint/sdk/blob/v2.5.
|
|
224
|
-
| <a id="sha256"></a> `SHA256` | `"SHA256"` | SHA-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:24](https://github.com/settlemint/sdk/blob/v2.5.
|
|
225
|
-
| <a id="sha3_224"></a> `SHA3_224` | `"SHA3-224"` | SHA3-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:30](https://github.com/settlemint/sdk/blob/v2.5.
|
|
226
|
-
| <a id="sha3_256"></a> `SHA3_256` | `"SHA3-256"` | SHA3-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:32](https://github.com/settlemint/sdk/blob/v2.5.
|
|
227
|
-
| <a id="sha3_384"></a> `SHA3_384` | `"SHA3-384"` | SHA3-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:34](https://github.com/settlemint/sdk/blob/v2.5.
|
|
228
|
-
| <a id="sha3_512"></a> `SHA3_512` | `"SHA3-512"` | SHA3-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:36](https://github.com/settlemint/sdk/blob/v2.5.
|
|
229
|
-
| <a id="sha384"></a> `SHA384` | `"SHA384"` | SHA-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:26](https://github.com/settlemint/sdk/blob/v2.5.
|
|
230
|
-
| <a id="sha512"></a> `SHA512` | `"SHA512"` | SHA-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:28](https://github.com/settlemint/sdk/blob/v2.5.
|
|
212
|
+
| <a id="sha1"></a> `SHA1` | `"SHA1"` | SHA-1 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:20](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L20) |
|
|
213
|
+
| <a id="sha224"></a> `SHA224` | `"SHA224"` | SHA-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:22](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L22) |
|
|
214
|
+
| <a id="sha256"></a> `SHA256` | `"SHA256"` | SHA-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:24](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L24) |
|
|
215
|
+
| <a id="sha3_224"></a> `SHA3_224` | `"SHA3-224"` | SHA3-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:30](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L30) |
|
|
216
|
+
| <a id="sha3_256"></a> `SHA3_256` | `"SHA3-256"` | SHA3-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:32](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L32) |
|
|
217
|
+
| <a id="sha3_384"></a> `SHA3_384` | `"SHA3-384"` | SHA3-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:34](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L34) |
|
|
218
|
+
| <a id="sha3_512"></a> `SHA3_512` | `"SHA3-512"` | SHA3-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:36](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L36) |
|
|
219
|
+
| <a id="sha384"></a> `SHA384` | `"SHA384"` | SHA-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:26](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L26) |
|
|
220
|
+
| <a id="sha512"></a> `SHA512` | `"SHA512"` | SHA-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:28](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
|
|
231
221
|
|
|
232
222
|
***
|
|
233
223
|
|
|
234
224
|
#### WalletVerificationType
|
|
235
225
|
|
|
236
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.
|
|
226
|
+
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
|
|
237
227
|
|
|
238
228
|
Types of wallet verification methods supported by the system.
|
|
239
229
|
Used to identify different verification mechanisms when creating or managing wallet verifications.
|
|
@@ -242,15 +232,15 @@ Used to identify different verification mechanisms when creating or managing wal
|
|
|
242
232
|
|
|
243
233
|
| Enumeration Member | Value | Description | Defined in |
|
|
244
234
|
| ------ | ------ | ------ | ------ |
|
|
245
|
-
| <a id="otp"></a> `OTP` | `"OTP"` | One-Time Password verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:9](https://github.com/settlemint/sdk/blob/v2.5.
|
|
246
|
-
| <a id="pincode"></a> `PINCODE` | `"PINCODE"` | PIN code verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:7](https://github.com/settlemint/sdk/blob/v2.5.
|
|
247
|
-
| <a id="secret_codes"></a> `SECRET_CODES` | `"SECRET_CODES"` | Secret recovery codes verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:11](https://github.com/settlemint/sdk/blob/v2.5.
|
|
235
|
+
| <a id="otp"></a> `OTP` | `"OTP"` | One-Time Password verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:9](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L9) |
|
|
236
|
+
| <a id="pincode"></a> `PINCODE` | `"PINCODE"` | PIN code verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:7](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L7) |
|
|
237
|
+
| <a id="secret_codes"></a> `SECRET_CODES` | `"SECRET_CODES"` | Secret recovery codes verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:11](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
|
|
248
238
|
|
|
249
239
|
### Interfaces
|
|
250
240
|
|
|
251
241
|
#### CreateWalletParameters
|
|
252
242
|
|
|
253
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.
|
|
243
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
|
|
254
244
|
|
|
255
245
|
Parameters for creating a wallet.
|
|
256
246
|
|
|
@@ -258,14 +248,14 @@ Parameters for creating a wallet.
|
|
|
258
248
|
|
|
259
249
|
| Property | Type | Description | Defined in |
|
|
260
250
|
| ------ | ------ | ------ | ------ |
|
|
261
|
-
| <a id="keyvaultid"></a> `keyVaultId` | `string` | The unique name of the key vault where the wallet will be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
262
|
-
| <a id="walletinfo"></a> `walletInfo` | [`WalletInfo`](#walletinfo-1) | Information about the wallet to be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.
|
|
251
|
+
| <a id="keyvaultid"></a> `keyVaultId` | `string` | The unique name of the key vault where the wallet will be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L16) |
|
|
252
|
+
| <a id="walletinfo"></a> `walletInfo` | [`WalletInfo`](#walletinfo-1) | Information about the wallet to be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
|
|
263
253
|
|
|
264
254
|
***
|
|
265
255
|
|
|
266
256
|
#### CreateWalletResponse
|
|
267
257
|
|
|
268
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.
|
|
258
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
|
|
269
259
|
|
|
270
260
|
Response from creating a wallet.
|
|
271
261
|
|
|
@@ -273,16 +263,16 @@ Response from creating a wallet.
|
|
|
273
263
|
|
|
274
264
|
| Property | Type | Description | Defined in |
|
|
275
265
|
| ------ | ------ | ------ | ------ |
|
|
276
|
-
| <a id="address"></a> `address` | `string` | The blockchain address of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.
|
|
277
|
-
| <a id="derivationpath"></a> `derivationPath` | `string` | The HD derivation path used to create the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:32](https://github.com/settlemint/sdk/blob/v2.5.
|
|
278
|
-
| <a id="id"></a> `id` | `string` | The unique identifier of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.
|
|
279
|
-
| <a id="name"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.
|
|
266
|
+
| <a id="address"></a> `address` | `string` | The blockchain address of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L30) |
|
|
267
|
+
| <a id="derivationpath"></a> `derivationPath` | `string` | The HD derivation path used to create the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:32](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L32) |
|
|
268
|
+
| <a id="id"></a> `id` | `string` | The unique identifier of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L26) |
|
|
269
|
+
| <a id="name"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
|
|
280
270
|
|
|
281
271
|
***
|
|
282
272
|
|
|
283
273
|
#### CreateWalletVerificationChallengesParameters
|
|
284
274
|
|
|
285
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.
|
|
275
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
|
|
286
276
|
|
|
287
277
|
Parameters for creating wallet verification challenges.
|
|
288
278
|
|
|
@@ -290,13 +280,13 @@ Parameters for creating wallet verification challenges.
|
|
|
290
280
|
|
|
291
281
|
| Property | Type | Description | Defined in |
|
|
292
282
|
| ------ | ------ | ------ | ------ |
|
|
293
|
-
| <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.
|
|
283
|
+
| <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.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
|
|
294
284
|
|
|
295
285
|
***
|
|
296
286
|
|
|
297
287
|
#### CreateWalletVerificationParameters
|
|
298
288
|
|
|
299
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.
|
|
289
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
|
|
300
290
|
|
|
301
291
|
Parameters for creating a wallet verification.
|
|
302
292
|
|
|
@@ -304,14 +294,14 @@ Parameters for creating a wallet verification.
|
|
|
304
294
|
|
|
305
295
|
| Property | Type | Description | Defined in |
|
|
306
296
|
| ------ | ------ | ------ | ------ |
|
|
307
|
-
| <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.
|
|
308
|
-
| <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.
|
|
297
|
+
| <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.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
|
|
298
|
+
| <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.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
|
|
309
299
|
|
|
310
300
|
***
|
|
311
301
|
|
|
312
302
|
#### CreateWalletVerificationResponse
|
|
313
303
|
|
|
314
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.
|
|
304
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
|
|
315
305
|
|
|
316
306
|
Response from creating a wallet verification.
|
|
317
307
|
|
|
@@ -319,16 +309,16 @@ Response from creating a wallet verification.
|
|
|
319
309
|
|
|
320
310
|
| Property | Type | Description | Defined in |
|
|
321
311
|
| ------ | ------ | ------ | ------ |
|
|
322
|
-
| <a id="id-1"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:71](https://github.com/settlemint/sdk/blob/v2.5.
|
|
323
|
-
| <a id="name-1"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:73](https://github.com/settlemint/sdk/blob/v2.5.
|
|
324
|
-
| <a id="parameters"></a> `parameters` | `Record`\<`string`, `string`\> | Additional parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:77](https://github.com/settlemint/sdk/blob/v2.5.
|
|
325
|
-
| <a id="verificationtype"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:75](https://github.com/settlemint/sdk/blob/v2.5.
|
|
312
|
+
| <a id="id-1"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:71](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L71) |
|
|
313
|
+
| <a id="name-1"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:73](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L73) |
|
|
314
|
+
| <a id="parameters"></a> `parameters` | `Record`\<`string`, `string`\> | Additional parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:77](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L77) |
|
|
315
|
+
| <a id="verificationtype"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:75](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
|
|
326
316
|
|
|
327
317
|
***
|
|
328
318
|
|
|
329
319
|
#### DeleteWalletVerificationParameters
|
|
330
320
|
|
|
331
|
-
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
321
|
+
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
|
|
332
322
|
|
|
333
323
|
Parameters for deleting a wallet verification.
|
|
334
324
|
|
|
@@ -336,14 +326,14 @@ Parameters for deleting a wallet verification.
|
|
|
336
326
|
|
|
337
327
|
| Property | Type | Description | Defined in |
|
|
338
328
|
| ------ | ------ | ------ | ------ |
|
|
339
|
-
| <a id="userwalletaddress-1"></a> `userWalletAddress` | `string` | The wallet address for which to delete the verification. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.
|
|
340
|
-
| <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.
|
|
329
|
+
| <a id="userwalletaddress-1"></a> `userWalletAddress` | `string` | The wallet address for which to delete the verification. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L8) |
|
|
330
|
+
| <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.7/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
|
|
341
331
|
|
|
342
332
|
***
|
|
343
333
|
|
|
344
334
|
#### DeleteWalletVerificationResponse
|
|
345
335
|
|
|
346
|
-
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
336
|
+
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
|
|
347
337
|
|
|
348
338
|
Response from deleting a wallet verification.
|
|
349
339
|
|
|
@@ -351,13 +341,13 @@ Response from deleting a wallet verification.
|
|
|
351
341
|
|
|
352
342
|
| Property | Type | Description | Defined in |
|
|
353
343
|
| ------ | ------ | ------ | ------ |
|
|
354
|
-
| <a id="success"></a> `success` | `boolean` | Whether the deletion was successful. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.
|
|
344
|
+
| <a id="success"></a> `success` | `boolean` | Whether the deletion was successful. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
|
|
355
345
|
|
|
356
346
|
***
|
|
357
347
|
|
|
358
348
|
#### GetWalletVerificationsParameters
|
|
359
349
|
|
|
360
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.
|
|
350
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
|
|
361
351
|
|
|
362
352
|
Parameters for getting wallet verifications.
|
|
363
353
|
|
|
@@ -365,13 +355,13 @@ Parameters for getting wallet verifications.
|
|
|
365
355
|
|
|
366
356
|
| Property | Type | Description | Defined in |
|
|
367
357
|
| ------ | ------ | ------ | ------ |
|
|
368
|
-
| <a id="userwalletaddress-2"></a> `userWalletAddress` | `string` | The wallet address for which to fetch verifications. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.
|
|
358
|
+
| <a id="userwalletaddress-2"></a> `userWalletAddress` | `string` | The wallet address for which to fetch verifications. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
|
|
369
359
|
|
|
370
360
|
***
|
|
371
361
|
|
|
372
362
|
#### VerificationResult
|
|
373
363
|
|
|
374
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.
|
|
364
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L26)
|
|
375
365
|
|
|
376
366
|
Result of a wallet verification challenge.
|
|
377
367
|
|
|
@@ -379,13 +369,13 @@ Result of a wallet verification challenge.
|
|
|
379
369
|
|
|
380
370
|
| Property | Type | Description | Defined in |
|
|
381
371
|
| ------ | ------ | ------ | ------ |
|
|
382
|
-
| <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.
|
|
372
|
+
| <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:28](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28) |
|
|
383
373
|
|
|
384
374
|
***
|
|
385
375
|
|
|
386
376
|
#### VerifyWalletVerificationChallengeParameters
|
|
387
377
|
|
|
388
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
378
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L16)
|
|
389
379
|
|
|
390
380
|
Parameters for verifying a wallet verification challenge.
|
|
391
381
|
|
|
@@ -393,14 +383,14 @@ Parameters for verifying a wallet verification challenge.
|
|
|
393
383
|
|
|
394
384
|
| Property | Type | Description | Defined in |
|
|
395
385
|
| ------ | ------ | ------ | ------ |
|
|
396
|
-
| <a id="addressorobject-1"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.
|
|
397
|
-
| <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:20](https://github.com/settlemint/sdk/blob/v2.5.
|
|
386
|
+
| <a id="addressorobject-1"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L18) |
|
|
387
|
+
| <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:20](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L20) |
|
|
398
388
|
|
|
399
389
|
***
|
|
400
390
|
|
|
401
391
|
#### WalletInfo
|
|
402
392
|
|
|
403
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
393
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
|
|
404
394
|
|
|
405
395
|
Information about the wallet to be created.
|
|
406
396
|
|
|
@@ -408,13 +398,13 @@ Information about the wallet to be created.
|
|
|
408
398
|
|
|
409
399
|
| Property | Type | Description | Defined in |
|
|
410
400
|
| ------ | ------ | ------ | ------ |
|
|
411
|
-
| <a id="name-2"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.
|
|
401
|
+
| <a id="name-2"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
|
|
412
402
|
|
|
413
403
|
***
|
|
414
404
|
|
|
415
405
|
#### WalletOTPVerificationInfo
|
|
416
406
|
|
|
417
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.
|
|
407
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
|
|
418
408
|
|
|
419
409
|
Information for One-Time Password (OTP) verification.
|
|
420
410
|
|
|
@@ -426,18 +416,18 @@ Information for One-Time Password (OTP) verification.
|
|
|
426
416
|
|
|
427
417
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
428
418
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
429
|
-
| <a id="algorithm"></a> `algorithm?` | [`OTPAlgorithm`](#otpalgorithm) | The hash algorithm to use for OTP generation. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:31](https://github.com/settlemint/sdk/blob/v2.5.
|
|
430
|
-
| <a id="digits"></a> `digits?` | `number` | The number of digits in the OTP code. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:33](https://github.com/settlemint/sdk/blob/v2.5.
|
|
431
|
-
| <a id="issuer"></a> `issuer?` | `string` | The issuer of the OTP. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:37](https://github.com/settlemint/sdk/blob/v2.5.
|
|
432
|
-
| <a id="name-3"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.
|
|
433
|
-
| <a id="period"></a> `period?` | `number` | The time period in seconds for OTP validity. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:35](https://github.com/settlemint/sdk/blob/v2.5.
|
|
434
|
-
| <a id="verificationtype-1"></a> `verificationType` | [`OTP`](#otp) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:29](https://github.com/settlemint/sdk/blob/v2.5.
|
|
419
|
+
| <a id="algorithm"></a> `algorithm?` | [`OTPAlgorithm`](#otpalgorithm) | The hash algorithm to use for OTP generation. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:31](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L31) |
|
|
420
|
+
| <a id="digits"></a> `digits?` | `number` | The number of digits in the OTP code. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:33](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L33) |
|
|
421
|
+
| <a id="issuer"></a> `issuer?` | `string` | The issuer of the OTP. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:37](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L37) |
|
|
422
|
+
| <a id="name-3"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
|
|
423
|
+
| <a id="period"></a> `period?` | `number` | The time period in seconds for OTP validity. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:35](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L35) |
|
|
424
|
+
| <a id="verificationtype-1"></a> `verificationType` | [`OTP`](#otp) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:29](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
|
|
435
425
|
|
|
436
426
|
***
|
|
437
427
|
|
|
438
428
|
#### WalletPincodeVerificationInfo
|
|
439
429
|
|
|
440
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.
|
|
430
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
|
|
441
431
|
|
|
442
432
|
Information for PIN code verification.
|
|
443
433
|
|
|
@@ -449,15 +439,15 @@ Information for PIN code verification.
|
|
|
449
439
|
|
|
450
440
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
451
441
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
452
|
-
| <a id="name-4"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.
|
|
453
|
-
| <a id="pincode-1"></a> `pincode` | `string` | The PIN code to use for verification. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:21](https://github.com/settlemint/sdk/blob/v2.5.
|
|
454
|
-
| <a id="verificationtype-2"></a> `verificationType` | [`PINCODE`](#pincode) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:19](https://github.com/settlemint/sdk/blob/v2.5.
|
|
442
|
+
| <a id="name-4"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
|
|
443
|
+
| <a id="pincode-1"></a> `pincode` | `string` | The PIN code to use for verification. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:21](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L21) |
|
|
444
|
+
| <a id="verificationtype-2"></a> `verificationType` | [`PINCODE`](#pincode) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:19](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
|
|
455
445
|
|
|
456
446
|
***
|
|
457
447
|
|
|
458
448
|
#### WalletSecretCodesVerificationInfo
|
|
459
449
|
|
|
460
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.
|
|
450
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
|
|
461
451
|
|
|
462
452
|
Information for secret recovery codes verification.
|
|
463
453
|
|
|
@@ -469,14 +459,14 @@ Information for secret recovery codes verification.
|
|
|
469
459
|
|
|
470
460
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
471
461
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
472
|
-
| <a id="name-5"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.
|
|
473
|
-
| <a id="verificationtype-3"></a> `verificationType` | [`SECRET_CODES`](#secret_codes) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:45](https://github.com/settlemint/sdk/blob/v2.5.
|
|
462
|
+
| <a id="name-5"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
|
|
463
|
+
| <a id="verificationtype-3"></a> `verificationType` | [`SECRET_CODES`](#secret_codes) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:45](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
|
|
474
464
|
|
|
475
465
|
***
|
|
476
466
|
|
|
477
467
|
#### WalletVerification
|
|
478
468
|
|
|
479
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.
|
|
469
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
|
|
480
470
|
|
|
481
471
|
Represents a wallet verification.
|
|
482
472
|
|
|
@@ -484,15 +474,15 @@ Represents a wallet verification.
|
|
|
484
474
|
|
|
485
475
|
| Property | Type | Description | Defined in |
|
|
486
476
|
| ------ | ------ | ------ | ------ |
|
|
487
|
-
| <a id="id-2"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.
|
|
488
|
-
| <a id="name-6"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:19](https://github.com/settlemint/sdk/blob/v2.5.
|
|
489
|
-
| <a id="verificationtype-4"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:21](https://github.com/settlemint/sdk/blob/v2.5.
|
|
477
|
+
| <a id="id-2"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L17) |
|
|
478
|
+
| <a id="name-6"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:19](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L19) |
|
|
479
|
+
| <a id="verificationtype-4"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:21](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
|
|
490
480
|
|
|
491
481
|
***
|
|
492
482
|
|
|
493
483
|
#### WalletVerificationChallenge
|
|
494
484
|
|
|
495
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
485
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
|
|
496
486
|
|
|
497
487
|
Represents a wallet verification challenge.
|
|
498
488
|
|
|
@@ -500,16 +490,16 @@ Represents a wallet verification challenge.
|
|
|
500
490
|
|
|
501
491
|
| Property | Type | Description | Defined in |
|
|
502
492
|
| ------ | ------ | ------ | ------ |
|
|
503
|
-
| <a id="challenge"></a> `challenge` | `Record`\<`string`, `string`\> | The challenge parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.
|
|
504
|
-
| <a id="id-3"></a> `id` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.
|
|
505
|
-
| <a id="name-7"></a> `name` | `string` | The name of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:20](https://github.com/settlemint/sdk/blob/v2.5.
|
|
506
|
-
| <a id="verificationtype-5"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification required. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:22](https://github.com/settlemint/sdk/blob/v2.5.
|
|
493
|
+
| <a id="challenge"></a> `challenge` | `Record`\<`string`, `string`\> | The challenge parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L24) |
|
|
494
|
+
| <a id="id-3"></a> `id` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:18](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L18) |
|
|
495
|
+
| <a id="name-7"></a> `name` | `string` | The name of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:20](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L20) |
|
|
496
|
+
| <a id="verificationtype-5"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification required. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:22](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L22) |
|
|
507
497
|
|
|
508
498
|
***
|
|
509
499
|
|
|
510
500
|
#### WalletVerificationOptions
|
|
511
501
|
|
|
512
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
502
|
+
Defined in: [sdk/viem/src/viem.ts:213](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L213)
|
|
513
503
|
|
|
514
504
|
The options for the wallet client.
|
|
515
505
|
|
|
@@ -517,8 +507,8 @@ The options for the wallet client.
|
|
|
517
507
|
|
|
518
508
|
| Property | Type | Description | Defined in |
|
|
519
509
|
| ------ | ------ | ------ | ------ |
|
|
520
|
-
| <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:
|
|
521
|
-
| <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:
|
|
510
|
+
| <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:221](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L221) |
|
|
511
|
+
| <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:217](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L217) |
|
|
522
512
|
|
|
523
513
|
### Type Aliases
|
|
524
514
|
|
|
@@ -526,7 +516,7 @@ The options for the wallet client.
|
|
|
526
516
|
|
|
527
517
|
> **AddressOrObject** = `string` \| \{ `userWalletAddress`: `string`; `verificationId?`: `string`; \}
|
|
528
518
|
|
|
529
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
519
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L6)
|
|
530
520
|
|
|
531
521
|
Represents either a wallet address string or an object containing wallet address and optional verification ID.
|
|
532
522
|
|
|
@@ -536,7 +526,7 @@ Represents either a wallet address string or an object containing wallet address
|
|
|
536
526
|
|
|
537
527
|
> **ClientOptions** = `Omit`\<`z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
538
528
|
|
|
539
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
529
|
+
Defined in: [sdk/viem/src/viem.ts:145](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L145)
|
|
540
530
|
|
|
541
531
|
Type representing the validated client options.
|
|
542
532
|
|
|
@@ -544,7 +534,7 @@ Type representing the validated client options.
|
|
|
544
534
|
|
|
545
535
|
| Name | Type | Defined in |
|
|
546
536
|
| ------ | ------ | ------ |
|
|
547
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:
|
|
537
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:146](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L146) |
|
|
548
538
|
|
|
549
539
|
***
|
|
550
540
|
|
|
@@ -552,7 +542,7 @@ Type representing the validated client options.
|
|
|
552
542
|
|
|
553
543
|
> **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)[]
|
|
554
544
|
|
|
555
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.
|
|
545
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L30)
|
|
556
546
|
|
|
557
547
|
Response from creating wallet verification challenges.
|
|
558
548
|
|
|
@@ -562,7 +552,7 @@ Response from creating wallet verification challenges.
|
|
|
562
552
|
|
|
563
553
|
> **GetChainIdOptions** = `Omit`\<`z.infer`\<*typeof* [`GetChainIdOptionsSchema`](#getchainidoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
564
554
|
|
|
565
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
555
|
+
Defined in: [sdk/viem/src/viem.ts:328](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L328)
|
|
566
556
|
|
|
567
557
|
Type representing the validated get chain id options.
|
|
568
558
|
|
|
@@ -570,7 +560,7 @@ Type representing the validated get chain id options.
|
|
|
570
560
|
|
|
571
561
|
| Name | Type | Defined in |
|
|
572
562
|
| ------ | ------ | ------ |
|
|
573
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:
|
|
563
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:329](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L329) |
|
|
574
564
|
|
|
575
565
|
***
|
|
576
566
|
|
|
@@ -578,7 +568,7 @@ Type representing the validated get chain id options.
|
|
|
578
568
|
|
|
579
569
|
> **GetWalletVerificationsResponse** = [`WalletVerification`](#walletverification)[]
|
|
580
570
|
|
|
581
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.
|
|
571
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
|
|
582
572
|
|
|
583
573
|
Response from getting wallet verifications.
|
|
584
574
|
|
|
@@ -588,7 +578,7 @@ Response from getting wallet verifications.
|
|
|
588
578
|
|
|
589
579
|
> **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
|
|
590
580
|
|
|
591
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.5.
|
|
581
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L34)
|
|
592
582
|
|
|
593
583
|
Response from verifying a wallet verification challenge.
|
|
594
584
|
|
|
@@ -598,7 +588,7 @@ Response from verifying a wallet verification challenge.
|
|
|
598
588
|
|
|
599
589
|
> **WalletVerificationInfo** = [`WalletPincodeVerificationInfo`](#walletpincodeverificationinfo) \| [`WalletOTPVerificationInfo`](#walletotpverificationinfo) \| [`WalletSecretCodesVerificationInfo`](#walletsecretcodesverificationinfo)
|
|
600
590
|
|
|
601
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.
|
|
591
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
|
|
602
592
|
|
|
603
593
|
Union type of all possible wallet verification information types.
|
|
604
594
|
|
|
@@ -608,7 +598,7 @@ Union type of all possible wallet verification information types.
|
|
|
608
598
|
|
|
609
599
|
> `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
610
600
|
|
|
611
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
601
|
+
Defined in: [sdk/viem/src/viem.ts:119](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L119)
|
|
612
602
|
|
|
613
603
|
Schema for the viem client options.
|
|
614
604
|
|
|
@@ -618,7 +608,7 @@ Schema for the viem client options.
|
|
|
618
608
|
|
|
619
609
|
> `const` **GetChainIdOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
620
610
|
|
|
621
|
-
Defined in: [sdk/viem/src/viem.ts:
|
|
611
|
+
Defined in: [sdk/viem/src/viem.ts:310](https://github.com/settlemint/sdk/blob/v2.5.7/sdk/viem/src/viem.ts#L310)
|
|
622
612
|
|
|
623
613
|
Schema for the viem client options.
|
|
624
614
|
|