@settlemint/sdk-js 2.2.3 → 2.3.0-main35204696

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
@@ -62,7 +62,7 @@ The SettleMint JavaScript SDK provides a type-safe wrapper around the SettleMint
62
62
 
63
63
  > **createSettleMintClient**(`options`): [`SettlemintClient`](#settlemintclient)
64
64
 
65
- Defined in: [settlemint.ts:237](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/settlemint.ts#L237)
65
+ Defined in: [settlemint.ts:237](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/settlemint.ts#L237)
66
66
 
67
67
  Creates a SettleMint client with the provided options. The client provides methods to interact with
68
68
  various SettleMint resources like workspaces, applications, blockchain networks, blockchain nodes, middleware,
@@ -109,7 +109,7 @@ const workspace = await client.workspace.read('workspace-unique-name');
109
109
 
110
110
  #### SettlemintClient
111
111
 
112
- Defined in: [settlemint.ts:125](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/settlemint.ts#L125)
112
+ Defined in: [settlemint.ts:125](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/settlemint.ts#L125)
113
113
 
114
114
  Client interface for interacting with the SettleMint platform.
115
115
 
@@ -117,7 +117,7 @@ Client interface for interacting with the SettleMint platform.
117
117
 
118
118
  #### SettlemintClientOptions
119
119
 
120
- Defined in: [settlemint.ts:117](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/settlemint.ts#L117)
120
+ Defined in: [settlemint.ts:117](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/settlemint.ts#L117)
121
121
 
122
122
  Options for the Settlemint client.
123
123
 
@@ -129,9 +129,9 @@ Options for the Settlemint client.
129
129
 
130
130
  | Property | Type | Default value | Description | Inherited from | Defined in |
131
131
  | ------ | ------ | ------ | ------ | ------ | ------ |
132
- | <a id="accesstoken"></a> `accessToken` | `string` | `AccessTokenSchema` | The access token used to authenticate with the SettleMint platform | `ClientOptions.accessToken` | [helpers/client-options.schema.ts:9](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/helpers/client-options.schema.ts#L9) |
133
- | <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:119](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/settlemint.ts#L119) |
134
- | <a id="instance"></a> `instance` | `string` | `UrlSchema` | The URL of the SettleMint instance to connect to | `ClientOptions.instance` | [helpers/client-options.schema.ts:11](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/helpers/client-options.schema.ts#L11) |
132
+ | <a id="accesstoken"></a> `accessToken` | `string` | `AccessTokenSchema` | The access token used to authenticate with the SettleMint platform | `ClientOptions.accessToken` | [helpers/client-options.schema.ts:9](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/helpers/client-options.schema.ts#L9) |
133
+ | <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:119](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/settlemint.ts#L119) |
134
+ | <a id="instance"></a> `instance` | `string` | `UrlSchema` | The URL of the SettleMint instance to connect to | `ClientOptions.instance` | [helpers/client-options.schema.ts:11](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/helpers/client-options.schema.ts#L11) |
135
135
 
136
136
  ### Type Aliases
137
137
 
@@ -139,7 +139,7 @@ Options for the Settlemint client.
139
139
 
140
140
  > **Application** = `ResultOf`\<*typeof* `ApplicationFragment`\>
141
141
 
142
- Defined in: [graphql/application.ts:24](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/application.ts#L24)
142
+ Defined in: [graphql/application.ts:24](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/application.ts#L24)
143
143
 
144
144
  Type representing an application entity.
145
145
 
@@ -149,7 +149,7 @@ Type representing an application entity.
149
149
 
150
150
  > **BlockchainNetwork** = `ResultOf`\<*typeof* `BlockchainNetworkFragment`\>
151
151
 
152
- Defined in: [graphql/blockchain-network.ts:82](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/blockchain-network.ts#L82)
152
+ Defined in: [graphql/blockchain-network.ts:82](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/blockchain-network.ts#L82)
153
153
 
154
154
  Type representing a blockchain network entity.
155
155
 
@@ -159,7 +159,7 @@ Type representing a blockchain network entity.
159
159
 
160
160
  > **BlockchainNode** = `ResultOf`\<*typeof* `BlockchainNodeFragment`\>
161
161
 
162
- Defined in: [graphql/blockchain-node.ts:96](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/blockchain-node.ts#L96)
162
+ Defined in: [graphql/blockchain-node.ts:96](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/blockchain-node.ts#L96)
163
163
 
164
164
  Type representing a blockchain node entity.
165
165
 
@@ -169,7 +169,7 @@ Type representing a blockchain node entity.
169
169
 
170
170
  > **CustomDeployment** = `ResultOf`\<*typeof* `CustomDeploymentFragment`\>
171
171
 
172
- Defined in: [graphql/custom-deployment.ts:33](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/custom-deployment.ts#L33)
172
+ Defined in: [graphql/custom-deployment.ts:33](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/custom-deployment.ts#L33)
173
173
 
174
174
  Type representing a custom deployment entity.
175
175
 
@@ -179,7 +179,7 @@ Type representing a custom deployment entity.
179
179
 
180
180
  > **Insights** = `ResultOf`\<*typeof* `InsightsFragment`\>
181
181
 
182
- Defined in: [graphql/insights.ts:37](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/insights.ts#L37)
182
+ Defined in: [graphql/insights.ts:37](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/insights.ts#L37)
183
183
 
184
184
  Type representing an insights entity.
185
185
 
@@ -189,7 +189,7 @@ Type representing an insights entity.
189
189
 
190
190
  > **IntegrationTool** = `ResultOf`\<*typeof* `IntegrationFragment`\>
191
191
 
192
- Defined in: [graphql/integration-tool.ts:35](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/integration-tool.ts#L35)
192
+ Defined in: [graphql/integration-tool.ts:35](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/integration-tool.ts#L35)
193
193
 
194
194
  Type representing an integration tool entity.
195
195
 
@@ -199,7 +199,7 @@ Type representing an integration tool entity.
199
199
 
200
200
  > **LoadBalancer** = `ResultOf`\<*typeof* `LoadBalancerFragment`\>
201
201
 
202
- Defined in: [graphql/load-balancer.ts:31](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/load-balancer.ts#L31)
202
+ Defined in: [graphql/load-balancer.ts:31](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/load-balancer.ts#L31)
203
203
 
204
204
  Type representing a load balancer entity.
205
205
 
@@ -209,7 +209,7 @@ Type representing a load balancer entity.
209
209
 
210
210
  > **Middleware** = `ResultOf`\<*typeof* `MiddlewareFragment`\>
211
211
 
212
- Defined in: [graphql/middleware.ts:43](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/middleware.ts#L43)
212
+ Defined in: [graphql/middleware.ts:43](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/middleware.ts#L43)
213
213
 
214
214
  Type representing a middleware entity.
215
215
 
@@ -219,7 +219,7 @@ Type representing a middleware entity.
219
219
 
220
220
  > **MiddlewareWithSubgraphs** = `ResultOf`\<*typeof* `getGraphMiddlewareSubgraphs`\>\[`"middlewareByUniqueName"`\]
221
221
 
222
- Defined in: [graphql/middleware.ts:101](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/middleware.ts#L101)
222
+ Defined in: [graphql/middleware.ts:101](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/middleware.ts#L101)
223
223
 
224
224
  Type representing a middleware entity with subgraphs.
225
225
 
@@ -229,7 +229,7 @@ Type representing a middleware entity with subgraphs.
229
229
 
230
230
  > **PlatformConfig** = `ResultOf`\<*typeof* `getPlatformConfigQuery`\>\[`"config"`\]
231
231
 
232
- Defined in: [graphql/platform.ts:51](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/platform.ts#L51)
232
+ Defined in: [graphql/platform.ts:56](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/platform.ts#L56)
233
233
 
234
234
  Type representing the platform configuration.
235
235
 
@@ -239,7 +239,7 @@ Type representing the platform configuration.
239
239
 
240
240
  > **PrivateKey** = `ResultOf`\<*typeof* `PrivateKeyFragment`\>
241
241
 
242
- Defined in: [graphql/private-key.ts:35](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/private-key.ts#L35)
242
+ Defined in: [graphql/private-key.ts:44](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/private-key.ts#L44)
243
243
 
244
244
  Type representing a private key entity.
245
245
 
@@ -249,7 +249,7 @@ Type representing a private key entity.
249
249
 
250
250
  > **Storage** = `ResultOf`\<*typeof* `StorageFragment`\>
251
251
 
252
- Defined in: [graphql/storage.ts:35](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/storage.ts#L35)
252
+ Defined in: [graphql/storage.ts:35](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/storage.ts#L35)
253
253
 
254
254
  Type representing a storage entity.
255
255
 
@@ -259,7 +259,7 @@ Type representing a storage entity.
259
259
 
260
260
  > **Workspace** = `ResultOf`\<*typeof* `WorkspaceFragment`\>
261
261
 
262
- Defined in: [graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v2.2.3/sdk/js/src/graphql/workspace.ts#L26)
262
+ Defined in: [graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v2.3.0/sdk/js/src/graphql/workspace.ts#L26)
263
263
 
264
264
  Type representing a workspace entity.
265
265
 
@@ -1570,7 +1570,12 @@ var getPlatformConfigQuery = graphql(
1570
1570
  disabled
1571
1571
  }
1572
1572
  }
1573
- preDeployedContracts
1573
+ preDeployedAbis {
1574
+ id
1575
+ featureflagged
1576
+ abis
1577
+ label
1578
+ }
1574
1579
  sdkVersion
1575
1580
  kits {
1576
1581
  id
@@ -1603,6 +1608,15 @@ var PrivateKeyFragment = graphql(`
1603
1608
  provider
1604
1609
  region
1605
1610
  address
1611
+ trustedForwarderName
1612
+ trustedForwarderAddress
1613
+ relayerKey {
1614
+ ... on PrivateKey {
1615
+ id
1616
+ name
1617
+ uniqueName
1618
+ }
1619
+ }
1606
1620
  blockchainNodes {
1607
1621
  ... on BlockchainNode {
1608
1622
  id
@@ -1645,6 +1659,9 @@ var createPrivateKey = graphql(
1645
1659
  $size: ClusterServiceSize
1646
1660
  $type: ClusterServiceType
1647
1661
  $blockchainNodes: [ID!]
1662
+ $trustedForwarderName: String
1663
+ $trustedForwarderAddress: String
1664
+ $relayerKey: ID
1648
1665
  ) {
1649
1666
  createPrivateKey(
1650
1667
  applicationId: $applicationId
@@ -1655,6 +1672,9 @@ var createPrivateKey = graphql(
1655
1672
  size: $size
1656
1673
  type: $type
1657
1674
  blockchainNodes: $blockchainNodes
1675
+ trustedForwarderName: $trustedForwarderName
1676
+ trustedForwarderAddress: $trustedForwarderAddress
1677
+ relayerKey: $relayerKey
1658
1678
  ) {
1659
1679
  ...PrivateKey
1660
1680
  }
@@ -1690,9 +1710,10 @@ var privatekeyRead = (gqlClient) => {
1690
1710
  };
1691
1711
  var privateKeyCreate = (gqlClient) => {
1692
1712
  return async (args) => {
1693
- const { applicationUniqueName, blockchainNodeUniqueNames, ...otherArgs } = args;
1713
+ const { applicationUniqueName, blockchainNodeUniqueNames, relayerKeyUniqueName, ...otherArgs } = args;
1694
1714
  const application = await applicationRead(gqlClient)(applicationUniqueName);
1695
1715
  const blockchainNodes = blockchainNodeUniqueNames ? await Promise.all(blockchainNodeUniqueNames.map((uniqueName) => blockchainNodeRead(gqlClient)(uniqueName))) : [];
1716
+ const relayerKey = relayerKeyUniqueName ? await privatekeyRead(gqlClient)(relayerKeyUniqueName) : void 0;
1696
1717
  const platformConfig = await getPlatformConfig(gqlClient)();
1697
1718
  const defaultProvider = platformConfig.deploymentEngineTargets.find(
1698
1719
  (target) => !target.disabled && target.clusters.some((cluster) => !cluster.disabled)
@@ -1702,6 +1723,7 @@ var privateKeyCreate = (gqlClient) => {
1702
1723
  ...otherArgs,
1703
1724
  applicationId: application.id,
1704
1725
  blockchainNodes: blockchainNodes.map((node) => node?.id),
1726
+ relayerKey: relayerKey?.id,
1705
1727
  provider: defaultProvider?.id ?? "gke",
1706
1728
  region: defaultRegion?.id?.split("-")[1] ?? "europe",
1707
1729
  size: "SMALL",