@settlemint/sdk-utils 2.1.4-pr6b1dbf80 → 2.1.4-pr6d9b7c01
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 +182 -75
- package/dist/environment.cjs.map +1 -1
- package/dist/environment.mjs.map +1 -1
- package/dist/filesystem.cjs.map +1 -1
- package/dist/filesystem.mjs.map +1 -1
- package/dist/index.cjs +12 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +16 -1
- package/dist/index.d.ts +16 -1
- package/dist/index.mjs +11 -0
- package/dist/index.mjs.map +1 -1
- package/dist/package-manager.cjs +8 -0
- package/dist/package-manager.cjs.map +1 -1
- package/dist/package-manager.mjs +8 -0
- package/dist/package-manager.mjs.map +1 -1
- package/dist/terminal.cjs +48 -6
- package/dist/terminal.cjs.map +1 -1
- package/dist/terminal.d.cts +17 -2
- package/dist/terminal.d.ts +17 -2
- package/dist/terminal.mjs +47 -6
- package/dist/terminal.mjs.map +1 -1
- package/dist/validation.cjs.map +1 -1
- package/dist/validation.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
- [ensureServer()](#ensureserver)
|
|
40
40
|
- [executeCommand()](#executecommand)
|
|
41
41
|
- [exists()](#exists)
|
|
42
|
+
- [extractJsonObject()](#extractjsonobject)
|
|
42
43
|
- [fetchWithRetry()](#fetchwithretry)
|
|
43
44
|
- [findMonoRepoPackages()](#findmonorepopackages)
|
|
44
45
|
- [findMonoRepoRoot()](#findmonoreporoot)
|
|
@@ -68,6 +69,7 @@
|
|
|
68
69
|
- [writeEnv()](#writeenv)
|
|
69
70
|
- [Classes](#classes)
|
|
70
71
|
- [CancelError](#cancelerror)
|
|
72
|
+
- [CommandError](#commanderror)
|
|
71
73
|
- [SpinnerError](#spinnererror)
|
|
72
74
|
- [Interfaces](#interfaces)
|
|
73
75
|
- [ExecuteCommandOptions](#executecommandoptions)
|
|
@@ -113,7 +115,7 @@ The SettleMint Utils SDK provides a collection of shared utilities and helper fu
|
|
|
113
115
|
|
|
114
116
|
> **ascii**(): `void`
|
|
115
117
|
|
|
116
|
-
Defined in: [sdk/utils/src/terminal/ascii.ts:
|
|
118
|
+
Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/ascii.ts#L14)
|
|
117
119
|
|
|
118
120
|
Prints the SettleMint ASCII art logo to the console in magenta color.
|
|
119
121
|
Used for CLI branding and visual identification.
|
|
@@ -347,7 +349,7 @@ ensureServer();
|
|
|
347
349
|
|
|
348
350
|
> **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
|
|
349
351
|
|
|
350
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:
|
|
352
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/execute-command.ts#L51)
|
|
351
353
|
|
|
352
354
|
Executes a command with the given arguments in a child process.
|
|
353
355
|
Pipes stdin to the child process and captures stdout/stderr output.
|
|
@@ -418,6 +420,49 @@ if (await exists('/path/to/file.txt')) {
|
|
|
418
420
|
|
|
419
421
|
***
|
|
420
422
|
|
|
423
|
+
#### extractJsonObject()
|
|
424
|
+
|
|
425
|
+
> **extractJsonObject**\<`T`\>(`value`): `null` \| `T`
|
|
426
|
+
|
|
427
|
+
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/json.ts#L50)
|
|
428
|
+
|
|
429
|
+
Extracts a JSON object from a string.
|
|
430
|
+
|
|
431
|
+
##### Type Parameters
|
|
432
|
+
|
|
433
|
+
| Type Parameter |
|
|
434
|
+
| ------ |
|
|
435
|
+
| `T` |
|
|
436
|
+
|
|
437
|
+
##### Parameters
|
|
438
|
+
|
|
439
|
+
| Parameter | Type | Description |
|
|
440
|
+
| ------ | ------ | ------ |
|
|
441
|
+
| `value` | `string` | The string to extract the JSON object from |
|
|
442
|
+
|
|
443
|
+
##### Returns
|
|
444
|
+
|
|
445
|
+
`null` \| `T`
|
|
446
|
+
|
|
447
|
+
The parsed JSON object, or null if no JSON object is found
|
|
448
|
+
|
|
449
|
+
##### Throws
|
|
450
|
+
|
|
451
|
+
If the input string is too long (longer than 5000 characters)
|
|
452
|
+
|
|
453
|
+
##### Example
|
|
454
|
+
|
|
455
|
+
```ts
|
|
456
|
+
import { extractJsonObject } from "@settlemint/sdk-utils";
|
|
457
|
+
|
|
458
|
+
const json = extractJsonObject<{ port: number }>(
|
|
459
|
+
'port info: {"port": 3000}',
|
|
460
|
+
);
|
|
461
|
+
// Returns: { port: 3000 }
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
***
|
|
465
|
+
|
|
421
466
|
#### fetchWithRetry()
|
|
422
467
|
|
|
423
468
|
> **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
|
|
@@ -712,7 +757,7 @@ await installDependencies(["express", "cors"]);
|
|
|
712
757
|
|
|
713
758
|
> **intro**(`msg`): `void`
|
|
714
759
|
|
|
715
|
-
Defined in: [sdk/utils/src/terminal/intro.ts:
|
|
760
|
+
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/intro.ts#L16)
|
|
716
761
|
|
|
717
762
|
Displays an introductory message in magenta text with padding.
|
|
718
763
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -930,7 +975,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
|
|
|
930
975
|
|
|
931
976
|
> **note**(`message`, `level`): `void`
|
|
932
977
|
|
|
933
|
-
Defined in: [sdk/utils/src/terminal/note.ts:
|
|
978
|
+
Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/note.ts#L21)
|
|
934
979
|
|
|
935
980
|
Displays a note message with optional warning level formatting.
|
|
936
981
|
Regular notes are displayed in normal text, while warnings are shown in yellow.
|
|
@@ -965,7 +1010,7 @@ note("Low disk space remaining", "warn");
|
|
|
965
1010
|
|
|
966
1011
|
> **outro**(`msg`): `void`
|
|
967
1012
|
|
|
968
|
-
Defined in: [sdk/utils/src/terminal/outro.ts:
|
|
1013
|
+
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/outro.ts#L16)
|
|
969
1014
|
|
|
970
1015
|
Displays a closing message in green inverted text with padding.
|
|
971
1016
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -1172,7 +1217,7 @@ await setName("my-new-project-name");
|
|
|
1172
1217
|
|
|
1173
1218
|
> **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
|
|
1174
1219
|
|
|
1175
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:
|
|
1220
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/spinner.ts#L55)
|
|
1176
1221
|
|
|
1177
1222
|
Displays a loading spinner while executing an async task.
|
|
1178
1223
|
Shows progress with start/stop messages and handles errors.
|
|
@@ -1222,7 +1267,7 @@ const result = await spinner({
|
|
|
1222
1267
|
|
|
1223
1268
|
> **table**(`title`, `data`): `void`
|
|
1224
1269
|
|
|
1225
|
-
Defined in: [sdk/utils/src/terminal/table.ts:
|
|
1270
|
+
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/table.ts#L21)
|
|
1226
1271
|
|
|
1227
1272
|
Displays data in a formatted table in the terminal.
|
|
1228
1273
|
|
|
@@ -1384,9 +1429,9 @@ Writes environment variables to .env files across a project or monorepo
|
|
|
1384
1429
|
|
|
1385
1430
|
| Parameter | Type | Description |
|
|
1386
1431
|
| ------ | ------ | ------ |
|
|
1387
|
-
| `options` | \{ `cwd
|
|
1432
|
+
| `options` | \{ `cwd?`: `string`; `env`: `Partial`\<\{ `SETTLEMINT_ACCESS_TOKEN?`: `string`; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?`: `string`; `SETTLEMINT_APPLICATION?`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK?`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?`: `string`; `SETTLEMINT_BLOCKSCOUT?`: `string`; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT?`: `string`; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT?`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT?`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT?`: `string`; `SETTLEMINT_HASURA?`: `string`; `SETTLEMINT_HASURA_ADMIN_SECRET?`: `string`; `SETTLEMINT_HASURA_DATABASE_URL?`: `string`; `SETTLEMINT_HASURA_ENDPOINT?`: `string`; `SETTLEMINT_HD_PRIVATE_KEY?`: `string`; `SETTLEMINT_INSTANCE`: `string`; `SETTLEMINT_IPFS?`: `string`; `SETTLEMINT_IPFS_API_ENDPOINT?`: `string`; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT?`: `string`; `SETTLEMINT_IPFS_PINNING_ENDPOINT?`: `string`; `SETTLEMINT_LOG_LEVEL`: `"error"` \| `"info"` \| `"warn"` \| `"debug"` \| `"none"`; `SETTLEMINT_MINIO?`: `string`; `SETTLEMINT_MINIO_ACCESS_KEY?`: `string`; `SETTLEMINT_MINIO_ENDPOINT?`: `string`; `SETTLEMINT_MINIO_SECRET_KEY?`: `string`; `SETTLEMINT_NEW_PROJECT_NAME?`: `string`; `SETTLEMINT_PORTAL?`: `string`; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT?`: `string`; `SETTLEMINT_PORTAL_REST_ENDPOINT?`: `string`; `SETTLEMINT_THEGRAPH?`: `string`; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH?`: `string`; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?`: `string`[]; `SETTLEMINT_WORKSPACE?`: `string`; \}\>; `prod`: `boolean`; `secrets`: `boolean`; \} | The options for writing the environment variables |
|
|
1388
1433
|
| `options.cwd?` | `string` | The directory to start searching for the package.json file from (defaults to process.cwd()) |
|
|
1389
|
-
| `options.env` | `Partial`\<\{ `SETTLEMINT_ACCESS_TOKEN
|
|
1434
|
+
| `options.env` | `Partial`\<\{ `SETTLEMINT_ACCESS_TOKEN?`: `string`; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?`: `string`; `SETTLEMINT_APPLICATION?`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK?`: `string`; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?`: `string`; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?`: `string`; `SETTLEMINT_BLOCKSCOUT?`: `string`; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT?`: `string`; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT?`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT?`: `string`; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT?`: `string`; `SETTLEMINT_HASURA?`: `string`; `SETTLEMINT_HASURA_ADMIN_SECRET?`: `string`; `SETTLEMINT_HASURA_DATABASE_URL?`: `string`; `SETTLEMINT_HASURA_ENDPOINT?`: `string`; `SETTLEMINT_HD_PRIVATE_KEY?`: `string`; `SETTLEMINT_INSTANCE`: `string`; `SETTLEMINT_IPFS?`: `string`; `SETTLEMINT_IPFS_API_ENDPOINT?`: `string`; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT?`: `string`; `SETTLEMINT_IPFS_PINNING_ENDPOINT?`: `string`; `SETTLEMINT_LOG_LEVEL`: `"error"` \| `"info"` \| `"warn"` \| `"debug"` \| `"none"`; `SETTLEMINT_MINIO?`: `string`; `SETTLEMINT_MINIO_ACCESS_KEY?`: `string`; `SETTLEMINT_MINIO_ENDPOINT?`: `string`; `SETTLEMINT_MINIO_SECRET_KEY?`: `string`; `SETTLEMINT_NEW_PROJECT_NAME?`: `string`; `SETTLEMINT_PORTAL?`: `string`; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT?`: `string`; `SETTLEMINT_PORTAL_REST_ENDPOINT?`: `string`; `SETTLEMINT_THEGRAPH?`: `string`; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH?`: `string`; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?`: `string`[]; `SETTLEMINT_WORKSPACE?`: `string`; \}\> | The environment variables to write |
|
|
1390
1435
|
| `options.prod` | `boolean` | Whether to write production environment variables |
|
|
1391
1436
|
| `options.secrets` | `boolean` | Whether to write to .env.local files for secrets |
|
|
1392
1437
|
|
|
@@ -1439,9 +1484,65 @@ This error is used to signal that the operation should be aborted.
|
|
|
1439
1484
|
|
|
1440
1485
|
***
|
|
1441
1486
|
|
|
1487
|
+
#### CommandError
|
|
1488
|
+
|
|
1489
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/execute-command.ts#L16)
|
|
1490
|
+
|
|
1491
|
+
Error class for command execution errors
|
|
1492
|
+
|
|
1493
|
+
##### Extends
|
|
1494
|
+
|
|
1495
|
+
- `Error`
|
|
1496
|
+
|
|
1497
|
+
##### Constructors
|
|
1498
|
+
|
|
1499
|
+
###### Constructor
|
|
1500
|
+
|
|
1501
|
+
> **new CommandError**(`message`, `code`, `output`): [`CommandError`](#commanderror)
|
|
1502
|
+
|
|
1503
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/execute-command.ts#L23)
|
|
1504
|
+
|
|
1505
|
+
Constructs a new CommandError
|
|
1506
|
+
|
|
1507
|
+
###### Parameters
|
|
1508
|
+
|
|
1509
|
+
| Parameter | Type | Description |
|
|
1510
|
+
| ------ | ------ | ------ |
|
|
1511
|
+
| `message` | `string` | The error message |
|
|
1512
|
+
| `code` | `number` | The exit code of the command |
|
|
1513
|
+
| `output` | `string`[] | The output of the command |
|
|
1514
|
+
|
|
1515
|
+
###### Returns
|
|
1516
|
+
|
|
1517
|
+
[`CommandError`](#commanderror)
|
|
1518
|
+
|
|
1519
|
+
###### Overrides
|
|
1520
|
+
|
|
1521
|
+
`Error.constructor`
|
|
1522
|
+
|
|
1523
|
+
##### Properties
|
|
1524
|
+
|
|
1525
|
+
###### code
|
|
1526
|
+
|
|
1527
|
+
> `readonly` **code**: `number`
|
|
1528
|
+
|
|
1529
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/execute-command.ts#L25)
|
|
1530
|
+
|
|
1531
|
+
The exit code of the command
|
|
1532
|
+
|
|
1533
|
+
###### output
|
|
1534
|
+
|
|
1535
|
+
> `readonly` **output**: `string`[]
|
|
1536
|
+
|
|
1537
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/execute-command.ts#L26)
|
|
1538
|
+
|
|
1539
|
+
The output of the command
|
|
1540
|
+
|
|
1541
|
+
***
|
|
1542
|
+
|
|
1442
1543
|
#### SpinnerError
|
|
1443
1544
|
|
|
1444
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:
|
|
1545
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/spinner.ts#L12)
|
|
1445
1546
|
|
|
1446
1547
|
Error class used to indicate that the spinner operation failed.
|
|
1447
1548
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1506,7 +1607,7 @@ Configuration options for the logger
|
|
|
1506
1607
|
|
|
1507
1608
|
#### SpinnerOptions\<R\>
|
|
1508
1609
|
|
|
1509
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:
|
|
1610
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/spinner.ts#L25)
|
|
1510
1611
|
|
|
1511
1612
|
Options for configuring the spinner behavior
|
|
1512
1613
|
|
|
@@ -1520,9 +1621,9 @@ Options for configuring the spinner behavior
|
|
|
1520
1621
|
|
|
1521
1622
|
| Property | Type | Description | Defined in |
|
|
1522
1623
|
| ------ | ------ | ------ | ------ |
|
|
1523
|
-
| <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:
|
|
1524
|
-
| <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:
|
|
1525
|
-
| <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:
|
|
1624
|
+
| <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:27](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/spinner.ts#L27) |
|
|
1625
|
+
| <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:31](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/spinner.ts#L31) |
|
|
1626
|
+
| <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:29](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/terminal/spinner.ts#L29) |
|
|
1526
1627
|
|
|
1527
1628
|
### Type Aliases
|
|
1528
1629
|
|
|
@@ -1552,7 +1653,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1552
1653
|
|
|
1553
1654
|
> **DotEnv** = `object`
|
|
1554
1655
|
|
|
1555
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1656
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:97](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L97)
|
|
1556
1657
|
|
|
1557
1658
|
Type definition for the environment variables schema.
|
|
1558
1659
|
|
|
@@ -1561,38 +1662,41 @@ Type definition for the environment variables schema.
|
|
|
1561
1662
|
| Name | Type | Description | Defined in |
|
|
1562
1663
|
| ------ | ------ | ------ | ------ |
|
|
1563
1664
|
| <a id="settlemint_access_token"></a> `SETTLEMINT_ACCESS_TOKEN?` | `string` | Application access token for authenticating with SettleMint services | [sdk/utils/src/validation/dot-env.schema.ts:16](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L16) |
|
|
1564
|
-
| <a id="settlemint_accessible_private_key"></a> `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?` | `string` | Unique name of the accessible private key | [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1665
|
+
| <a id="settlemint_accessible_private_key"></a> `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?` | `string` | Unique name of the accessible private key | [sdk/utils/src/validation/dot-env.schema.ts:61](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L61) |
|
|
1565
1666
|
| <a id="settlemint_application"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L22) |
|
|
1566
1667
|
| <a id="settlemint_blockchain_network"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK?` | `string` | Unique name of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:24](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L24) |
|
|
1567
|
-
| <a id="
|
|
1568
|
-
| <a id="
|
|
1569
|
-
| <a id="
|
|
1570
|
-
| <a id="
|
|
1571
|
-
| <a id="
|
|
1572
|
-
| <a id="
|
|
1573
|
-
| <a id="
|
|
1574
|
-
| <a id="
|
|
1575
|
-
| <a id="
|
|
1576
|
-
| <a id="
|
|
1577
|
-
| <a id="
|
|
1668
|
+
| <a id="settlemint_blockchain_network_chain_id"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?` | `string` | Chain ID of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L26) |
|
|
1669
|
+
| <a id="settlemint_blockchain_node"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node (should have a private key for signing transactions) | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L28) |
|
|
1670
|
+
| <a id="settlemint_blockchain_node_json_rpc_endpoint"></a> `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L30) |
|
|
1671
|
+
| <a id="settlemint_blockchain_node_or_load_balancer"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?` | `string` | Unique name of the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:32](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L32) |
|
|
1672
|
+
| <a id="settlemint_blockchain_node_or_load_balancer_json_rpc_endpoint"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L34) |
|
|
1673
|
+
| <a id="settlemint_blockscout"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:83](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L83) |
|
|
1674
|
+
| <a id="settlemint_blockscout_graphql_endpoint"></a> `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for Blockscout | [sdk/utils/src/validation/dot-env.schema.ts:85](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L85) |
|
|
1675
|
+
| <a id="settlemint_blockscout_ui_endpoint"></a> `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT?` | `string` | UI endpoint URL for Blockscout | [sdk/utils/src/validation/dot-env.schema.ts:87](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L87) |
|
|
1676
|
+
| <a id="settlemint_custom_deployment"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:79](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L79) |
|
|
1677
|
+
| <a id="settlemint_custom_deployment_endpoint"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT?` | `string` | Endpoint URL for the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:81](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L81) |
|
|
1678
|
+
| <a id="settlemint_hasura"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:36](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L36) |
|
|
1679
|
+
| <a id="settlemint_hasura_admin_secret"></a> `SETTLEMINT_HASURA_ADMIN_SECRET?` | `string` | Admin secret for authenticating with Hasura | [sdk/utils/src/validation/dot-env.schema.ts:40](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1680
|
+
| <a id="settlemint_hasura_database_url"></a> `SETTLEMINT_HASURA_DATABASE_URL?` | `string` | Database connection URL for Hasura | [sdk/utils/src/validation/dot-env.schema.ts:42](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L42) |
|
|
1681
|
+
| <a id="settlemint_hasura_endpoint"></a> `SETTLEMINT_HASURA_ENDPOINT?` | `string` | Endpoint URL for the Hasura GraphQL API | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L38) |
|
|
1682
|
+
| <a id="settlemint_hd_private_key"></a> `SETTLEMINT_HD_PRIVATE_KEY?` | `string` | Unique name of the HD private key | [sdk/utils/src/validation/dot-env.schema.ts:59](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L59) |
|
|
1578
1683
|
| <a id="settlemint_instance"></a> `SETTLEMINT_INSTANCE` | `string` | Base URL of the SettleMint platform instance | [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L14) |
|
|
1579
|
-
| <a id="settlemint_ipfs"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1580
|
-
| <a id="settlemint_ipfs_api_endpoint"></a> `SETTLEMINT_IPFS_API_ENDPOINT?` | `string` | API endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1581
|
-
| <a id="settlemint_ipfs_gateway_endpoint"></a> `SETTLEMINT_IPFS_GATEWAY_ENDPOINT?` | `string` | Gateway endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1582
|
-
| <a id="settlemint_ipfs_pinning_endpoint"></a> `SETTLEMINT_IPFS_PINNING_ENDPOINT?` | `string` | Pinning service endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1583
|
-
| <a id="
|
|
1584
|
-
| <a id="
|
|
1585
|
-
| <a id="
|
|
1586
|
-
| <a id="
|
|
1587
|
-
| <a id="
|
|
1588
|
-
| <a id="
|
|
1589
|
-
| <a id="
|
|
1590
|
-
| <a id="
|
|
1591
|
-
| <a id="
|
|
1592
|
-
| <a id="
|
|
1593
|
-
| <a id="
|
|
1594
|
-
| <a id="
|
|
1595
|
-
| <a id="settlemint_thegraph_subgraphs_endpoints"></a> `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?` | `string`[] | Array of endpoint URLs for The Graph subgraphs | [sdk/utils/src/validation/dot-env.schema.ts:40](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1684
|
+
| <a id="settlemint_ipfs"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:71](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L71) |
|
|
1685
|
+
| <a id="settlemint_ipfs_api_endpoint"></a> `SETTLEMINT_IPFS_API_ENDPOINT?` | `string` | API endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:73](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L73) |
|
|
1686
|
+
| <a id="settlemint_ipfs_gateway_endpoint"></a> `SETTLEMINT_IPFS_GATEWAY_ENDPOINT?` | `string` | Gateway endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:77](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L77) |
|
|
1687
|
+
| <a id="settlemint_ipfs_pinning_endpoint"></a> `SETTLEMINT_IPFS_PINNING_ENDPOINT?` | `string` | Pinning service endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:75](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L75) |
|
|
1688
|
+
| <a id="settlemint_log_level"></a> `SETTLEMINT_LOG_LEVEL` | `"error"` \| `"info"` \| `"warn"` \| `"debug"` \| `"none"` | The log level to use | [sdk/utils/src/validation/dot-env.schema.ts:91](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L91) |
|
|
1689
|
+
| <a id="settlemint_minio"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:63](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L63) |
|
|
1690
|
+
| <a id="settlemint_minio_access_key"></a> `SETTLEMINT_MINIO_ACCESS_KEY?` | `string` | Access key for MinIO authentication | [sdk/utils/src/validation/dot-env.schema.ts:67](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L67) |
|
|
1691
|
+
| <a id="settlemint_minio_endpoint"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:65](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L65) |
|
|
1692
|
+
| <a id="settlemint_minio_secret_key"></a> `SETTLEMINT_MINIO_SECRET_KEY?` | `string` | Secret key for MinIO authentication | [sdk/utils/src/validation/dot-env.schema.ts:69](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L69) |
|
|
1693
|
+
| <a id="settlemint_new_project_name"></a> `SETTLEMINT_NEW_PROJECT_NAME?` | `string` | Name of the new project being created | [sdk/utils/src/validation/dot-env.schema.ts:89](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L89) |
|
|
1694
|
+
| <a id="settlemint_portal"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:53](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1695
|
+
| <a id="settlemint_portal_graphql_endpoint"></a> `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
1696
|
+
| <a id="settlemint_portal_rest_endpoint"></a> `SETTLEMINT_PORTAL_REST_ENDPOINT?` | `string` | REST endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1697
|
+
| <a id="settlemint_thegraph"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:44](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L44) |
|
|
1698
|
+
| <a id="settlemint_thegraph_default_subgraph"></a> `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH?` | `string` | Default The Graph subgraph to use | [sdk/utils/src/validation/dot-env.schema.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1699
|
+
| <a id="settlemint_thegraph_subgraphs_endpoints"></a> `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?` | `string`[] | Array of endpoint URLs for The Graph subgraphs | [sdk/utils/src/validation/dot-env.schema.ts:46](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L46) |
|
|
1596
1700
|
| <a id="settlemint_workspace"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:20](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1597
1701
|
|
|
1598
1702
|
***
|
|
@@ -1601,7 +1705,7 @@ Type definition for the environment variables schema.
|
|
|
1601
1705
|
|
|
1602
1706
|
> **DotEnvPartial** = `object`
|
|
1603
1707
|
|
|
1604
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1708
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:108](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L108)
|
|
1605
1709
|
|
|
1606
1710
|
Type definition for the partial environment variables schema.
|
|
1607
1711
|
|
|
@@ -1610,38 +1714,41 @@ Type definition for the partial environment variables schema.
|
|
|
1610
1714
|
| Name | Type | Description | Defined in |
|
|
1611
1715
|
| ------ | ------ | ------ | ------ |
|
|
1612
1716
|
| <a id="settlemint_access_token-1"></a> `SETTLEMINT_ACCESS_TOKEN?` | `string` | Application access token for authenticating with SettleMint services | [sdk/utils/src/validation/dot-env.schema.ts:16](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L16) |
|
|
1613
|
-
| <a id="settlemint_accessible_private_key-1"></a> `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?` | `string` | Unique name of the accessible private key | [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1717
|
+
| <a id="settlemint_accessible_private_key-1"></a> `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY?` | `string` | Unique name of the accessible private key | [sdk/utils/src/validation/dot-env.schema.ts:61](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L61) |
|
|
1614
1718
|
| <a id="settlemint_application-1"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L22) |
|
|
1615
1719
|
| <a id="settlemint_blockchain_network-1"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK?` | `string` | Unique name of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:24](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L24) |
|
|
1616
|
-
| <a id="
|
|
1617
|
-
| <a id="
|
|
1618
|
-
| <a id="
|
|
1619
|
-
| <a id="
|
|
1620
|
-
| <a id="
|
|
1621
|
-
| <a id="
|
|
1622
|
-
| <a id="
|
|
1623
|
-
| <a id="
|
|
1624
|
-
| <a id="
|
|
1625
|
-
| <a id="
|
|
1626
|
-
| <a id="
|
|
1720
|
+
| <a id="settlemint_blockchain_network_chain_id-1"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?` | `string` | Chain ID of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L26) |
|
|
1721
|
+
| <a id="settlemint_blockchain_node-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node (should have a private key for signing transactions) | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L28) |
|
|
1722
|
+
| <a id="settlemint_blockchain_node_json_rpc_endpoint-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L30) |
|
|
1723
|
+
| <a id="settlemint_blockchain_node_or_load_balancer-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?` | `string` | Unique name of the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:32](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L32) |
|
|
1724
|
+
| <a id="settlemint_blockchain_node_or_load_balancer_json_rpc_endpoint-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L34) |
|
|
1725
|
+
| <a id="settlemint_blockscout-1"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:83](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L83) |
|
|
1726
|
+
| <a id="settlemint_blockscout_graphql_endpoint-1"></a> `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for Blockscout | [sdk/utils/src/validation/dot-env.schema.ts:85](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L85) |
|
|
1727
|
+
| <a id="settlemint_blockscout_ui_endpoint-1"></a> `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT?` | `string` | UI endpoint URL for Blockscout | [sdk/utils/src/validation/dot-env.schema.ts:87](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L87) |
|
|
1728
|
+
| <a id="settlemint_custom_deployment-1"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:79](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L79) |
|
|
1729
|
+
| <a id="settlemint_custom_deployment_endpoint-1"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT?` | `string` | Endpoint URL for the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:81](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L81) |
|
|
1730
|
+
| <a id="settlemint_hasura-1"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:36](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L36) |
|
|
1731
|
+
| <a id="settlemint_hasura_admin_secret-1"></a> `SETTLEMINT_HASURA_ADMIN_SECRET?` | `string` | Admin secret for authenticating with Hasura | [sdk/utils/src/validation/dot-env.schema.ts:40](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1732
|
+
| <a id="settlemint_hasura_database_url-1"></a> `SETTLEMINT_HASURA_DATABASE_URL?` | `string` | Database connection URL for Hasura | [sdk/utils/src/validation/dot-env.schema.ts:42](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L42) |
|
|
1733
|
+
| <a id="settlemint_hasura_endpoint-1"></a> `SETTLEMINT_HASURA_ENDPOINT?` | `string` | Endpoint URL for the Hasura GraphQL API | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L38) |
|
|
1734
|
+
| <a id="settlemint_hd_private_key-1"></a> `SETTLEMINT_HD_PRIVATE_KEY?` | `string` | Unique name of the HD private key | [sdk/utils/src/validation/dot-env.schema.ts:59](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L59) |
|
|
1627
1735
|
| <a id="settlemint_instance-1"></a> `SETTLEMINT_INSTANCE?` | `string` | Base URL of the SettleMint platform instance | [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L14) |
|
|
1628
|
-
| <a id="settlemint_ipfs-1"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1629
|
-
| <a id="settlemint_ipfs_api_endpoint-1"></a> `SETTLEMINT_IPFS_API_ENDPOINT?` | `string` | API endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1630
|
-
| <a id="settlemint_ipfs_gateway_endpoint-1"></a> `SETTLEMINT_IPFS_GATEWAY_ENDPOINT?` | `string` | Gateway endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1631
|
-
| <a id="settlemint_ipfs_pinning_endpoint-1"></a> `SETTLEMINT_IPFS_PINNING_ENDPOINT?` | `string` | Pinning service endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1632
|
-
| <a id="
|
|
1633
|
-
| <a id="
|
|
1634
|
-
| <a id="
|
|
1635
|
-
| <a id="
|
|
1636
|
-
| <a id="
|
|
1637
|
-
| <a id="
|
|
1638
|
-
| <a id="
|
|
1639
|
-
| <a id="
|
|
1640
|
-
| <a id="
|
|
1641
|
-
| <a id="
|
|
1642
|
-
| <a id="
|
|
1643
|
-
| <a id="
|
|
1644
|
-
| <a id="settlemint_thegraph_subgraphs_endpoints-1"></a> `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?` | `string`[] | Array of endpoint URLs for The Graph subgraphs | [sdk/utils/src/validation/dot-env.schema.ts:40](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1736
|
+
| <a id="settlemint_ipfs-1"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:71](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L71) |
|
|
1737
|
+
| <a id="settlemint_ipfs_api_endpoint-1"></a> `SETTLEMINT_IPFS_API_ENDPOINT?` | `string` | API endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:73](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L73) |
|
|
1738
|
+
| <a id="settlemint_ipfs_gateway_endpoint-1"></a> `SETTLEMINT_IPFS_GATEWAY_ENDPOINT?` | `string` | Gateway endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:77](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L77) |
|
|
1739
|
+
| <a id="settlemint_ipfs_pinning_endpoint-1"></a> `SETTLEMINT_IPFS_PINNING_ENDPOINT?` | `string` | Pinning service endpoint URL for IPFS | [sdk/utils/src/validation/dot-env.schema.ts:75](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L75) |
|
|
1740
|
+
| <a id="settlemint_log_level-1"></a> `SETTLEMINT_LOG_LEVEL?` | `"error"` \| `"info"` \| `"warn"` \| `"debug"` \| `"none"` | The log level to use | [sdk/utils/src/validation/dot-env.schema.ts:91](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L91) |
|
|
1741
|
+
| <a id="settlemint_minio-1"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:63](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L63) |
|
|
1742
|
+
| <a id="settlemint_minio_access_key-1"></a> `SETTLEMINT_MINIO_ACCESS_KEY?` | `string` | Access key for MinIO authentication | [sdk/utils/src/validation/dot-env.schema.ts:67](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L67) |
|
|
1743
|
+
| <a id="settlemint_minio_endpoint-1"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:65](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L65) |
|
|
1744
|
+
| <a id="settlemint_minio_secret_key-1"></a> `SETTLEMINT_MINIO_SECRET_KEY?` | `string` | Secret key for MinIO authentication | [sdk/utils/src/validation/dot-env.schema.ts:69](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L69) |
|
|
1745
|
+
| <a id="settlemint_new_project_name-1"></a> `SETTLEMINT_NEW_PROJECT_NAME?` | `string` | Name of the new project being created | [sdk/utils/src/validation/dot-env.schema.ts:89](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L89) |
|
|
1746
|
+
| <a id="settlemint_portal-1"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:53](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1747
|
+
| <a id="settlemint_portal_graphql_endpoint-1"></a> `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
1748
|
+
| <a id="settlemint_portal_rest_endpoint-1"></a> `SETTLEMINT_PORTAL_REST_ENDPOINT?` | `string` | REST endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1749
|
+
| <a id="settlemint_thegraph-1"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:44](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L44) |
|
|
1750
|
+
| <a id="settlemint_thegraph_default_subgraph-1"></a> `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH?` | `string` | Default The Graph subgraph to use | [sdk/utils/src/validation/dot-env.schema.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1751
|
+
| <a id="settlemint_thegraph_subgraphs_endpoints-1"></a> `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?` | `string`[] | Array of endpoint URLs for The Graph subgraphs | [sdk/utils/src/validation/dot-env.schema.ts:46](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L46) |
|
|
1645
1752
|
| <a id="settlemint_workspace-1"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:20](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1646
1753
|
|
|
1647
1754
|
***
|
|
@@ -1788,7 +1895,7 @@ access tokens, workspace names, and service endpoints.
|
|
|
1788
1895
|
|
|
1789
1896
|
> `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
|
|
1790
1897
|
|
|
1791
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:
|
|
1898
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:103](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/utils/src/validation/dot-env.schema.ts#L103)
|
|
1792
1899
|
|
|
1793
1900
|
Partial version of the environment variables schema where all fields are optional.
|
|
1794
1901
|
Useful for validating incomplete configurations during development or build time.
|