@settlemint/sdk-viem 2.1.4-prfa991a9d → 2.1.5

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 +56 -13
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -31,6 +31,9 @@
31
31
  - [Functions](#functions)
32
32
  - [getPublicClient()](#getpublicclient)
33
33
  - [getWalletClient()](#getwalletclient)
34
+ - [Enumerations](#enumerations)
35
+ - [OTPAlgorithm](#otpalgorithm)
36
+ - [WalletVerificationType](#walletverificationtype)
34
37
  - [Interfaces](#interfaces)
35
38
  - [ClientOptions](#clientoptions)
36
39
  - [WalletVerificationOptions](#walletverificationoptions)
@@ -47,9 +50,9 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
47
50
 
48
51
  #### getPublicClient()
49
52
 
50
- > **getPublicClient**(`options`): `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `PublicRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `PublicActions`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`\>\>
53
+ > **getPublicClient**(`options`): `object`
51
54
 
52
- Defined in: [sdk/viem/src/viem.ts:66](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L66)
55
+ Defined in: [sdk/viem/src/viem.ts:66](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L66)
53
56
 
54
57
  Get a public client. Use this if you need to read from the blockchain.
55
58
 
@@ -61,7 +64,7 @@ Get a public client. Use this if you need to read from the blockchain.
61
64
 
62
65
  ##### Returns
63
66
 
64
- `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `PublicRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `PublicActions`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`\>\>
67
+ `object`
65
68
 
66
69
  The public client.
67
70
 
@@ -88,7 +91,7 @@ console.log(block);
88
91
 
89
92
  > **getWalletClient**\<`C`\>(`options`): (`verificationOptions?`) => `Client`\<`Transport`, `C`, `undefined` \| `Account`, `WalletRpcSchema`, `object` & `object` & `object` & `object` & `object` & `object` & `object` & `WalletActions`\<`C`, `undefined` \| `Account`\>\>
90
93
 
91
- Defined in: [sdk/viem/src/viem.ts:134](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L134)
94
+ Defined in: [sdk/viem/src/viem.ts:128](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L128)
92
95
 
93
96
  Get a wallet client. Use this if you need to write to the blockchain.
94
97
 
@@ -148,11 +151,51 @@ const transactionHash = await walletClient().writeContract({
148
151
  console.log(transactionHash);
149
152
  ```
150
153
 
154
+ ### Enumerations
155
+
156
+ #### OTPAlgorithm
157
+
158
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L18)
159
+
160
+ Supported hash algorithms for One-Time Password (OTP) verification.
161
+ These algorithms determine the cryptographic function used to generate OTP codes.
162
+
163
+ ##### Enumeration Members
164
+
165
+ | Enumeration Member | Value | Description | Defined in |
166
+ | ------ | ------ | ------ | ------ |
167
+ | <a id="sha1"></a> `SHA1` | `"SHA1"` | SHA-1 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:20](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L20) |
168
+ | <a id="sha224"></a> `SHA224` | `"SHA224"` | SHA-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:22](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L22) |
169
+ | <a id="sha256"></a> `SHA256` | `"SHA256"` | SHA-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:24](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L24) |
170
+ | <a id="sha3_224"></a> `SHA3_224` | `"SHA3-224"` | SHA3-224 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:30](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L30) |
171
+ | <a id="sha3_256"></a> `SHA3_256` | `"SHA3-256"` | SHA3-256 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:32](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L32) |
172
+ | <a id="sha3_384"></a> `SHA3_384` | `"SHA3-384"` | SHA3-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:34](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L34) |
173
+ | <a id="sha3_512"></a> `SHA3_512` | `"SHA3-512"` | SHA3-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:36](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L36) |
174
+ | <a id="sha384"></a> `SHA384` | `"SHA384"` | SHA-384 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:26](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L26) |
175
+ | <a id="sha512"></a> `SHA512` | `"SHA512"` | SHA-512 hash algorithm | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:28](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L28) |
176
+
177
+ ***
178
+
179
+ #### WalletVerificationType
180
+
181
+ Defined in: [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L5)
182
+
183
+ Types of wallet verification methods supported by the system.
184
+ Used to identify different verification mechanisms when creating or managing wallet verifications.
185
+
186
+ ##### Enumeration Members
187
+
188
+ | Enumeration Member | Value | Description | Defined in |
189
+ | ------ | ------ | ------ | ------ |
190
+ | <a id="otp"></a> `OTP` | `"OTP"` | One-Time Password verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:9](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L9) |
191
+ | <a id="pincode"></a> `PINCODE` | `"PINCODE"` | PIN code verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:7](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L7) |
192
+ | <a id="secret_codes"></a> `SECRET_CODES` | `"SECRET_CODES"` | Secret recovery codes verification method | [sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:11](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/custom-actions/types/wallet-verification.enum.ts#L11) |
193
+
151
194
  ### Interfaces
152
195
 
153
196
  #### ClientOptions
154
197
 
155
- Defined in: [sdk/viem/src/viem.ts:23](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L23)
198
+ Defined in: [sdk/viem/src/viem.ts:23](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L23)
156
199
 
157
200
  The options for the viem client.
158
201
 
@@ -160,17 +203,17 @@ The options for the viem client.
160
203
 
161
204
  | Property | Type | Description | Defined in |
162
205
  | ------ | ------ | ------ | ------ |
163
- | <a id="accesstoken"></a> `accessToken` | `string` | The access token | [sdk/viem/src/viem.ts:27](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L27) |
164
- | <a id="chainid"></a> `chainId` | `string` | The chain id | [sdk/viem/src/viem.ts:31](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L31) |
165
- | <a id="chainname"></a> `chainName` | `string` | The chain name | [sdk/viem/src/viem.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L35) |
166
- | <a id="httptransportconfig"></a> `httpTransportConfig?` | `HttpTransportConfig` | The http transport config | [sdk/viem/src/viem.ts:43](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L43) |
167
- | <a id="rpcurl"></a> `rpcUrl` | `string` | The json rpc url | [sdk/viem/src/viem.ts:39](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L39) |
206
+ | <a id="accesstoken"></a> `accessToken` | `string` | The access token | [sdk/viem/src/viem.ts:27](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L27) |
207
+ | <a id="chainid"></a> `chainId` | `string` | The chain id | [sdk/viem/src/viem.ts:31](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L31) |
208
+ | <a id="chainname"></a> `chainName` | `string` | The chain name | [sdk/viem/src/viem.ts:35](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L35) |
209
+ | <a id="httptransportconfig"></a> `httpTransportConfig?` | `HttpTransportConfig` | The http transport config | [sdk/viem/src/viem.ts:43](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L43) |
210
+ | <a id="rpcurl"></a> `rpcUrl` | `string` | The json rpc url | [sdk/viem/src/viem.ts:39](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L39) |
168
211
 
169
212
  ***
170
213
 
171
214
  #### WalletVerificationOptions
172
215
 
173
- Defined in: [sdk/viem/src/viem.ts:92](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L92)
216
+ Defined in: [sdk/viem/src/viem.ts:86](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L86)
174
217
 
175
218
  The options for the wallet client.
176
219
 
@@ -178,8 +221,8 @@ The options for the wallet client.
178
221
 
179
222
  | Property | Type | Description | Defined in |
180
223
  | ------ | ------ | ------ | ------ |
181
- | <a id="challengeresponse"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:100](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L100) |
182
- | <a id="verificationid"></a> `verificationId?` | `string` | The verification id (used for HD wallets), if not provided, the challenge response will be validated against all active verifications. | [sdk/viem/src/viem.ts:96](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/viem/src/viem.ts#L96) |
224
+ | <a id="challengeresponse"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:94](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L94) |
225
+ | <a id="verificationid"></a> `verificationId?` | `string` | The verification id (used for HD wallets), if not provided, the challenge response will be validated against all active verifications. | [sdk/viem/src/viem.ts:90](https://github.com/settlemint/sdk/blob/v2.1.5/sdk/viem/src/viem.ts#L90) |
183
226
 
184
227
  ## Contributing
185
228
 
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.1.4-prfa991a9d",
4
+ "version": "2.1.5",
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.1.4-prfa991a9d",
54
+ "@settlemint/sdk-utils": "2.1.5",
55
55
  "viem": "^2"
56
56
  },
57
57
  "peerDependencies": {},