@settlemint/sdk-blockscout 2.3.14 → 2.4.0-main005a9b57

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 +15 -8
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -50,7 +50,7 @@ The SettleMint Blockscout SDK provides a seamless way to interact with Blockscou
50
50
 
51
51
  > **createBlockscoutClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
52
52
 
53
- Defined in: [sdk/blockscout/src/blockscout.ts:76](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/blockscout/src/blockscout.ts#L76)
53
+ Defined in: [sdk/blockscout/src/blockscout.ts:76](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/blockscout/src/blockscout.ts#L76)
54
54
 
55
55
  Creates a Blockscout GraphQL client with proper type safety using gql.tada
56
56
 
@@ -77,8 +77,8 @@ An object containing the GraphQL client and initialized gql.tada function
77
77
 
78
78
  | Name | Type | Defined in |
79
79
  | ------ | ------ | ------ |
80
- | `client` | `GraphQLClient` | [sdk/blockscout/src/blockscout.ts:80](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/blockscout/src/blockscout.ts#L80) |
81
- | `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/blockscout/src/blockscout.ts:81](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/blockscout/src/blockscout.ts#L81) |
80
+ | `client` | `GraphQLClient` | [sdk/blockscout/src/blockscout.ts:80](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/blockscout/src/blockscout.ts#L80) |
81
+ | `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/blockscout/src/blockscout.ts:81](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/blockscout/src/blockscout.ts#L81) |
82
82
 
83
83
  ##### Throws
84
84
 
@@ -134,19 +134,26 @@ const result = await client.request(query, {
134
134
 
135
135
  #### ClientOptions
136
136
 
137
- > **ClientOptions** = `z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>
137
+ > **ClientOptions** = `object`
138
138
 
139
- Defined in: [sdk/blockscout/src/blockscout.ts:24](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/blockscout/src/blockscout.ts#L24)
139
+ Defined in: [sdk/blockscout/src/blockscout.ts:24](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/blockscout/src/blockscout.ts#L24)
140
140
 
141
141
  Type definition for client options derived from the ClientOptionsSchema
142
142
 
143
+ ##### Type declaration
144
+
145
+ | Name | Type | Default value | Defined in |
146
+ | ------ | ------ | ------ | ------ |
147
+ | <a id="accesstoken"></a> `accessToken?` | `string` | - | [sdk/blockscout/src/blockscout.ts:18](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/blockscout/src/blockscout.ts#L18) |
148
+ | <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/blockscout/src/blockscout.ts:17](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/blockscout/src/blockscout.ts#L17) |
149
+
143
150
  ***
144
151
 
145
152
  #### RequestConfig
146
153
 
147
154
  > **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
148
155
 
149
- Defined in: [sdk/blockscout/src/blockscout.ts:11](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/blockscout/src/blockscout.ts#L11)
156
+ Defined in: [sdk/blockscout/src/blockscout.ts:11](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/blockscout/src/blockscout.ts#L11)
150
157
 
151
158
  Type definition for GraphQL client configuration options
152
159
 
@@ -154,9 +161,9 @@ Type definition for GraphQL client configuration options
154
161
 
155
162
  #### ClientOptionsSchema
156
163
 
157
- > `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `instance`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
164
+ > `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
158
165
 
159
- Defined in: [sdk/blockscout/src/blockscout.ts:16](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/blockscout/src/blockscout.ts#L16)
166
+ Defined in: [sdk/blockscout/src/blockscout.ts:16](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/blockscout/src/blockscout.ts#L16)
160
167
 
161
168
  Schema for validating client options for the Blockscout client.
162
169
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@settlemint/sdk-blockscout",
3
3
  "description": "Blockscout integration module for SettleMint SDK, enabling blockchain explorer and analytics functionality",
4
- "version": "2.3.14",
4
+ "version": "2.4.0-main005a9b57",
5
5
  "type": "module",
6
6
  "private": false,
7
7
  "license": "FSL-1.1-MIT",
@@ -52,7 +52,7 @@
52
52
  "devDependencies": {},
53
53
  "dependencies": {
54
54
  "gql.tada": "^1",
55
- "@settlemint/sdk-utils": "2.3.14",
55
+ "@settlemint/sdk-utils": "2.4.0-main005a9b57",
56
56
  "graphql-request": "^7",
57
57
  "zod": "^3.25.0"
58
58
  },