@settlemint/sdk-viem 2.5.4 → 2.5.5-main5537f734
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 +86 -86
- 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:217](https://github.com/settlemint/sdk/blob/v2.5.
|
|
82
|
+
Defined in: [sdk/viem/src/viem.ts:217](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L217)
|
|
83
83
|
|
|
84
84
|
Get the chain id of a blockchain network.
|
|
85
85
|
|
|
@@ -113,7 +113,7 @@ console.log(chainId);
|
|
|
113
113
|
|
|
114
114
|
> **getPublicClient**(`options`): `object`
|
|
115
115
|
|
|
116
|
-
Defined in: [sdk/viem/src/viem.ts:75](https://github.com/settlemint/sdk/blob/v2.5.
|
|
116
|
+
Defined in: [sdk/viem/src/viem.ts:75](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L75)
|
|
117
117
|
|
|
118
118
|
Get a public client. Use this if you need to read from the blockchain.
|
|
119
119
|
|
|
@@ -152,7 +152,7 @@ console.log(block);
|
|
|
152
152
|
|
|
153
153
|
> **getWalletClient**(`options`): (`verificationOptions?`) => `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
|
|
154
154
|
|
|
155
|
-
Defined in: [sdk/viem/src/viem.ts:143](https://github.com/settlemint/sdk/blob/v2.5.
|
|
155
|
+
Defined in: [sdk/viem/src/viem.ts:143](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L143)
|
|
156
156
|
|
|
157
157
|
Get a wallet client. Use this if you need to write to the blockchain.
|
|
158
158
|
|
|
@@ -210,7 +210,7 @@ console.log(transactionHash);
|
|
|
210
210
|
|
|
211
211
|
#### OTPAlgorithm
|
|
212
212
|
|
|
213
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.
|
|
213
|
+
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
|
|
214
214
|
|
|
215
215
|
Supported hash algorithms for One-Time Password (OTP) verification.
|
|
216
216
|
These algorithms determine the cryptographic function used to generate OTP codes.
|
|
@@ -219,21 +219,21 @@ These algorithms determine the cryptographic function used to generate OTP codes
|
|
|
219
219
|
|
|
220
220
|
| Enumeration Member | Value | Description | Defined in |
|
|
221
221
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L20) |
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L22) |
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L24) |
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L30) |
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L32) |
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L34) |
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L36) |
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L26) |
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
|
|
231
231
|
|
|
232
232
|
***
|
|
233
233
|
|
|
234
234
|
#### WalletVerificationType
|
|
235
235
|
|
|
236
|
-
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.
|
|
236
|
+
Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
|
|
237
237
|
|
|
238
238
|
Types of wallet verification methods supported by the system.
|
|
239
239
|
Used to identify different verification mechanisms when creating or managing wallet verifications.
|
|
@@ -242,15 +242,15 @@ Used to identify different verification mechanisms when creating or managing wal
|
|
|
242
242
|
|
|
243
243
|
| Enumeration Member | Value | Description | Defined in |
|
|
244
244
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L9) |
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L7) |
|
|
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.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
|
|
248
248
|
|
|
249
249
|
### Interfaces
|
|
250
250
|
|
|
251
251
|
#### CreateWalletParameters
|
|
252
252
|
|
|
253
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.
|
|
253
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
|
|
254
254
|
|
|
255
255
|
Parameters for creating a wallet.
|
|
256
256
|
|
|
@@ -258,14 +258,14 @@ Parameters for creating a wallet.
|
|
|
258
258
|
|
|
259
259
|
| Property | Type | Description | Defined in |
|
|
260
260
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/create-wallet.action.ts#L16) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
|
|
263
263
|
|
|
264
264
|
***
|
|
265
265
|
|
|
266
266
|
#### CreateWalletResponse
|
|
267
267
|
|
|
268
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.
|
|
268
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
|
|
269
269
|
|
|
270
270
|
Response from creating a wallet.
|
|
271
271
|
|
|
@@ -273,16 +273,16 @@ Response from creating a wallet.
|
|
|
273
273
|
|
|
274
274
|
| Property | Type | Description | Defined in |
|
|
275
275
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/create-wallet.action.ts#L30) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet.action.ts#L32) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet.action.ts#L26) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
|
|
280
280
|
|
|
281
281
|
***
|
|
282
282
|
|
|
283
283
|
#### CreateWalletVerificationChallengesParameters
|
|
284
284
|
|
|
285
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.
|
|
285
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
|
|
286
286
|
|
|
287
287
|
Parameters for creating wallet verification challenges.
|
|
288
288
|
|
|
@@ -290,13 +290,13 @@ Parameters for creating wallet verification challenges.
|
|
|
290
290
|
|
|
291
291
|
| Property | Type | Description | Defined in |
|
|
292
292
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
|
|
294
294
|
|
|
295
295
|
***
|
|
296
296
|
|
|
297
297
|
#### CreateWalletVerificationParameters
|
|
298
298
|
|
|
299
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.
|
|
299
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
|
|
300
300
|
|
|
301
301
|
Parameters for creating a wallet verification.
|
|
302
302
|
|
|
@@ -304,14 +304,14 @@ Parameters for creating a wallet verification.
|
|
|
304
304
|
|
|
305
305
|
| Property | Type | Description | Defined in |
|
|
306
306
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
|
|
309
309
|
|
|
310
310
|
***
|
|
311
311
|
|
|
312
312
|
#### CreateWalletVerificationResponse
|
|
313
313
|
|
|
314
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.
|
|
314
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
|
|
315
315
|
|
|
316
316
|
Response from creating a wallet verification.
|
|
317
317
|
|
|
@@ -319,16 +319,16 @@ Response from creating a wallet verification.
|
|
|
319
319
|
|
|
320
320
|
| Property | Type | Description | Defined in |
|
|
321
321
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L71) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L73) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L77) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
|
|
326
326
|
|
|
327
327
|
***
|
|
328
328
|
|
|
329
329
|
#### DeleteWalletVerificationParameters
|
|
330
330
|
|
|
331
|
-
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
331
|
+
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
|
|
332
332
|
|
|
333
333
|
Parameters for deleting a wallet verification.
|
|
334
334
|
|
|
@@ -336,14 +336,14 @@ Parameters for deleting a wallet verification.
|
|
|
336
336
|
|
|
337
337
|
| Property | Type | Description | Defined in |
|
|
338
338
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L8) |
|
|
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.5/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
|
|
341
341
|
|
|
342
342
|
***
|
|
343
343
|
|
|
344
344
|
#### DeleteWalletVerificationResponse
|
|
345
345
|
|
|
346
|
-
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
346
|
+
Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
|
|
347
347
|
|
|
348
348
|
Response from deleting a wallet verification.
|
|
349
349
|
|
|
@@ -351,13 +351,13 @@ Response from deleting a wallet verification.
|
|
|
351
351
|
|
|
352
352
|
| Property | Type | Description | Defined in |
|
|
353
353
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
|
|
355
355
|
|
|
356
356
|
***
|
|
357
357
|
|
|
358
358
|
#### GetWalletVerificationsParameters
|
|
359
359
|
|
|
360
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.
|
|
360
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
|
|
361
361
|
|
|
362
362
|
Parameters for getting wallet verifications.
|
|
363
363
|
|
|
@@ -365,13 +365,13 @@ Parameters for getting wallet verifications.
|
|
|
365
365
|
|
|
366
366
|
| Property | Type | Description | Defined in |
|
|
367
367
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
|
|
369
369
|
|
|
370
370
|
***
|
|
371
371
|
|
|
372
372
|
#### VerificationResult
|
|
373
373
|
|
|
374
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.
|
|
374
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L26)
|
|
375
375
|
|
|
376
376
|
Result of a wallet verification challenge.
|
|
377
377
|
|
|
@@ -379,13 +379,13 @@ Result of a wallet verification challenge.
|
|
|
379
379
|
|
|
380
380
|
| Property | Type | Description | Defined in |
|
|
381
381
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28) |
|
|
383
383
|
|
|
384
384
|
***
|
|
385
385
|
|
|
386
386
|
#### VerifyWalletVerificationChallengeParameters
|
|
387
387
|
|
|
388
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
388
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L16)
|
|
389
389
|
|
|
390
390
|
Parameters for verifying a wallet verification challenge.
|
|
391
391
|
|
|
@@ -393,14 +393,14 @@ Parameters for verifying a wallet verification challenge.
|
|
|
393
393
|
|
|
394
394
|
| Property | Type | Description | Defined in |
|
|
395
395
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L18) |
|
|
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.5/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L20) |
|
|
398
398
|
|
|
399
399
|
***
|
|
400
400
|
|
|
401
401
|
#### WalletInfo
|
|
402
402
|
|
|
403
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
403
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
|
|
404
404
|
|
|
405
405
|
Information about the wallet to be created.
|
|
406
406
|
|
|
@@ -408,13 +408,13 @@ Information about the wallet to be created.
|
|
|
408
408
|
|
|
409
409
|
| Property | Type | Description | Defined in |
|
|
410
410
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
|
|
412
412
|
|
|
413
413
|
***
|
|
414
414
|
|
|
415
415
|
#### WalletOTPVerificationInfo
|
|
416
416
|
|
|
417
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.
|
|
417
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
|
|
418
418
|
|
|
419
419
|
Information for One-Time Password (OTP) verification.
|
|
420
420
|
|
|
@@ -426,18 +426,18 @@ Information for One-Time Password (OTP) verification.
|
|
|
426
426
|
|
|
427
427
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
428
428
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L31) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L33) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L37) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L35) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
|
|
435
435
|
|
|
436
436
|
***
|
|
437
437
|
|
|
438
438
|
#### WalletPincodeVerificationInfo
|
|
439
439
|
|
|
440
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.
|
|
440
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
|
|
441
441
|
|
|
442
442
|
Information for PIN code verification.
|
|
443
443
|
|
|
@@ -449,15 +449,15 @@ Information for PIN code verification.
|
|
|
449
449
|
|
|
450
450
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
451
451
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L21) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
|
|
455
455
|
|
|
456
456
|
***
|
|
457
457
|
|
|
458
458
|
#### WalletSecretCodesVerificationInfo
|
|
459
459
|
|
|
460
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.
|
|
460
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
|
|
461
461
|
|
|
462
462
|
Information for secret recovery codes verification.
|
|
463
463
|
|
|
@@ -469,14 +469,14 @@ Information for secret recovery codes verification.
|
|
|
469
469
|
|
|
470
470
|
| Property | Type | Description | Overrides | Inherited from | Defined in |
|
|
471
471
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
|
|
474
474
|
|
|
475
475
|
***
|
|
476
476
|
|
|
477
477
|
#### WalletVerification
|
|
478
478
|
|
|
479
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.
|
|
479
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
|
|
480
480
|
|
|
481
481
|
Represents a wallet verification.
|
|
482
482
|
|
|
@@ -484,15 +484,15 @@ Represents a wallet verification.
|
|
|
484
484
|
|
|
485
485
|
| Property | Type | Description | Defined in |
|
|
486
486
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L17) |
|
|
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.5/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L19) |
|
|
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.5/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
|
|
490
490
|
|
|
491
491
|
***
|
|
492
492
|
|
|
493
493
|
#### WalletVerificationChallenge
|
|
494
494
|
|
|
495
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
495
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
|
|
496
496
|
|
|
497
497
|
Represents a wallet verification challenge.
|
|
498
498
|
|
|
@@ -500,16 +500,16 @@ Represents a wallet verification challenge.
|
|
|
500
500
|
|
|
501
501
|
| Property | Type | Description | Defined in |
|
|
502
502
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L24) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L18) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L20) |
|
|
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.5/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L22) |
|
|
507
507
|
|
|
508
508
|
***
|
|
509
509
|
|
|
510
510
|
#### WalletVerificationOptions
|
|
511
511
|
|
|
512
|
-
Defined in: [sdk/viem/src/viem.ts:101](https://github.com/settlemint/sdk/blob/v2.5.
|
|
512
|
+
Defined in: [sdk/viem/src/viem.ts:101](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L101)
|
|
513
513
|
|
|
514
514
|
The options for the wallet client.
|
|
515
515
|
|
|
@@ -517,8 +517,8 @@ The options for the wallet client.
|
|
|
517
517
|
|
|
518
518
|
| Property | Type | Description | Defined in |
|
|
519
519
|
| ------ | ------ | ------ | ------ |
|
|
520
|
-
| <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:109](https://github.com/settlemint/sdk/blob/v2.5.
|
|
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:105](https://github.com/settlemint/sdk/blob/v2.5.
|
|
520
|
+
| <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:109](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L109) |
|
|
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:105](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L105) |
|
|
522
522
|
|
|
523
523
|
### Type Aliases
|
|
524
524
|
|
|
@@ -526,7 +526,7 @@ The options for the wallet client.
|
|
|
526
526
|
|
|
527
527
|
> **AddressOrObject** = `string` \| \{ `userWalletAddress`: `string`; `verificationId?`: `string`; \}
|
|
528
528
|
|
|
529
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
529
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L6)
|
|
530
530
|
|
|
531
531
|
Represents either a wallet address string or an object containing wallet address and optional verification ID.
|
|
532
532
|
|
|
@@ -536,7 +536,7 @@ Represents either a wallet address string or an object containing wallet address
|
|
|
536
536
|
|
|
537
537
|
> **ClientOptions** = `Omit`\<`z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
538
538
|
|
|
539
|
-
Defined in: [sdk/viem/src/viem.ts:51](https://github.com/settlemint/sdk/blob/v2.5.
|
|
539
|
+
Defined in: [sdk/viem/src/viem.ts:51](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L51)
|
|
540
540
|
|
|
541
541
|
Type representing the validated client options.
|
|
542
542
|
|
|
@@ -544,7 +544,7 @@ Type representing the validated client options.
|
|
|
544
544
|
|
|
545
545
|
| Name | Type | Defined in |
|
|
546
546
|
| ------ | ------ | ------ |
|
|
547
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:52](https://github.com/settlemint/sdk/blob/v2.5.
|
|
547
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:52](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L52) |
|
|
548
548
|
|
|
549
549
|
***
|
|
550
550
|
|
|
@@ -552,7 +552,7 @@ Type representing the validated client options.
|
|
|
552
552
|
|
|
553
553
|
> **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)[]
|
|
554
554
|
|
|
555
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.
|
|
555
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L30)
|
|
556
556
|
|
|
557
557
|
Response from creating wallet verification challenges.
|
|
558
558
|
|
|
@@ -562,7 +562,7 @@ Response from creating wallet verification challenges.
|
|
|
562
562
|
|
|
563
563
|
> **GetChainIdOptions** = `Omit`\<`z.infer`\<*typeof* [`GetChainIdOptionsSchema`](#getchainidoptionsschema)\>, `"httpTransportConfig"`\> & `object`
|
|
564
564
|
|
|
565
|
-
Defined in: [sdk/viem/src/viem.ts:198](https://github.com/settlemint/sdk/blob/v2.5.
|
|
565
|
+
Defined in: [sdk/viem/src/viem.ts:198](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L198)
|
|
566
566
|
|
|
567
567
|
Type representing the validated get chain id options.
|
|
568
568
|
|
|
@@ -570,7 +570,7 @@ Type representing the validated get chain id options.
|
|
|
570
570
|
|
|
571
571
|
| Name | Type | Defined in |
|
|
572
572
|
| ------ | ------ | ------ |
|
|
573
|
-
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:199](https://github.com/settlemint/sdk/blob/v2.5.
|
|
573
|
+
| `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:199](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L199) |
|
|
574
574
|
|
|
575
575
|
***
|
|
576
576
|
|
|
@@ -578,7 +578,7 @@ Type representing the validated get chain id options.
|
|
|
578
578
|
|
|
579
579
|
> **GetWalletVerificationsResponse** = [`WalletVerification`](#walletverification)[]
|
|
580
580
|
|
|
581
|
-
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.
|
|
581
|
+
Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
|
|
582
582
|
|
|
583
583
|
Response from getting wallet verifications.
|
|
584
584
|
|
|
@@ -588,7 +588,7 @@ Response from getting wallet verifications.
|
|
|
588
588
|
|
|
589
589
|
> **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
|
|
590
590
|
|
|
591
|
-
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.5.
|
|
591
|
+
Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L34)
|
|
592
592
|
|
|
593
593
|
Response from verifying a wallet verification challenge.
|
|
594
594
|
|
|
@@ -598,7 +598,7 @@ Response from verifying a wallet verification challenge.
|
|
|
598
598
|
|
|
599
599
|
> **WalletVerificationInfo** = [`WalletPincodeVerificationInfo`](#walletpincodeverificationinfo) \| [`WalletOTPVerificationInfo`](#walletotpverificationinfo) \| [`WalletSecretCodesVerificationInfo`](#walletsecretcodesverificationinfo)
|
|
600
600
|
|
|
601
|
-
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.
|
|
601
|
+
Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
|
|
602
602
|
|
|
603
603
|
Union type of all possible wallet verification information types.
|
|
604
604
|
|
|
@@ -608,7 +608,7 @@ Union type of all possible wallet verification information types.
|
|
|
608
608
|
|
|
609
609
|
> `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
610
610
|
|
|
611
|
-
Defined in: [sdk/viem/src/viem.ts:25](https://github.com/settlemint/sdk/blob/v2.5.
|
|
611
|
+
Defined in: [sdk/viem/src/viem.ts:25](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L25)
|
|
612
612
|
|
|
613
613
|
Schema for the viem client options.
|
|
614
614
|
|
|
@@ -618,7 +618,7 @@ Schema for the viem client options.
|
|
|
618
618
|
|
|
619
619
|
> `const` **GetChainIdOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
|
|
620
620
|
|
|
621
|
-
Defined in: [sdk/viem/src/viem.ts:180](https://github.com/settlemint/sdk/blob/v2.5.
|
|
621
|
+
Defined in: [sdk/viem/src/viem.ts:180](https://github.com/settlemint/sdk/blob/v2.5.5/sdk/viem/src/viem.ts#L180)
|
|
622
622
|
|
|
623
623
|
Schema for the viem client options.
|
|
624
624
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@settlemint/sdk-viem",
|
|
3
3
|
"description": "Viem (TypeScript Interface for Ethereum) module for SettleMint SDK",
|
|
4
|
-
"version": "2.5.
|
|
4
|
+
"version": "2.5.5-main5537f734",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"private": false,
|
|
7
7
|
"license": "FSL-1.1-MIT",
|
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {},
|
|
55
55
|
"dependencies": {
|
|
56
|
-
"@settlemint/sdk-utils": "2.5.
|
|
56
|
+
"@settlemint/sdk-utils": "2.5.5-main5537f734",
|
|
57
57
|
"viem": "^2",
|
|
58
58
|
"zod": "^4"
|
|
59
59
|
},
|