@settlemint/sdk-viem 2.3.1 → 2.3.2

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.
Files changed (2) hide show
  1. package/README.md +85 -85
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -74,7 +74,7 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
74
74
 
75
75
  > **getPublicClient**(`options`): `object`
76
76
 
77
- Defined in: [sdk/viem/src/viem.ts:64](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L64)
77
+ Defined in: [sdk/viem/src/viem.ts:64](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L64)
78
78
 
79
79
  Get a public client. Use this if you need to read from the blockchain.
80
80
 
@@ -113,7 +113,7 @@ console.log(block);
113
113
 
114
114
  > **getWalletClient**(`options`): (`verificationOptions?`) => `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
115
115
 
116
- Defined in: [sdk/viem/src/viem.ts:126](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L126)
116
+ Defined in: [sdk/viem/src/viem.ts:126](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L126)
117
117
 
118
118
  Get a wallet client. Use this if you need to write to the blockchain.
119
119
 
@@ -171,7 +171,7 @@ console.log(transactionHash);
171
171
 
172
172
  #### OTPAlgorithm
173
173
 
174
- Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
174
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
175
175
 
176
176
  Supported hash algorithms for One-Time Password (OTP) verification.
177
177
  These algorithms determine the cryptographic function used to generate OTP codes.
@@ -180,21 +180,21 @@ These algorithms determine the cryptographic function used to generate OTP codes
180
180
 
181
181
  | Enumeration Member | Value | Description | Defined in |
182
182
  | ------ | ------ | ------ | ------ |
183
- | <a id="sha1"></a> `SHA1` | `"SHA1"` | SHA-1 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:20](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L20) |
184
- | <a id="sha224"></a> `SHA224` | `"SHA224"` | SHA-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:22](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L22) |
185
- | <a id="sha256"></a> `SHA256` | `"SHA256"` | SHA-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:24](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L24) |
186
- | <a id="sha3_224"></a> `SHA3_224` | `"SHA3-224"` | SHA3-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:30](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L30) |
187
- | <a id="sha3_256"></a> `SHA3_256` | `"SHA3-256"` | SHA3-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:32](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L32) |
188
- | <a id="sha3_384"></a> `SHA3_384` | `"SHA3-384"` | SHA3-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:34](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L34) |
189
- | <a id="sha3_512"></a> `SHA3_512` | `"SHA3-512"` | SHA3-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:36](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L36) |
190
- | <a id="sha384"></a> `SHA384` | `"SHA384"` | SHA-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:26](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L26) |
191
- | <a id="sha512"></a> `SHA512` | `"SHA512"` | SHA-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:28](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
183
+ | <a id="sha1"></a> `SHA1` | `"SHA1"` | SHA-1 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:20](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L20) |
184
+ | <a id="sha224"></a> `SHA224` | `"SHA224"` | SHA-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:22](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L22) |
185
+ | <a id="sha256"></a> `SHA256` | `"SHA256"` | SHA-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:24](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L24) |
186
+ | <a id="sha3_224"></a> `SHA3_224` | `"SHA3-224"` | SHA3-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:30](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L30) |
187
+ | <a id="sha3_256"></a> `SHA3_256` | `"SHA3-256"` | SHA3-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:32](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L32) |
188
+ | <a id="sha3_384"></a> `SHA3_384` | `"SHA3-384"` | SHA3-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:34](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L34) |
189
+ | <a id="sha3_512"></a> `SHA3_512` | `"SHA3-512"` | SHA3-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:36](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L36) |
190
+ | <a id="sha384"></a> `SHA384` | `"SHA384"` | SHA-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:26](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L26) |
191
+ | <a id="sha512"></a> `SHA512` | `"SHA512"` | SHA-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:28](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
192
192
 
193
193
  ***
194
194
 
195
195
  #### WalletVerificationType
196
196
 
197
- Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
197
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
198
198
 
199
199
  Types of wallet verification methods supported by the system.
200
200
  Used to identify different verification mechanisms when creating or managing wallet verifications.
@@ -203,15 +203,15 @@ Used to identify different verification mechanisms when creating or managing wal
203
203
 
204
204
  | Enumeration Member | Value | Description | Defined in |
205
205
  | ------ | ------ | ------ | ------ |
206
- | <a id="otp"></a> `OTP` | `"OTP"` | One-Time Password verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:9](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L9) |
207
- | <a id="pincode"></a> `PINCODE` | `"PINCODE"` | PIN code verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:7](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L7) |
208
- | <a id="secret_codes"></a> `SECRET_CODES` | `"SECRET_CODES"` | Secret recovery codes verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:11](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
206
+ | <a id="otp"></a> `OTP` | `"OTP"` | One-Time Password verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:9](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L9) |
207
+ | <a id="pincode"></a> `PINCODE` | `"PINCODE"` | PIN code verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:7](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L7) |
208
+ | <a id="secret_codes"></a> `SECRET_CODES` | `"SECRET_CODES"` | Secret recovery codes verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:11](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
209
209
 
210
210
  ### Interfaces
211
211
 
212
212
  #### ClientOptions
213
213
 
214
- Defined in: [sdk/viem/src/viem.ts:21](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L21)
214
+ Defined in: [sdk/viem/src/viem.ts:21](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L21)
215
215
 
216
216
  The options for the viem client.
217
217
 
@@ -219,17 +219,17 @@ The options for the viem client.
219
219
 
220
220
  | Property | Type | Description | Defined in |
221
221
  | ------ | ------ | ------ | ------ |
222
- | <a id="accesstoken"></a> `accessToken` | `string` | The access token | [sdk/viem/src/viem.ts:25](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L25) |
223
- | <a id="chainid"></a> `chainId` | `string` | The chain id | [sdk/viem/src/viem.ts:29](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L29) |
224
- | <a id="chainname"></a> `chainName` | `string` | The chain name | [sdk/viem/src/viem.ts:33](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L33) |
225
- | <a id="httptransportconfig"></a> `httpTransportConfig?` | `HttpTransportConfig` | The http transport config | [sdk/viem/src/viem.ts:41](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L41) |
226
- | <a id="rpcurl"></a> `rpcUrl` | `string` | The json rpc url | [sdk/viem/src/viem.ts:37](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L37) |
222
+ | <a id="accesstoken"></a> `accessToken` | `string` | The access token | [sdk/viem/src/viem.ts:25](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L25) |
223
+ | <a id="chainid"></a> `chainId` | `string` | The chain id | [sdk/viem/src/viem.ts:29](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L29) |
224
+ | <a id="chainname"></a> `chainName` | `string` | The chain name | [sdk/viem/src/viem.ts:33](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L33) |
225
+ | <a id="httptransportconfig"></a> `httpTransportConfig?` | `HttpTransportConfig` | The http transport config | [sdk/viem/src/viem.ts:41](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L41) |
226
+ | <a id="rpcurl"></a> `rpcUrl` | `string` | The json rpc url | [sdk/viem/src/viem.ts:37](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L37) |
227
227
 
228
228
  ***
229
229
 
230
230
  #### CreateWalletParameters
231
231
 
232
- Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
232
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
233
233
 
234
234
  Parameters for creating a wallet.
235
235
 
@@ -237,14 +237,14 @@ Parameters for creating a wallet.
237
237
 
238
238
  | Property | Type | Description | Defined in |
239
239
  | ------ | ------ | ------ | ------ |
240
- | <a id="keyvaultid"></a> `keyVaultId` | `string` | The unique name of the key vault where the wallet will be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet.action.ts#L16) |
241
- | <a id="walletinfo"></a> `walletInfo` | [`WalletInfo`](#walletinfo-1) | Information about the wallet to be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:18](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
240
+ | <a id="keyvaultid"></a> `keyVaultId` | `string` | The unique name of the key vault where the wallet will be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet.action.ts#L16) |
241
+ | <a id="walletinfo"></a> `walletInfo` | [`WalletInfo`](#walletinfo-1) | Information about the wallet to be created. | [sdk/viem/src/custom-actions/create-wallet.action.ts:18](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
242
242
 
243
243
  ***
244
244
 
245
245
  #### CreateWalletResponse
246
246
 
247
- Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
247
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
248
248
 
249
249
  Response from creating a wallet.
250
250
 
@@ -252,16 +252,16 @@ Response from creating a wallet.
252
252
 
253
253
  | Property | Type | Description | Defined in |
254
254
  | ------ | ------ | ------ | ------ |
255
- | <a id="address"></a> `address` | `string` | The blockchain address of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:30](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet.action.ts#L30) |
256
- | <a id="derivationpath"></a> `derivationPath` | `string` | The HD derivation path used to create the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:32](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet.action.ts#L32) |
257
- | <a id="id"></a> `id` | `string` | The unique identifier of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:26](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet.action.ts#L26) |
258
- | <a id="name"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:28](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
255
+ | <a id="address"></a> `address` | `string` | The blockchain address of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:30](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet.action.ts#L30) |
256
+ | <a id="derivationpath"></a> `derivationPath` | `string` | The HD derivation path used to create the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:32](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet.action.ts#L32) |
257
+ | <a id="id"></a> `id` | `string` | The unique identifier of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:26](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet.action.ts#L26) |
258
+ | <a id="name"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:28](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
259
259
 
260
260
  ***
261
261
 
262
262
  #### CreateWalletVerificationChallengesParameters
263
263
 
264
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
264
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
265
265
 
266
266
  Parameters for creating wallet verification challenges.
267
267
 
@@ -269,13 +269,13 @@ Parameters for creating wallet verification challenges.
269
269
 
270
270
  | Property | Type | Description | Defined in |
271
271
  | ------ | ------ | ------ | ------ |
272
- | <a id="addressorobject"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:10](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
272
+ | <a id="addressorobject"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:10](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
273
273
 
274
274
  ***
275
275
 
276
276
  #### CreateWalletVerificationParameters
277
277
 
278
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
278
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
279
279
 
280
280
  Parameters for creating a wallet verification.
281
281
 
@@ -283,14 +283,14 @@ Parameters for creating a wallet verification.
283
283
 
284
284
  | Property | Type | Description | Defined in |
285
285
  | ------ | ------ | ------ | ------ |
286
- | <a id="userwalletaddress"></a> `userWalletAddress` | `string` | The wallet address for which to create the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:61](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
287
- | <a id="walletverificationinfo"></a> `walletVerificationInfo` | [`WalletVerificationInfo`](#walletverificationinfo-1) | The verification information to create. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:63](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
286
+ | <a id="userwalletaddress"></a> `userWalletAddress` | `string` | The wallet address for which to create the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:61](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L61) |
287
+ | <a id="walletverificationinfo"></a> `walletVerificationInfo` | [`WalletVerificationInfo`](#walletverificationinfo-1) | The verification information to create. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:63](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
288
288
 
289
289
  ***
290
290
 
291
291
  #### CreateWalletVerificationResponse
292
292
 
293
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
293
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
294
294
 
295
295
  Response from creating a wallet verification.
296
296
 
@@ -298,16 +298,16 @@ Response from creating a wallet verification.
298
298
 
299
299
  | Property | Type | Description | Defined in |
300
300
  | ------ | ------ | ------ | ------ |
301
- | <a id="id-1"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:71](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L71) |
302
- | <a id="name-1"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:73](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L73) |
303
- | <a id="parameters"></a> `parameters` | `Record`\<`string`, `string`\> | Additional parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:77](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L77) |
304
- | <a id="verificationtype"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:75](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
301
+ | <a id="id-1"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:71](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L71) |
302
+ | <a id="name-1"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:73](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L73) |
303
+ | <a id="parameters"></a> `parameters` | `Record`\<`string`, `string`\> | Additional parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:77](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L77) |
304
+ | <a id="verificationtype"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:75](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
305
305
 
306
306
  ***
307
307
 
308
308
  #### DeleteWalletVerificationParameters
309
309
 
310
- Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
310
+ Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
311
311
 
312
312
  Parameters for deleting a wallet verification.
313
313
 
@@ -315,14 +315,14 @@ Parameters for deleting a wallet verification.
315
315
 
316
316
  | Property | Type | Description | Defined in |
317
317
  | ------ | ------ | ------ | ------ |
318
- | <a id="userwalletaddress-1"></a> `userWalletAddress` | `string` | The wallet address for which to delete the verification. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:8](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L8) |
319
- | <a id="verificationid"></a> `verificationId` | `string` | The unique identifier of the verification to delete. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:10](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
318
+ | <a id="userwalletaddress-1"></a> `userWalletAddress` | `string` | The wallet address for which to delete the verification. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:8](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L8) |
319
+ | <a id="verificationid"></a> `verificationId` | `string` | The unique identifier of the verification to delete. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:10](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
320
320
 
321
321
  ***
322
322
 
323
323
  #### DeleteWalletVerificationResponse
324
324
 
325
- Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
325
+ Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
326
326
 
327
327
  Response from deleting a wallet verification.
328
328
 
@@ -330,13 +330,13 @@ Response from deleting a wallet verification.
330
330
 
331
331
  | Property | Type | Description | Defined in |
332
332
  | ------ | ------ | ------ | ------ |
333
- | <a id="success"></a> `success` | `boolean` | Whether the deletion was successful. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:18](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
333
+ | <a id="success"></a> `success` | `boolean` | Whether the deletion was successful. | [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:18](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
334
334
 
335
335
  ***
336
336
 
337
337
  #### GetWalletVerificationsParameters
338
338
 
339
- Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
339
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
340
340
 
341
341
  Parameters for getting wallet verifications.
342
342
 
@@ -344,13 +344,13 @@ Parameters for getting wallet verifications.
344
344
 
345
345
  | Property | Type | Description | Defined in |
346
346
  | ------ | ------ | ------ | ------ |
347
- | <a id="userwalletaddress-2"></a> `userWalletAddress` | `string` | The wallet address for which to fetch verifications. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:9](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
347
+ | <a id="userwalletaddress-2"></a> `userWalletAddress` | `string` | The wallet address for which to fetch verifications. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:9](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
348
348
 
349
349
  ***
350
350
 
351
351
  #### VerificationResult
352
352
 
353
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L26)
353
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L26)
354
354
 
355
355
  Result of a wallet verification challenge.
356
356
 
@@ -358,13 +358,13 @@ Result of a wallet verification challenge.
358
358
 
359
359
  | Property | Type | Description | Defined in |
360
360
  | ------ | ------ | ------ | ------ |
361
- | <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:28](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28) |
361
+ | <a id="verified"></a> `verified` | `boolean` | Whether the verification was successful. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:28](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28) |
362
362
 
363
363
  ***
364
364
 
365
365
  #### VerifyWalletVerificationChallengeParameters
366
366
 
367
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L16)
367
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L16)
368
368
 
369
369
  Parameters for verifying a wallet verification challenge.
370
370
 
@@ -372,14 +372,14 @@ Parameters for verifying a wallet verification challenge.
372
372
 
373
373
  | Property | Type | Description | Defined in |
374
374
  | ------ | ------ | ------ | ------ |
375
- | <a id="addressorobject-1"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L18) |
376
- | <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:20](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L20) |
375
+ | <a id="addressorobject-1"></a> `addressOrObject` | [`AddressOrObject`](#addressorobject-2) | The wallet address or object containing wallet address and optional verification ID. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:18](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L18) |
376
+ | <a id="challengeresponse"></a> `challengeResponse` | `string` | The response to the verification challenge. | [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:20](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L20) |
377
377
 
378
378
  ***
379
379
 
380
380
  #### WalletInfo
381
381
 
382
- Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
382
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
383
383
 
384
384
  Information about the wallet to be created.
385
385
 
@@ -387,13 +387,13 @@ Information about the wallet to be created.
387
387
 
388
388
  | Property | Type | Description | Defined in |
389
389
  | ------ | ------ | ------ | ------ |
390
- | <a id="name-2"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:8](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
390
+ | <a id="name-2"></a> `name` | `string` | The name of the wallet. | [sdk/viem/src/custom-actions/create-wallet.action.ts:8](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
391
391
 
392
392
  ***
393
393
 
394
394
  #### WalletOTPVerificationInfo
395
395
 
396
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
396
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
397
397
 
398
398
  Information for One-Time Password (OTP) verification.
399
399
 
@@ -405,18 +405,18 @@ Information for One-Time Password (OTP) verification.
405
405
 
406
406
  | Property | Type | Description | Overrides | Inherited from | Defined in |
407
407
  | ------ | ------ | ------ | ------ | ------ | ------ |
408
- | <a id="algorithm"></a> `algorithm?` | [`OTPAlgorithm`](#otpalgorithm) | The hash algorithm to use for OTP generation. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:31](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L31) |
409
- | <a id="digits"></a> `digits?` | `number` | The number of digits in the OTP code. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:33](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L33) |
410
- | <a id="issuer"></a> `issuer?` | `string` | The issuer of the OTP. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:37](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L37) |
411
- | <a id="name-3"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
412
- | <a id="period"></a> `period?` | `number` | The time period in seconds for OTP validity. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:35](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L35) |
413
- | <a id="verificationtype-1"></a> `verificationType` | [`OTP`](#otp) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:29](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
408
+ | <a id="algorithm"></a> `algorithm?` | [`OTPAlgorithm`](#otpalgorithm) | The hash algorithm to use for OTP generation. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:31](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L31) |
409
+ | <a id="digits"></a> `digits?` | `number` | The number of digits in the OTP code. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:33](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L33) |
410
+ | <a id="issuer"></a> `issuer?` | `string` | The issuer of the OTP. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:37](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L37) |
411
+ | <a id="name-3"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
412
+ | <a id="period"></a> `period?` | `number` | The time period in seconds for OTP validity. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:35](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L35) |
413
+ | <a id="verificationtype-1"></a> `verificationType` | [`OTP`](#otp) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:29](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
414
414
 
415
415
  ***
416
416
 
417
417
  #### WalletPincodeVerificationInfo
418
418
 
419
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
419
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
420
420
 
421
421
  Information for PIN code verification.
422
422
 
@@ -428,15 +428,15 @@ Information for PIN code verification.
428
428
 
429
429
  | Property | Type | Description | Overrides | Inherited from | Defined in |
430
430
  | ------ | ------ | ------ | ------ | ------ | ------ |
431
- | <a id="name-4"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
432
- | <a id="pincode-1"></a> `pincode` | `string` | The PIN code to use for verification. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:21](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L21) |
433
- | <a id="verificationtype-2"></a> `verificationType` | [`PINCODE`](#pincode) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:19](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
431
+ | <a id="name-4"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
432
+ | <a id="pincode-1"></a> `pincode` | `string` | The PIN code to use for verification. | - | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:21](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L21) |
433
+ | <a id="verificationtype-2"></a> `verificationType` | [`PINCODE`](#pincode) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:19](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
434
434
 
435
435
  ***
436
436
 
437
437
  #### WalletSecretCodesVerificationInfo
438
438
 
439
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
439
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
440
440
 
441
441
  Information for secret recovery codes verification.
442
442
 
@@ -448,14 +448,14 @@ Information for secret recovery codes verification.
448
448
 
449
449
  | Property | Type | Description | Overrides | Inherited from | Defined in |
450
450
  | ------ | ------ | ------ | ------ | ------ | ------ |
451
- | <a id="name-5"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
452
- | <a id="verificationtype-3"></a> `verificationType` | [`SECRET_CODES`](#secret_codes) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:45](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
451
+ | <a id="name-5"></a> `name` | `string` | The name of the verification method. | - | `BaseWalletVerificationInfo.name` | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:9](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L9) |
452
+ | <a id="verificationtype-3"></a> `verificationType` | [`SECRET_CODES`](#secret_codes) | The type of verification method. | `BaseWalletVerificationInfo.verificationType` | - | [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:45](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
453
453
 
454
454
  ***
455
455
 
456
456
  #### WalletVerification
457
457
 
458
- Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
458
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
459
459
 
460
460
  Represents a wallet verification.
461
461
 
@@ -463,15 +463,15 @@ Represents a wallet verification.
463
463
 
464
464
  | Property | Type | Description | Defined in |
465
465
  | ------ | ------ | ------ | ------ |
466
- | <a id="id-2"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:17](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L17) |
467
- | <a id="name-6"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:19](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L19) |
468
- | <a id="verificationtype-4"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:21](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
466
+ | <a id="id-2"></a> `id` | `string` | The unique identifier of the verification. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:17](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L17) |
467
+ | <a id="name-6"></a> `name` | `string` | The name of the verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:19](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L19) |
468
+ | <a id="verificationtype-4"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification method. | [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:21](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
469
469
 
470
470
  ***
471
471
 
472
472
  #### WalletVerificationChallenge
473
473
 
474
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
474
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
475
475
 
476
476
  Represents a wallet verification challenge.
477
477
 
@@ -479,16 +479,16 @@ Represents a wallet verification challenge.
479
479
 
480
480
  | Property | Type | Description | Defined in |
481
481
  | ------ | ------ | ------ | ------ |
482
- | <a id="challenge"></a> `challenge` | `Record`\<`string`, `string`\> | The challenge parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:24](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L24) |
483
- | <a id="id-3"></a> `id` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:18](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L18) |
484
- | <a id="name-7"></a> `name` | `string` | The name of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:20](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L20) |
485
- | <a id="verificationtype-5"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification required. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:22](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L22) |
482
+ | <a id="challenge"></a> `challenge` | `Record`\<`string`, `string`\> | The challenge parameters specific to the verification type. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:24](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L24) |
483
+ | <a id="id-3"></a> `id` | `string` | The unique identifier of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:18](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L18) |
484
+ | <a id="name-7"></a> `name` | `string` | The name of the challenge. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:20](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L20) |
485
+ | <a id="verificationtype-5"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification required. | [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:22](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L22) |
486
486
 
487
487
  ***
488
488
 
489
489
  #### WalletVerificationOptions
490
490
 
491
- Defined in: [sdk/viem/src/viem.ts:84](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L84)
491
+ Defined in: [sdk/viem/src/viem.ts:84](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L84)
492
492
 
493
493
  The options for the wallet client.
494
494
 
@@ -496,8 +496,8 @@ The options for the wallet client.
496
496
 
497
497
  | Property | Type | Description | Defined in |
498
498
  | ------ | ------ | ------ | ------ |
499
- | <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:92](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L92) |
500
- | <a id="verificationid-1"></a> `verificationId?` | `string` | The verification id (used for HD wallets), if not provided, the challenge response will be validated against all active verifications. | [sdk/viem/src/viem.ts:88](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/viem.ts#L88) |
499
+ | <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:92](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L92) |
500
+ | <a id="verificationid-1"></a> `verificationId?` | `string` | The verification id (used for HD wallets), if not provided, the challenge response will be validated against all active verifications. | [sdk/viem/src/viem.ts:88](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L88) |
501
501
 
502
502
  ### Type Aliases
503
503
 
@@ -505,7 +505,7 @@ The options for the wallet client.
505
505
 
506
506
  > **AddressOrObject** = `string` \| \{ `userWalletAddress`: `string`; `verificationId?`: `string`; \}
507
507
 
508
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L6)
508
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L6)
509
509
 
510
510
  Represents either a wallet address string or an object containing wallet address and optional verification ID.
511
511
 
@@ -515,7 +515,7 @@ Represents either a wallet address string or an object containing wallet address
515
515
 
516
516
  > **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)[]
517
517
 
518
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L30)
518
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L30)
519
519
 
520
520
  Response from creating wallet verification challenges.
521
521
 
@@ -525,7 +525,7 @@ Response from creating wallet verification challenges.
525
525
 
526
526
  > **GetWalletVerificationsResponse** = [`WalletVerification`](#walletverification)[]
527
527
 
528
- Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
528
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
529
529
 
530
530
  Response from getting wallet verifications.
531
531
 
@@ -535,7 +535,7 @@ Response from getting wallet verifications.
535
535
 
536
536
  > **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
537
537
 
538
- Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L34)
538
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L34)
539
539
 
540
540
  Response from verifying a wallet verification challenge.
541
541
 
@@ -545,7 +545,7 @@ Response from verifying a wallet verification challenge.
545
545
 
546
546
  > **WalletVerificationInfo** = [`WalletPincodeVerificationInfo`](#walletpincodeverificationinfo) \| [`WalletOTPVerificationInfo`](#walletotpverificationinfo) \| [`WalletSecretCodesVerificationInfo`](#walletsecretcodesverificationinfo)
547
547
 
548
- Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
548
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
549
549
 
550
550
  Union type of all possible wallet verification information types.
551
551
 
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.3.1",
4
+ "version": "2.3.2",
5
5
  "type": "module",
6
6
  "private": false,
7
7
  "license": "FSL-1.1-MIT",
@@ -51,7 +51,7 @@
51
51
  },
52
52
  "devDependencies": {},
53
53
  "dependencies": {
54
- "@settlemint/sdk-utils": "2.3.1",
54
+ "@settlemint/sdk-utils": "2.3.2",
55
55
  "viem": "^2"
56
56
  },
57
57
  "peerDependencies": {},