@settlemint/sdk-blockscout 2.1.1 → 2.1.3-pr35df45ea

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
@@ -52,7 +52,7 @@ For detailed information about using Blockscout with the SettleMint platform, ch
52
52
 
53
53
  > **createBlockscoutClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
54
54
 
55
- Defined in: [sdk/blockscout/src/blockscout.ts:75](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/blockscout/src/blockscout.ts#L75)
55
+ Defined in: [sdk/blockscout/src/blockscout.ts:75](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/blockscout/src/blockscout.ts#L75)
56
56
 
57
57
  Creates a Blockscout GraphQL client with proper type safety using gql.tada
58
58
 
@@ -79,8 +79,8 @@ An object containing the GraphQL client and initialized gql.tada function
79
79
 
80
80
  | Name | Type | Defined in |
81
81
  | ------ | ------ | ------ |
82
- | `client` | `GraphQLClient` | [sdk/blockscout/src/blockscout.ts:79](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/blockscout/src/blockscout.ts#L79) |
83
- | `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/blockscout/src/blockscout.ts:80](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/blockscout/src/blockscout.ts#L80) |
82
+ | `client` | `GraphQLClient` | [sdk/blockscout/src/blockscout.ts:79](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/blockscout/src/blockscout.ts#L79) |
83
+ | `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/blockscout/src/blockscout.ts:80](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/blockscout/src/blockscout.ts#L80) |
84
84
 
85
85
  ##### Throws
86
86
 
@@ -136,19 +136,26 @@ const result = await client.request(query, {
136
136
 
137
137
  #### ClientOptions
138
138
 
139
- > **ClientOptions** = `z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>
139
+ > **ClientOptions** = `object`
140
140
 
141
- Defined in: [sdk/blockscout/src/blockscout.ts:23](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/blockscout/src/blockscout.ts#L23)
141
+ Defined in: [sdk/blockscout/src/blockscout.ts:23](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/blockscout/src/blockscout.ts#L23)
142
142
 
143
143
  Type definition for client options derived from the ClientOptionsSchema
144
144
 
145
+ ##### Type declaration
146
+
147
+ | Name | Type | Default value | Defined in |
148
+ | ------ | ------ | ------ | ------ |
149
+ | <a id="accesstoken"></a> `accessToken` | `string` | `ApplicationAccessTokenSchema` | [sdk/blockscout/src/blockscout.ts:17](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/blockscout/src/blockscout.ts#L17) |
150
+ | <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/blockscout/src/blockscout.ts:16](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/blockscout/src/blockscout.ts#L16) |
151
+
145
152
  ***
146
153
 
147
154
  #### RequestConfig
148
155
 
149
156
  > **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
150
157
 
151
- Defined in: [sdk/blockscout/src/blockscout.ts:10](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/blockscout/src/blockscout.ts#L10)
158
+ Defined in: [sdk/blockscout/src/blockscout.ts:10](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/blockscout/src/blockscout.ts#L10)
152
159
 
153
160
  Type definition for GraphQL client configuration options
154
161
 
@@ -156,9 +163,9 @@ Type definition for GraphQL client configuration options
156
163
 
157
164
  #### ClientOptionsSchema
158
165
 
159
- > `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodString`; `instance`: `ZodUnion`\<\[`ZodString`, `ZodString`\]\>; \}, `"strip"`, `ZodTypeAny`, \{ `accessToken`: `string`; `instance`: `string`; \}, \{ `accessToken`: `string`; `instance`: `string`; \}\>
166
+ > `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
160
167
 
161
- Defined in: [sdk/blockscout/src/blockscout.ts:15](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/blockscout/src/blockscout.ts#L15)
168
+ Defined in: [sdk/blockscout/src/blockscout.ts:15](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/blockscout/src/blockscout.ts#L15)
162
169
 
163
170
  Schema for validating client options for the Blockscout client.
164
171
 
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.1.1",
4
+ "version": "2.1.3-pr35df45ea",
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.1.1",
55
+ "@settlemint/sdk-utils": "2.1.3-pr35df45ea",
56
56
  "graphql-request": "^7",
57
57
  "zod": "^3"
58
58
  },