@settlemint/sdk-viem 2.5.14-main4d78a98a → 2.5.14-mainb12ddf63

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -83,7 +83,7 @@ The SettleMint Viem SDK provides a lightweight wrapper that automatically config
83
83
 
84
84
  > **getChainId**(`options`): `Promise`\<`number`\>
85
85
 
86
- Defined in: [sdk/viem/src/viem.ts:446](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L446)
86
+ Defined in: [sdk/viem/src/viem.ts:454](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L454)
87
87
 
88
88
  Discovers the chain ID from an RPC endpoint without requiring prior knowledge.
89
89
 
@@ -134,9 +134,9 @@ console.log(chainId);
134
134
 
135
135
  #### getPublicClient()
136
136
 
137
- > **getPublicClient**(`options`): \{ \} \| \{ \}
137
+ > **getPublicClient**(`options`): `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `PublicRpcSchema`, `object` & `PublicActions`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`\>\>
138
138
 
139
- Defined in: [sdk/viem/src/viem.ts:201](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L201)
139
+ Defined in: [sdk/viem/src/viem.ts:200](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L200)
140
140
 
141
141
  Creates an optimized public client for blockchain read operations.
142
142
 
@@ -148,7 +148,7 @@ Creates an optimized public client for blockchain read operations.
148
148
 
149
149
  ##### Returns
150
150
 
151
- \{ \} \| \{ \}
151
+ `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`, `undefined`, `PublicRpcSchema`, `object` & `PublicActions`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>, `Chain`\>\>
152
152
 
153
153
  Cached or newly created public client with read-only blockchain access
154
154
 
@@ -194,7 +194,7 @@ console.log(block);
194
194
 
195
195
  > **getWalletClient**(`options`): (`verificationOptions?`) => `Client`\<`HttpTransport`\<`undefined` \| `RpcSchema`, `boolean`\>\>
196
196
 
197
- Defined in: [sdk/viem/src/viem.ts:315](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L315)
197
+ Defined in: [sdk/viem/src/viem.ts:322](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L322)
198
198
 
199
199
  Creates a factory function for wallet clients with runtime verification support.
200
200
 
@@ -612,7 +612,7 @@ Data specific to a wallet verification challenge.
612
612
 
613
613
  #### WalletVerificationOptions
614
614
 
615
- Defined in: [sdk/viem/src/viem.ts:248](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L248)
615
+ Defined in: [sdk/viem/src/viem.ts:255](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L255)
616
616
 
617
617
  The options for the wallet client.
618
618
 
@@ -620,9 +620,9 @@ The options for the wallet client.
620
620
 
621
621
  | Property | Type | Description | Defined in |
622
622
  | ------ | ------ | ------ | ------ |
623
- | <a id="challengeid"></a> `challengeId?` | `string` | The challenge id (used for HD wallets) | [sdk/viem/src/viem.ts:256](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L256) |
624
- | <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:260](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L260) |
625
- | <a id="verificationid-3"></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:252](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L252) |
623
+ | <a id="challengeid"></a> `challengeId?` | `string` | The challenge id (used for HD wallets) | [sdk/viem/src/viem.ts:263](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L263) |
624
+ | <a id="challengeresponse-1"></a> `challengeResponse` | `string` | The challenge response (used for HD wallets) | [sdk/viem/src/viem.ts:267](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L267) |
625
+ | <a id="verificationid-3"></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:259](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L259) |
626
626
 
627
627
  ### Type Aliases
628
628
 
@@ -666,7 +666,7 @@ Represents either a wallet address string, an object containing wallet address a
666
666
 
667
667
  > **ClientOptions** = `Omit`\<`z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>, `"httpTransportConfig"`\> & `object`
668
668
 
669
- Defined in: [sdk/viem/src/viem.ts:163](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L163)
669
+ Defined in: [sdk/viem/src/viem.ts:162](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L162)
670
670
 
671
671
  Type representing the validated client options.
672
672
 
@@ -674,7 +674,7 @@ Type representing the validated client options.
674
674
 
675
675
  | Name | Type | Defined in |
676
676
  | ------ | ------ | ------ |
677
- | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:164](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L164) |
677
+ | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:163](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L163) |
678
678
 
679
679
  ***
680
680
 
@@ -702,7 +702,7 @@ Response from creating wallet verification challenges.
702
702
 
703
703
  > **GetChainIdOptions** = `Omit`\<`z.infer`\<*typeof* [`GetChainIdOptionsSchema`](#getchainidoptionsschema)\>, `"httpTransportConfig"`\> & `object`
704
704
 
705
- Defined in: [sdk/viem/src/viem.ts:413](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L413)
705
+ Defined in: [sdk/viem/src/viem.ts:421](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L421)
706
706
 
707
707
  Type representing the validated get chain id options.
708
708
 
@@ -710,7 +710,7 @@ Type representing the validated get chain id options.
710
710
 
711
711
  | Name | Type | Defined in |
712
712
  | ------ | ------ | ------ |
713
- | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:414](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L414) |
713
+ | `httpTransportConfig?` | `HttpTransportConfig` | [sdk/viem/src/viem.ts:422](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L422) |
714
714
 
715
715
  ***
716
716
 
@@ -748,7 +748,7 @@ Union type of all possible wallet verification information types.
748
748
 
749
749
  > `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `chainId`: `ZodString`; `chainName`: `ZodString`; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
750
750
 
751
- Defined in: [sdk/viem/src/viem.ts:137](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L137)
751
+ Defined in: [sdk/viem/src/viem.ts:136](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L136)
752
752
 
753
753
  Schema for the viem client options.
754
754
 
@@ -758,7 +758,7 @@ Schema for the viem client options.
758
758
 
759
759
  > `const` **GetChainIdOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `httpTransportConfig`: `ZodOptional`\<`ZodAny`\>; `rpcUrl`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
760
760
 
761
- Defined in: [sdk/viem/src/viem.ts:395](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L395)
761
+ Defined in: [sdk/viem/src/viem.ts:403](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/viem/src/viem.ts#L403)
762
762
 
763
763
  Schema for the viem client options.
764
764