@settlemint/sdk-viem 2.3.2 → 2.3.3-pr94c5517e

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 (13) hide show
  1. package/README.md +173 -100
  2. package/dist/browser/viem.d.ts +14190 -0
  3. package/dist/browser/viem.js +10506 -0
  4. package/dist/browser/viem.js.map +1 -0
  5. package/dist/viem.cjs +10530 -1
  6. package/dist/viem.cjs.map +1 -1
  7. package/dist/viem.d.cts +14038 -13922
  8. package/dist/viem.d.ts +14038 -13922
  9. package/dist/viem.js +10507 -0
  10. package/dist/viem.js.map +1 -0
  11. package/package.json +6 -6
  12. package/dist/viem.mjs +0 -2
  13. package/dist/viem.mjs.map +0 -1
package/README.md CHANGED
@@ -29,13 +29,13 @@
29
29
  - [About](#about)
30
30
  - [API Reference](#api-reference)
31
31
  - [Functions](#functions)
32
+ - [getChainId()](#getchainid)
32
33
  - [getPublicClient()](#getpublicclient)
33
34
  - [getWalletClient()](#getwalletclient)
34
35
  - [Enumerations](#enumerations)
35
36
  - [OTPAlgorithm](#otpalgorithm)
36
37
  - [WalletVerificationType](#walletverificationtype)
37
38
  - [Interfaces](#interfaces)
38
- - [ClientOptions](#clientoptions)
39
39
  - [CreateWalletParameters](#createwalletparameters)
40
40
  - [CreateWalletResponse](#createwalletresponse)
41
41
  - [CreateWalletVerificationChallengesParameters](#createwalletverificationchallengesparameters)
@@ -55,10 +55,15 @@
55
55
  - [WalletVerificationOptions](#walletverificationoptions)
56
56
  - [Type Aliases](#type-aliases)
57
57
  - [AddressOrObject](#addressorobject)
58
+ - [ClientOptions](#clientoptions)
58
59
  - [CreateWalletVerificationChallengesResponse](#createwalletverificationchallengesresponse)
60
+ - [GetChainIdOptions](#getchainidoptions)
59
61
  - [GetWalletVerificationsResponse](#getwalletverificationsresponse)
60
62
  - [VerifyWalletVerificationChallengeResponse](#verifywalletverificationchallengeresponse)
61
63
  - [WalletVerificationInfo](#walletverificationinfo)
64
+ - [Variables](#variables)
65
+ - [ClientOptionsSchema](#clientoptionsschema)
66
+ - [GetChainIdOptionsSchema](#getchainidoptionsschema)
62
67
  - [Contributing](#contributing)
63
68
  - [License](#license)
64
69
 
@@ -70,11 +75,45 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
70
75
 
71
76
  ### Functions
72
77
 
78
+ #### getChainId()
79
+
80
+ > **getChainId**(`options`): `Promise`\<`number`\>
81
+
82
+ Defined in: [sdk/viem/src/viem.ts:217](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/viem.ts#L217)
83
+
84
+ Get the chain id of a blockchain network.
85
+
86
+ ##### Parameters
87
+
88
+ | Parameter | Type | Description |
89
+ | ------ | ------ | ------ |
90
+ | `options` | [`GetChainIdOptions`](#getchainidoptions) | The options for the public client. |
91
+
92
+ ##### Returns
93
+
94
+ `Promise`\<`number`\>
95
+
96
+ The chain id.
97
+
98
+ ##### Example
99
+
100
+ ```ts
101
+ import { getChainId } from '@settlemint/sdk-viem';
102
+
103
+ const chainId = await getChainId({
104
+ accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
105
+ rpcUrl: process.env.SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT!,
106
+ });
107
+ console.log(chainId);
108
+ ```
109
+
110
+ ***
111
+
73
112
  #### getPublicClient()
74
113
 
75
114
  > **getPublicClient**(`options`): `object`
76
115
 
77
- Defined in: [sdk/viem/src/viem.ts:64](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L64)
116
+ Defined in: [sdk/viem/src/viem.ts:75](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/viem.ts#L75)
78
117
 
79
118
  Get a public client. Use this if you need to read from the blockchain.
80
119
 
@@ -96,7 +135,7 @@ The public client. see [https://viem.sh/docs/clients/public](https://viem.sh/doc
96
135
  import { getPublicClient } from '@settlemint/sdk-viem';
97
136
 
98
137
  const publicClient = getPublicClient({
99
- accessToken: process.env.SETTLEMINT_ACCESS_TOKEN!,
138
+ accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
100
139
  chainId: process.env.SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID!,
101
140
  chainName: process.env.SETTLEMINT_BLOCKCHAIN_NETWORK!,
102
141
  rpcUrl: process.env.SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT!,
@@ -113,7 +152,7 @@ console.log(block);
113
152
 
114
153
  > **getWalletClient**(`options`): (`verificationOptions?`) => `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`Chain`, `undefined`\>\>
115
154
 
116
- Defined in: [sdk/viem/src/viem.ts:126](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L126)
155
+ Defined in: [sdk/viem/src/viem.ts:143](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/viem.ts#L143)
117
156
 
118
157
  Get a wallet client. Use this if you need to write to the blockchain.
119
158
 
@@ -146,7 +185,7 @@ import { getWalletClient } from '@settlemint/sdk-viem';
146
185
  import { parseAbi } from "viem";
147
186
 
148
187
  const walletClient = getWalletClient({
149
- accessToken: process.env.SETTLEMINT_ACCESS_TOKEN!,
188
+ accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
150
189
  chainId: process.env.SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID!,
151
190
  chainName: process.env.SETTLEMINT_BLOCKCHAIN_NETWORK!,
152
191
  rpcUrl: process.env.SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT!,
@@ -171,7 +210,7 @@ console.log(transactionHash);
171
210
 
172
211
  #### OTPAlgorithm
173
212
 
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)
213
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
175
214
 
176
215
  Supported hash algorithms for One-Time Password (OTP) verification.
177
216
  These algorithms determine the cryptographic function used to generate OTP codes.
@@ -180,21 +219,21 @@ These algorithms determine the cryptographic function used to generate OTP codes
180
219
 
181
220
  | Enumeration Member | Value | Description | Defined in |
182
221
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
192
231
 
193
232
  ***
194
233
 
195
234
  #### WalletVerificationType
196
235
 
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)
236
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
198
237
 
199
238
  Types of wallet verification methods supported by the system.
200
239
  Used to identify different verification mechanisms when creating or managing wallet verifications.
@@ -203,33 +242,15 @@ Used to identify different verification mechanisms when creating or managing wal
203
242
 
204
243
  | Enumeration Member | Value | Description | Defined in |
205
244
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/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.3.3/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
209
248
 
210
249
  ### Interfaces
211
250
 
212
- #### ClientOptions
213
-
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
-
216
- The options for the viem client.
217
-
218
- ##### Properties
219
-
220
- | Property | Type | Description | Defined in |
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.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
-
228
- ***
229
-
230
251
  #### CreateWalletParameters
231
252
 
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)
253
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:14](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet.action.ts#L14)
233
254
 
234
255
  Parameters for creating a wallet.
235
256
 
@@ -237,14 +258,14 @@ Parameters for creating a wallet.
237
258
 
238
259
  | Property | Type | Description | Defined in |
239
260
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/sdk/viem/src/custom-actions/create-wallet.action.ts#L18) |
242
263
 
243
264
  ***
244
265
 
245
266
  #### CreateWalletResponse
246
267
 
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)
268
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:24](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet.action.ts#L24)
248
269
 
249
270
  Response from creating a wallet.
250
271
 
@@ -252,16 +273,16 @@ Response from creating a wallet.
252
273
 
253
274
  | Property | Type | Description | Defined in |
254
275
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/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.3.3/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.3.3/sdk/viem/src/custom-actions/create-wallet.action.ts#L28) |
259
280
 
260
281
  ***
261
282
 
262
283
  #### CreateWalletVerificationChallengesParameters
263
284
 
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)
285
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L8)
265
286
 
266
287
  Parameters for creating wallet verification challenges.
267
288
 
@@ -269,13 +290,13 @@ Parameters for creating wallet verification challenges.
269
290
 
270
291
  | Property | Type | Description | Defined in |
271
292
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L10) |
273
294
 
274
295
  ***
275
296
 
276
297
  #### CreateWalletVerificationParameters
277
298
 
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)
299
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:59](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L59)
279
300
 
280
301
  Parameters for creating a wallet verification.
281
302
 
@@ -283,14 +304,14 @@ Parameters for creating a wallet verification.
283
304
 
284
305
  | Property | Type | Description | Defined in |
285
306
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L63) |
288
309
 
289
310
  ***
290
311
 
291
312
  #### CreateWalletVerificationResponse
292
313
 
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)
314
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:69](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L69)
294
315
 
295
316
  Response from creating a wallet verification.
296
317
 
@@ -298,16 +319,16 @@ Response from creating a wallet verification.
298
319
 
299
320
  | Property | Type | Description | Defined in |
300
321
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/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.3.3/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.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L75) |
305
326
 
306
327
  ***
307
328
 
308
329
  #### DeleteWalletVerificationParameters
309
330
 
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)
331
+ Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L6)
311
332
 
312
333
  Parameters for deleting a wallet verification.
313
334
 
@@ -315,14 +336,14 @@ Parameters for deleting a wallet verification.
315
336
 
316
337
  | Property | Type | Description | Defined in |
317
338
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L10) |
320
341
 
321
342
  ***
322
343
 
323
344
  #### DeleteWalletVerificationResponse
324
345
 
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)
346
+ Defined in: [sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L16)
326
347
 
327
348
  Response from deleting a wallet verification.
328
349
 
@@ -330,13 +351,13 @@ Response from deleting a wallet verification.
330
351
 
331
352
  | Property | Type | Description | Defined in |
332
353
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/sdk/viem/src/custom-actions/delete-wallet-verification.action.ts#L18) |
334
355
 
335
356
  ***
336
357
 
337
358
  #### GetWalletVerificationsParameters
338
359
 
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)
360
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L7)
340
361
 
341
362
  Parameters for getting wallet verifications.
342
363
 
@@ -344,13 +365,13 @@ Parameters for getting wallet verifications.
344
365
 
345
366
  | Property | Type | Description | Defined in |
346
367
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L9) |
348
369
 
349
370
  ***
350
371
 
351
372
  #### VerificationResult
352
373
 
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)
374
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L26)
354
375
 
355
376
  Result of a wallet verification challenge.
356
377
 
@@ -358,13 +379,13 @@ Result of a wallet verification challenge.
358
379
 
359
380
  | Property | Type | Description | Defined in |
360
381
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L28) |
362
383
 
363
384
  ***
364
385
 
365
386
  #### VerifyWalletVerificationChallengeParameters
366
387
 
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)
388
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L16)
368
389
 
369
390
  Parameters for verifying a wallet verification challenge.
370
391
 
@@ -372,14 +393,14 @@ Parameters for verifying a wallet verification challenge.
372
393
 
373
394
  | Property | Type | Description | Defined in |
374
395
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L20) |
377
398
 
378
399
  ***
379
400
 
380
401
  #### WalletInfo
381
402
 
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)
403
+ Defined in: [sdk/viem/src/custom-actions/create-wallet.action.ts:6](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet.action.ts#L6)
383
404
 
384
405
  Information about the wallet to be created.
385
406
 
@@ -387,13 +408,13 @@ Information about the wallet to be created.
387
408
 
388
409
  | Property | Type | Description | Defined in |
389
410
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/sdk/viem/src/custom-actions/create-wallet.action.ts#L8) |
391
412
 
392
413
  ***
393
414
 
394
415
  #### WalletOTPVerificationInfo
395
416
 
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)
417
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:27](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L27)
397
418
 
398
419
  Information for One-Time Password (OTP) verification.
399
420
 
@@ -405,18 +426,18 @@ Information for One-Time Password (OTP) verification.
405
426
 
406
427
  | Property | Type | Description | Overrides | Inherited from | Defined in |
407
428
  | ------ | ------ | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L29) |
414
435
 
415
436
  ***
416
437
 
417
438
  #### WalletPincodeVerificationInfo
418
439
 
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)
440
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:17](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L17)
420
441
 
421
442
  Information for PIN code verification.
422
443
 
@@ -428,15 +449,15 @@ Information for PIN code verification.
428
449
 
429
450
  | Property | Type | Description | Overrides | Inherited from | Defined in |
430
451
  | ------ | ------ | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/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.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L19) |
434
455
 
435
456
  ***
436
457
 
437
458
  #### WalletSecretCodesVerificationInfo
438
459
 
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)
460
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:43](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L43)
440
461
 
441
462
  Information for secret recovery codes verification.
442
463
 
@@ -448,14 +469,14 @@ Information for secret recovery codes verification.
448
469
 
449
470
  | Property | Type | Description | Overrides | Inherited from | Defined in |
450
471
  | ------ | ------ | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L45) |
453
474
 
454
475
  ***
455
476
 
456
477
  #### WalletVerification
457
478
 
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)
479
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L15)
459
480
 
460
481
  Represents a wallet verification.
461
482
 
@@ -463,15 +484,15 @@ Represents a wallet verification.
463
484
 
464
485
  | Property | Type | Description | Defined in |
465
486
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/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.3.3/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L21) |
469
490
 
470
491
  ***
471
492
 
472
493
  #### WalletVerificationChallenge
473
494
 
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)
495
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L16)
475
496
 
476
497
  Represents a wallet verification challenge.
477
498
 
@@ -479,16 +500,16 @@ Represents a wallet verification challenge.
479
500
 
480
501
  | Property | Type | Description | Defined in |
481
502
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/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.3.3/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.3.3/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L22) |
486
507
 
487
508
  ***
488
509
 
489
510
  #### WalletVerificationOptions
490
511
 
491
- Defined in: [sdk/viem/src/viem.ts:84](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/viem/src/viem.ts#L84)
512
+ Defined in: [sdk/viem/src/viem.ts:101](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/viem.ts#L101)
492
513
 
493
514
  The options for the wallet client.
494
515
 
@@ -496,8 +517,8 @@ The options for the wallet client.
496
517
 
497
518
  | Property | Type | Description | Defined in |
498
519
  | ------ | ------ | ------ | ------ |
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) |
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.3.3/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.3.3/sdk/viem/src/viem.ts#L105) |
501
522
 
502
523
  ### Type Aliases
503
524
 
@@ -505,27 +526,59 @@ The options for the wallet client.
505
526
 
506
527
  > **AddressOrObject** = `string` \| \{ `userWalletAddress`: `string`; `verificationId?`: `string`; \}
507
528
 
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)
529
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L6)
509
530
 
510
531
  Represents either a wallet address string or an object containing wallet address and optional verification ID.
511
532
 
512
533
  ***
513
534
 
535
+ #### ClientOptions
536
+
537
+ > **ClientOptions** = `Omit`\<`z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>, `"httpTransportConfig"`\> & `object`
538
+
539
+ Defined in: [sdk/viem/src/viem.ts:51](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/viem.ts#L51)
540
+
541
+ Type representing the validated client options.
542
+
543
+ ##### Type declaration
544
+
545
+ | Name | Type | Defined in |
546
+ | ------ | ------ | ------ |
547
+ | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:52](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/viem.ts#L52) |
548
+
549
+ ***
550
+
514
551
  #### CreateWalletVerificationChallengesResponse
515
552
 
516
553
  > **CreateWalletVerificationChallengesResponse** = [`WalletVerificationChallenge`](#walletverificationchallenge)[]
517
554
 
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)
555
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts#L30)
519
556
 
520
557
  Response from creating wallet verification challenges.
521
558
 
522
559
  ***
523
560
 
561
+ #### GetChainIdOptions
562
+
563
+ > **GetChainIdOptions** = `Omit`\<`z.infer`\<*typeof* [`GetChainIdOptionsSchema`](#getchainidoptionsschema)\>, `"httpTransportConfig"`\> & `object`
564
+
565
+ Defined in: [sdk/viem/src/viem.ts:198](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/viem.ts#L198)
566
+
567
+ Type representing the validated get chain id options.
568
+
569
+ ##### Type declaration
570
+
571
+ | Name | Type | Defined in |
572
+ | ------ | ------ | ------ |
573
+ | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:199](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/viem.ts#L199) |
574
+
575
+ ***
576
+
524
577
  #### GetWalletVerificationsResponse
525
578
 
526
579
  > **GetWalletVerificationsResponse** = [`WalletVerification`](#walletverification)[]
527
580
 
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)
581
+ Defined in: [sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/get-wallet-verifications.action.ts#L27)
529
582
 
530
583
  Response from getting wallet verifications.
531
584
 
@@ -535,7 +588,7 @@ Response from getting wallet verifications.
535
588
 
536
589
  > **VerifyWalletVerificationChallengeResponse** = [`VerificationResult`](#verificationresult)[]
537
590
 
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)
591
+ Defined in: [sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts#L34)
539
592
 
540
593
  Response from verifying a wallet verification challenge.
541
594
 
@@ -545,10 +598,30 @@ Response from verifying a wallet verification challenge.
545
598
 
546
599
  > **WalletVerificationInfo** = [`WalletPincodeVerificationInfo`](#walletpincodeverificationinfo) \| [`WalletOTPVerificationInfo`](#walletotpverificationinfo) \| [`WalletSecretCodesVerificationInfo`](#walletsecretcodesverificationinfo)
547
600
 
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)
601
+ Defined in: [sdk/viem/src/custom-actions/create-wallet-verification.action.ts:51](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/custom-actions/create-wallet-verification.action.ts#L51)
549
602
 
550
603
  Union type of all possible wallet verification information types.
551
604
 
605
+ ### Variables
606
+
607
+ #### ClientOptionsSchema
608
+
609
+ > `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
610
+
611
+ Defined in: [sdk/viem/src/viem.ts:25](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/viem.ts#L25)
612
+
613
+ Schema for the viem client options.
614
+
615
+ ***
616
+
617
+ #### GetChainIdOptionsSchema
618
+
619
+ > `const` **GetChainIdOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
620
+
621
+ Defined in: [sdk/viem/src/viem.ts:180](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/viem/src/viem.ts#L180)
622
+
623
+ Schema for the viem client options.
624
+
552
625
  ## Contributing
553
626
 
554
627
  We welcome contributions from the community! Please check out our [Contributing](https://github.com/settlemint/sdk/blob/main/.github/CONTRIBUTING.md) guide to learn how you can help improve the SettleMint SDK through bug reports, feature requests, documentation updates, or code contributions.