@settlemint/sdk-js 2.1.4-prc6365e9d → 2.1.4-prc6759680

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
@@ -40,6 +40,7 @@
40
40
  - [CustomDeployment](#customdeployment)
41
41
  - [Insights](#insights)
42
42
  - [IntegrationTool](#integrationtool)
43
+ - [LoadBalancer](#loadbalancer)
43
44
  - [Middleware](#middleware)
44
45
  - [MiddlewareWithSubgraphs](#middlewarewithsubgraphs)
45
46
  - [PlatformConfig](#platformconfig)
@@ -61,7 +62,7 @@ The SettleMint JavaScript SDK provides a type-safe wrapper around the SettleMint
61
62
 
62
63
  > **createSettleMintClient**(`options`): [`SettlemintClient`](#settlemintclient)
63
64
 
64
- Defined in: [settlemint.ts:223](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L223)
65
+ Defined in: [sdk/js/src/settlemint.ts:237](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L237)
65
66
 
66
67
  Creates a SettleMint client with the provided options. The client provides methods to interact with
67
68
  various SettleMint resources like workspaces, applications, blockchain networks, blockchain nodes, middleware,
@@ -108,7 +109,7 @@ const workspace = await client.workspace.read('workspace-unique-name');
108
109
 
109
110
  #### SettlemintClient
110
111
 
111
- Defined in: [settlemint.ts:117](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L117)
112
+ Defined in: [sdk/js/src/settlemint.ts:125](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L125)
112
113
 
113
114
  Client interface for interacting with the SettleMint platform.
114
115
 
@@ -116,7 +117,7 @@ Client interface for interacting with the SettleMint platform.
116
117
 
117
118
  #### SettlemintClientOptions
118
119
 
119
- Defined in: [settlemint.ts:109](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L109)
120
+ Defined in: [sdk/js/src/settlemint.ts:117](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L117)
120
121
 
121
122
  Options for the Settlemint client.
122
123
 
@@ -128,9 +129,9 @@ Options for the Settlemint client.
128
129
 
129
130
  | Property | Type | Default value | Description | Inherited from | Defined in |
130
131
  | ------ | ------ | ------ | ------ | ------ | ------ |
131
- | <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.1.4/sdk/js/src/helpers/client-options.schema.ts#L9) |
132
- | <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:111](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L111) |
133
- | <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.1.4/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` | [sdk/js/src/helpers/client-options.schema.ts:9](https://github.com/settlemint/sdk/blob/v2.1.4/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) | - | [sdk/js/src/settlemint.ts:119](https://github.com/settlemint/sdk/blob/v2.1.4/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` | [sdk/js/src/helpers/client-options.schema.ts:11](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/helpers/client-options.schema.ts#L11) |
134
135
 
135
136
  ### Type Aliases
136
137
 
@@ -138,7 +139,7 @@ Options for the Settlemint client.
138
139
 
139
140
  > **Application** = `ResultOf`\<*typeof* `ApplicationFragment`\>
140
141
 
141
- Defined in: [graphql/application.ts:24](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/application.ts#L24)
142
+ Defined in: [sdk/js/src/graphql/application.ts:24](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/application.ts#L24)
142
143
 
143
144
  Type representing an application entity.
144
145
 
@@ -148,7 +149,7 @@ Type representing an application entity.
148
149
 
149
150
  > **BlockchainNetwork** = `ResultOf`\<*typeof* `BlockchainNetworkFragment`\>
150
151
 
151
- Defined in: [graphql/blockchain-network.ts:32](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/blockchain-network.ts#L32)
152
+ Defined in: [sdk/js/src/graphql/blockchain-network.ts:82](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/blockchain-network.ts#L82)
152
153
 
153
154
  Type representing a blockchain network entity.
154
155
 
@@ -158,7 +159,7 @@ Type representing a blockchain network entity.
158
159
 
159
160
  > **BlockchainNode** = `ResultOf`\<*typeof* `BlockchainNodeFragment`\>
160
161
 
161
- Defined in: [graphql/blockchain-node.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/blockchain-node.ts#L51)
162
+ Defined in: [sdk/js/src/graphql/blockchain-node.ts:96](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/blockchain-node.ts#L96)
162
163
 
163
164
  Type representing a blockchain node entity.
164
165
 
@@ -168,7 +169,7 @@ Type representing a blockchain node entity.
168
169
 
169
170
  > **CustomDeployment** = `ResultOf`\<*typeof* `CustomDeploymentFragment`\>
170
171
 
171
- Defined in: [graphql/custom-deployment.ts:33](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/custom-deployment.ts#L33)
172
+ Defined in: [sdk/js/src/graphql/custom-deployment.ts:33](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/custom-deployment.ts#L33)
172
173
 
173
174
  Type representing a custom deployment entity.
174
175
 
@@ -178,7 +179,7 @@ Type representing a custom deployment entity.
178
179
 
179
180
  > **Insights** = `ResultOf`\<*typeof* `InsightsFragment`\>
180
181
 
181
- Defined in: [graphql/insights.ts:37](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/insights.ts#L37)
182
+ Defined in: [sdk/js/src/graphql/insights.ts:37](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/insights.ts#L37)
182
183
 
183
184
  Type representing an insights entity.
184
185
 
@@ -188,17 +189,27 @@ Type representing an insights entity.
188
189
 
189
190
  > **IntegrationTool** = `ResultOf`\<*typeof* `IntegrationFragment`\>
190
191
 
191
- Defined in: [graphql/integration-tool.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/integration-tool.ts#L35)
192
+ Defined in: [sdk/js/src/graphql/integration-tool.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/integration-tool.ts#L35)
192
193
 
193
194
  Type representing an integration tool entity.
194
195
 
195
196
  ***
196
197
 
198
+ #### LoadBalancer
199
+
200
+ > **LoadBalancer** = `ResultOf`\<*typeof* `LoadBalancerFragment`\>
201
+
202
+ Defined in: [sdk/js/src/graphql/load-balancer.ts:31](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/load-balancer.ts#L31)
203
+
204
+ Type representing a load balancer entity.
205
+
206
+ ***
207
+
197
208
  #### Middleware
198
209
 
199
210
  > **Middleware** = `ResultOf`\<*typeof* `MiddlewareFragment`\>
200
211
 
201
- Defined in: [graphql/middleware.ts:43](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/middleware.ts#L43)
212
+ Defined in: [sdk/js/src/graphql/middleware.ts:43](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/middleware.ts#L43)
202
213
 
203
214
  Type representing a middleware entity.
204
215
 
@@ -208,7 +219,7 @@ Type representing a middleware entity.
208
219
 
209
220
  > **MiddlewareWithSubgraphs** = `ResultOf`\<*typeof* `getGraphMiddlewareSubgraphs`\>\[`"middlewareByUniqueName"`\]
210
221
 
211
- Defined in: [graphql/middleware.ts:101](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/middleware.ts#L101)
222
+ Defined in: [sdk/js/src/graphql/middleware.ts:101](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/middleware.ts#L101)
212
223
 
213
224
  Type representing a middleware entity with subgraphs.
214
225
 
@@ -218,7 +229,7 @@ Type representing a middleware entity with subgraphs.
218
229
 
219
230
  > **PlatformConfig** = `ResultOf`\<*typeof* `getPlatformConfigQuery`\>\[`"config"`\]
220
231
 
221
- Defined in: [graphql/platform.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/platform.ts#L51)
232
+ Defined in: [sdk/js/src/graphql/platform.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/platform.ts#L51)
222
233
 
223
234
  Type representing the platform configuration.
224
235
 
@@ -228,7 +239,7 @@ Type representing the platform configuration.
228
239
 
229
240
  > **PrivateKey** = `ResultOf`\<*typeof* `PrivateKeyFragment`\>
230
241
 
231
- Defined in: [graphql/private-key.ts:27](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/private-key.ts#L27)
242
+ Defined in: [sdk/js/src/graphql/private-key.ts:27](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/private-key.ts#L27)
232
243
 
233
244
  Type representing a private key entity.
234
245
 
@@ -238,7 +249,7 @@ Type representing a private key entity.
238
249
 
239
250
  > **Storage** = `ResultOf`\<*typeof* `StorageFragment`\>
240
251
 
241
- Defined in: [graphql/storage.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/storage.ts#L35)
252
+ Defined in: [sdk/js/src/graphql/storage.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/storage.ts#L35)
242
253
 
243
254
  Type representing a storage entity.
244
255
 
@@ -248,7 +259,7 @@ Type representing a storage entity.
248
259
 
249
260
  > **Workspace** = `ResultOf`\<*typeof* `WorkspaceFragment`\>
250
261
 
251
- Defined in: [graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/workspace.ts#L26)
262
+ Defined in: [sdk/js/src/graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/workspace.ts#L26)
252
263
 
253
264
  Type representing a workspace entity.
254
265
 
@@ -353,11 +353,61 @@ var BlockchainNetworkFragment = graphql(`
353
353
  healthStatus
354
354
  provider
355
355
  region
356
+ ... on BesuQBFTBlockchainNetwork {
357
+ chainId
358
+ }
359
+ ... on BesuIbftv2BlockchainNetwork {
360
+ chainId
361
+ }
362
+ ... on GethPoWBlockchainNetwork {
363
+ chainId
364
+ }
365
+ ... on GethPoSRinkebyBlockchainNetwork {
366
+ chainId
367
+ }
368
+ ... on GethVenidiumBlockchainNetwork {
369
+ chainId
370
+ }
371
+ ... on GethGoerliBlockchainNetwork {
372
+ chainId
373
+ }
374
+ ... on AvalancheBlockchainNetwork {
375
+ chainId
376
+ }
377
+ ... on AvalancheFujiBlockchainNetwork {
378
+ chainId
379
+ }
380
+ ... on BscPoWBlockchainNetwork {
381
+ chainId
382
+ }
383
+ ... on BscPoWTestnetBlockchainNetwork {
384
+ chainId
385
+ }
386
+ ... on PolygonBlockchainNetwork {
387
+ chainId
388
+ }
389
+ ... on PolygonMumbaiBlockchainNetwork {
390
+ chainId
391
+ }
392
+ ... on PolygonEdgePoABlockchainNetwork {
393
+ chainId
394
+ }
395
+ ... on QuorumQBFTBlockchainNetwork {
396
+ chainId
397
+ }
398
+ ... on GethCliqueBlockchainNetwork {
399
+ chainId
400
+ }
356
401
  blockchainNodes {
357
402
  ... on BlockchainNode {
358
403
  id
359
404
  name
360
405
  uniqueName
406
+ endpoints {
407
+ id
408
+ label
409
+ displayValue
410
+ }
361
411
  }
362
412
  }
363
413
  }
@@ -542,6 +592,51 @@ var BlockchainNodeFragment = graphql(`
542
592
  id
543
593
  name
544
594
  uniqueName
595
+ ... on BesuQBFTBlockchainNetwork {
596
+ chainId
597
+ }
598
+ ... on BesuIbftv2BlockchainNetwork {
599
+ chainId
600
+ }
601
+ ... on GethPoWBlockchainNetwork {
602
+ chainId
603
+ }
604
+ ... on GethPoSRinkebyBlockchainNetwork {
605
+ chainId
606
+ }
607
+ ... on GethVenidiumBlockchainNetwork {
608
+ chainId
609
+ }
610
+ ... on GethGoerliBlockchainNetwork {
611
+ chainId
612
+ }
613
+ ... on AvalancheBlockchainNetwork {
614
+ chainId
615
+ }
616
+ ... on AvalancheFujiBlockchainNetwork {
617
+ chainId
618
+ }
619
+ ... on BscPoWBlockchainNetwork {
620
+ chainId
621
+ }
622
+ ... on BscPoWTestnetBlockchainNetwork {
623
+ chainId
624
+ }
625
+ ... on PolygonBlockchainNetwork {
626
+ chainId
627
+ }
628
+ ... on PolygonMumbaiBlockchainNetwork {
629
+ chainId
630
+ }
631
+ ... on PolygonEdgePoABlockchainNetwork {
632
+ chainId
633
+ }
634
+ ... on QuorumQBFTBlockchainNetwork {
635
+ chainId
636
+ }
637
+ ... on GethCliqueBlockchainNetwork {
638
+ chainId
639
+ }
545
640
  }
546
641
  }
547
642
  privateKeys {
@@ -813,6 +908,7 @@ var getEnv = (gqlClient) => {
813
908
  // src/graphql/load-balancer.ts
814
909
  var LoadBalancerFragment = graphql(`
815
910
  fragment LoadBalancer on LoadBalancer {
911
+ __typename
816
912
  id
817
913
  uniqueName
818
914
  name
@@ -820,6 +916,11 @@ var LoadBalancerFragment = graphql(`
820
916
  healthStatus
821
917
  provider
822
918
  region
919
+ endpoints {
920
+ id
921
+ label
922
+ displayValue
923
+ }
823
924
  }
824
925
  `);
825
926
  var getLoadBalancer = graphql(
@@ -832,6 +933,56 @@ var getLoadBalancer = graphql(
832
933
  `,
833
934
  [LoadBalancerFragment]
834
935
  );
936
+ var getLoadBalancers = graphql(
937
+ `
938
+ query getLoadBalancers($applicationUniqueName: String!) {
939
+ loadBalancersByUniqueName(applicationUniqueName: $applicationUniqueName) {
940
+ items {
941
+ ...LoadBalancer
942
+ }
943
+ }
944
+ }
945
+ `,
946
+ [LoadBalancerFragment]
947
+ );
948
+ var createLoadBalancer = graphql(
949
+ `
950
+ mutation createLoadBalancer(
951
+ $applicationId: ID!
952
+ $blockchainNetworkId: ID!
953
+ $name: String!
954
+ $provider: String!
955
+ $region: String!
956
+ $size: ClusterServiceSize
957
+ $type: ClusterServiceType
958
+ $connectedNodes: [ID!]!
959
+ ) {
960
+ createLoadBalancer(
961
+ applicationId: $applicationId
962
+ blockchainNetworkId: $blockchainNetworkId
963
+ name: $name
964
+ provider: $provider
965
+ region: $region
966
+ size: $size
967
+ type: $type
968
+ connectedNodes: $connectedNodes
969
+ ) {
970
+ ...LoadBalancer
971
+ }
972
+ }
973
+ `,
974
+ [LoadBalancerFragment]
975
+ );
976
+ var restartLoadBalancer = graphql(
977
+ `
978
+ mutation RestartLoadBalancer($uniqueName: String!) {
979
+ restartLoadBalancerByUniqueName(uniqueName: $uniqueName) {
980
+ ...LoadBalancer
981
+ }
982
+ }
983
+ `,
984
+ [LoadBalancerFragment]
985
+ );
835
986
  var loadBalancerRead = (gqlClient) => {
836
987
  return async (loadBalancerUniqueName) => {
837
988
  const { loadBalancerByUniqueName: loadBalancer } = await gqlClient.request(getLoadBalancer, {
@@ -840,6 +991,37 @@ var loadBalancerRead = (gqlClient) => {
840
991
  return loadBalancer;
841
992
  };
842
993
  };
994
+ var loadBalancerList = (gqlClient) => {
995
+ return async (applicationUniqueName) => {
996
+ const {
997
+ loadBalancersByUniqueName: { items }
998
+ } = await gqlClient.request(getLoadBalancers, { applicationUniqueName });
999
+ return items;
1000
+ };
1001
+ };
1002
+ var loadBalancerCreate = (gqlClient) => {
1003
+ return async (args) => {
1004
+ const { applicationUniqueName, blockchainNetworkUniqueName, connectedNodesUniqueNames, ...otherArgs } = args;
1005
+ const [application, blockchainNetwork, connectedNodes] = await Promise.all([
1006
+ applicationRead(gqlClient)(applicationUniqueName),
1007
+ blockchainNetworkRead(gqlClient)(blockchainNetworkUniqueName),
1008
+ Promise.all(connectedNodesUniqueNames.map((uniqueName) => blockchainNodeRead(gqlClient)(uniqueName)))
1009
+ ]);
1010
+ const { createLoadBalancer: loadBalancer } = await gqlClient.request(createLoadBalancer, {
1011
+ ...otherArgs,
1012
+ applicationId: application.id,
1013
+ blockchainNetworkId: blockchainNetwork.id,
1014
+ connectedNodes: connectedNodes.map((node) => node.id)
1015
+ });
1016
+ return loadBalancer;
1017
+ };
1018
+ };
1019
+ var loadBalancerRestart = (gqlClient) => async (loadBalancerUniqueName) => {
1020
+ const { restartLoadBalancerByUniqueName: loadBalancer } = await gqlClient.request(restartLoadBalancer, {
1021
+ uniqueName: loadBalancerUniqueName
1022
+ });
1023
+ return loadBalancer;
1024
+ };
843
1025
 
844
1026
  // src/graphql/insights.ts
845
1027
  var InsightsFragment = graphql(`
@@ -1637,6 +1819,12 @@ function createSettleMintClient(options) {
1637
1819
  create: blockchainNodeCreate(gqlClient),
1638
1820
  restart: blockchainNodeRestart(gqlClient)
1639
1821
  },
1822
+ loadBalancer: {
1823
+ list: loadBalancerList(gqlClient),
1824
+ read: loadBalancerRead(gqlClient),
1825
+ create: loadBalancerCreate(gqlClient),
1826
+ restart: loadBalancerRestart(gqlClient)
1827
+ },
1640
1828
  middleware: {
1641
1829
  list: middlewareList(gqlClient),
1642
1830
  read: middlewareRead(gqlClient),