@settlemint/sdk-utils 2.6.3 → 2.6.4-maind21b0a1c
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 +181 -166
- package/dist/environment.cjs +122 -17
- package/dist/environment.cjs.map +1 -1
- package/dist/environment.js +122 -17
- package/dist/environment.js.map +1 -1
- package/dist/package-manager.cjs +122 -17
- package/dist/package-manager.cjs.map +1 -1
- package/dist/package-manager.js +122 -17
- package/dist/package-manager.js.map +1 -1
- package/dist/terminal.cjs +122 -17
- package/dist/terminal.cjs.map +1 -1
- package/dist/terminal.d.cts +22 -5
- package/dist/terminal.d.ts +22 -5
- package/dist/terminal.js +122 -17
- package/dist/terminal.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -119,7 +119,7 @@ The SettleMint Utils SDK provides a collection of shared utilities and helper fu
|
|
|
119
119
|
|
|
120
120
|
> **ascii**(): `void`
|
|
121
121
|
|
|
122
|
-
Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
122
|
+
Defined in: [sdk/utils/src/terminal/ascii.ts:14](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/ascii.ts#L14)
|
|
123
123
|
|
|
124
124
|
Prints the SettleMint ASCII art logo to the console in magenta color.
|
|
125
125
|
Used for CLI branding and visual identification.
|
|
@@ -143,7 +143,7 @@ ascii();
|
|
|
143
143
|
|
|
144
144
|
> **camelCaseToWords**(`s`): `string`
|
|
145
145
|
|
|
146
|
-
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.6.
|
|
146
|
+
Defined in: [sdk/utils/src/string.ts:29](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/string.ts#L29)
|
|
147
147
|
|
|
148
148
|
Converts a camelCase string to a human-readable string.
|
|
149
149
|
|
|
@@ -174,7 +174,7 @@ const words = camelCaseToWords("camelCaseString");
|
|
|
174
174
|
|
|
175
175
|
> **cancel**(`msg`): `never`
|
|
176
176
|
|
|
177
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
177
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:23](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/cancel.ts#L23)
|
|
178
178
|
|
|
179
179
|
Displays an error message in red inverse text and throws a CancelError.
|
|
180
180
|
Used to terminate execution with a visible error message.
|
|
@@ -207,7 +207,7 @@ cancel("An error occurred");
|
|
|
207
207
|
|
|
208
208
|
> **capitalizeFirstLetter**(`val`): `string`
|
|
209
209
|
|
|
210
|
-
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.6.
|
|
210
|
+
Defined in: [sdk/utils/src/string.ts:13](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/string.ts#L13)
|
|
211
211
|
|
|
212
212
|
Capitalizes the first letter of a string.
|
|
213
213
|
|
|
@@ -238,7 +238,7 @@ const capitalized = capitalizeFirstLetter("hello");
|
|
|
238
238
|
|
|
239
239
|
> **createLogger**(`options`): [`Logger`](#logger)
|
|
240
240
|
|
|
241
|
-
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.6.
|
|
241
|
+
Defined in: [sdk/utils/src/logging/logger.ts:50](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/logger.ts#L50)
|
|
242
242
|
|
|
243
243
|
Creates a simple logger with configurable log level
|
|
244
244
|
|
|
@@ -271,7 +271,7 @@ logger.error('Operation failed', new Error('Connection timeout'));
|
|
|
271
271
|
|
|
272
272
|
> **emptyDir**(`dir`): `Promise`\<`void`\>
|
|
273
273
|
|
|
274
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.6.
|
|
274
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:45](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/package-manager/download-and-extract.ts#L45)
|
|
275
275
|
|
|
276
276
|
Removes all contents of a directory except the .git folder
|
|
277
277
|
|
|
@@ -299,7 +299,7 @@ await emptyDir("/path/to/dir"); // Removes all contents except .git
|
|
|
299
299
|
|
|
300
300
|
> **ensureBrowser**(): `void`
|
|
301
301
|
|
|
302
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.6.
|
|
302
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:31](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/runtime/ensure-server.ts#L31)
|
|
303
303
|
|
|
304
304
|
Ensures that code is running in a browser environment and not on the server.
|
|
305
305
|
|
|
@@ -326,7 +326,7 @@ ensureBrowser();
|
|
|
326
326
|
|
|
327
327
|
> **ensureServer**(): `void`
|
|
328
328
|
|
|
329
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.6.
|
|
329
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:13](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/runtime/ensure-server.ts#L13)
|
|
330
330
|
|
|
331
331
|
Ensures that code is running on the server and not in a browser environment.
|
|
332
332
|
|
|
@@ -353,11 +353,13 @@ ensureServer();
|
|
|
353
353
|
|
|
354
354
|
> **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
|
|
355
355
|
|
|
356
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:
|
|
356
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:60](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/execute-command.ts#L60)
|
|
357
357
|
|
|
358
358
|
Executes a command with the given arguments in a child process.
|
|
359
359
|
Pipes stdin to the child process and captures stdout/stderr output.
|
|
360
360
|
Masks any sensitive tokens in the output before displaying or returning.
|
|
361
|
+
In quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set),
|
|
362
|
+
output is suppressed unless the command errors out.
|
|
361
363
|
|
|
362
364
|
##### Parameters
|
|
363
365
|
|
|
@@ -395,7 +397,7 @@ await executeCommand("npm", ["install"], { silent: true });
|
|
|
395
397
|
|
|
396
398
|
> **exists**(`path`): `Promise`\<`boolean`\>
|
|
397
399
|
|
|
398
|
-
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.6.
|
|
400
|
+
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/filesystem/exists.ts#L17)
|
|
399
401
|
|
|
400
402
|
Checks if a file or directory exists at the given path
|
|
401
403
|
|
|
@@ -428,7 +430,7 @@ if (await exists('/path/to/file.txt')) {
|
|
|
428
430
|
|
|
429
431
|
> **extractBaseUrlBeforeSegment**(`baseUrl`, `pathSegment`): `string`
|
|
430
432
|
|
|
431
|
-
Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.6.
|
|
433
|
+
Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/url.ts#L15)
|
|
432
434
|
|
|
433
435
|
Extracts the base URL before a specific segment in a URL.
|
|
434
436
|
|
|
@@ -460,7 +462,7 @@ const baseUrl = extractBaseUrlBeforeSegment("https://example.com/api/v1/subgraph
|
|
|
460
462
|
|
|
461
463
|
> **extractJsonObject**\<`T`\>(`value`): `T` \| `null`
|
|
462
464
|
|
|
463
|
-
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.6.
|
|
465
|
+
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/json.ts#L50)
|
|
464
466
|
|
|
465
467
|
Extracts a JSON object from a string.
|
|
466
468
|
|
|
@@ -503,7 +505,7 @@ const json = extractJsonObject<{ port: number }>(
|
|
|
503
505
|
|
|
504
506
|
> **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
|
|
505
507
|
|
|
506
|
-
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.6.
|
|
508
|
+
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/http/fetch-with-retry.ts#L18)
|
|
507
509
|
|
|
508
510
|
Retry an HTTP request with exponential backoff and jitter.
|
|
509
511
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -541,7 +543,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
|
|
|
541
543
|
|
|
542
544
|
> **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
|
|
543
545
|
|
|
544
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.6.
|
|
546
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/filesystem/mono-repo.ts#L59)
|
|
545
547
|
|
|
546
548
|
Finds all packages in a monorepo
|
|
547
549
|
|
|
@@ -572,7 +574,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
|
|
|
572
574
|
|
|
573
575
|
> **findMonoRepoRoot**(`startDir`): `Promise`\<`string` \| `null`\>
|
|
574
576
|
|
|
575
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.6.
|
|
577
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/filesystem/mono-repo.ts#L19)
|
|
576
578
|
|
|
577
579
|
Finds the root directory of a monorepo
|
|
578
580
|
|
|
@@ -603,7 +605,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
|
|
|
603
605
|
|
|
604
606
|
> **formatTargetDir**(`targetDir`): `string`
|
|
605
607
|
|
|
606
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.6.
|
|
608
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/package-manager/download-and-extract.ts#L15)
|
|
607
609
|
|
|
608
610
|
Formats a directory path by removing trailing slashes and whitespace
|
|
609
611
|
|
|
@@ -633,7 +635,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
|
|
|
633
635
|
|
|
634
636
|
> **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
|
|
635
637
|
|
|
636
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.6.
|
|
638
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/package-manager/get-package-manager.ts#L15)
|
|
637
639
|
|
|
638
640
|
Detects the package manager used in the current project
|
|
639
641
|
|
|
@@ -664,7 +666,7 @@ console.log(`Using ${packageManager}`);
|
|
|
664
666
|
|
|
665
667
|
> **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
|
|
666
668
|
|
|
667
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
669
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
|
|
668
670
|
|
|
669
671
|
Retrieves the executable command and arguments for the package manager
|
|
670
672
|
|
|
@@ -695,7 +697,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
|
|
|
695
697
|
|
|
696
698
|
> **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
|
|
697
699
|
|
|
698
|
-
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.6.
|
|
700
|
+
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
|
|
699
701
|
|
|
700
702
|
Executes a GraphQL request with automatic retries using exponential backoff and jitter.
|
|
701
703
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -754,7 +756,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
|
|
|
754
756
|
|
|
755
757
|
> **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
|
|
756
758
|
|
|
757
|
-
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.6.
|
|
759
|
+
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/package-manager/install-dependencies.ts#L20)
|
|
758
760
|
|
|
759
761
|
Installs one or more packages as dependencies using the detected package manager
|
|
760
762
|
|
|
@@ -793,7 +795,7 @@ await installDependencies(["express", "cors"]);
|
|
|
793
795
|
|
|
794
796
|
> **intro**(`msg`): `void`
|
|
795
797
|
|
|
796
|
-
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
798
|
+
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/intro.ts#L16)
|
|
797
799
|
|
|
798
800
|
Displays an introductory message in magenta text with padding.
|
|
799
801
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -823,7 +825,7 @@ intro("Starting deployment...");
|
|
|
823
825
|
|
|
824
826
|
> **isEmpty**(`path`): `Promise`\<`boolean`\>
|
|
825
827
|
|
|
826
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.6.
|
|
828
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/package-manager/download-and-extract.ts#L31)
|
|
827
829
|
|
|
828
830
|
Checks if a directory is empty or contains only a .git folder
|
|
829
831
|
|
|
@@ -855,7 +857,7 @@ if (await isEmpty("/path/to/dir")) {
|
|
|
855
857
|
|
|
856
858
|
> **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
|
|
857
859
|
|
|
858
|
-
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.6.
|
|
860
|
+
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/package-manager/is-package-installed.ts#L17)
|
|
859
861
|
|
|
860
862
|
Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
|
|
861
863
|
|
|
@@ -891,7 +893,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
|
|
|
891
893
|
|
|
892
894
|
> **list**(`title`, `items`): `void`
|
|
893
895
|
|
|
894
|
-
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
896
|
+
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/list.ts#L23)
|
|
895
897
|
|
|
896
898
|
Displays a list of items in a formatted manner, supporting nested items.
|
|
897
899
|
|
|
@@ -931,7 +933,7 @@ list("Providers", [
|
|
|
931
933
|
|
|
932
934
|
> **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
|
|
933
935
|
|
|
934
|
-
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.6.
|
|
936
|
+
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/environment/load-env.ts#L25)
|
|
935
937
|
|
|
936
938
|
Loads environment variables from .env files.
|
|
937
939
|
To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
|
|
@@ -979,7 +981,7 @@ const rawEnv = await loadEnv(false, false);
|
|
|
979
981
|
|
|
980
982
|
> **makeJsonStringifiable**\<`T`\>(`value`): `T`
|
|
981
983
|
|
|
982
|
-
Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.6.
|
|
984
|
+
Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/json.ts#L73)
|
|
983
985
|
|
|
984
986
|
Converts a value to a JSON stringifiable format.
|
|
985
987
|
|
|
@@ -1016,7 +1018,7 @@ const json = makeJsonStringifiable<{ amount: bigint }>({ amount: BigInt(1000) })
|
|
|
1016
1018
|
|
|
1017
1019
|
> **maskTokens**(`output`): `string`
|
|
1018
1020
|
|
|
1019
|
-
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1021
|
+
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/mask-tokens.ts#L13)
|
|
1020
1022
|
|
|
1021
1023
|
Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
|
|
1022
1024
|
Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
|
|
@@ -1048,18 +1050,20 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
|
|
|
1048
1050
|
|
|
1049
1051
|
> **note**(`message`, `level`): `void`
|
|
1050
1052
|
|
|
1051
|
-
Defined in: [sdk/utils/src/terminal/note.ts:
|
|
1053
|
+
Defined in: [sdk/utils/src/terminal/note.ts:90](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/note.ts#L90)
|
|
1052
1054
|
|
|
1053
|
-
Displays a note message with optional warning level formatting.
|
|
1054
|
-
Regular notes are displayed in normal text,
|
|
1055
|
+
Displays a note message with optional warning or error level formatting.
|
|
1056
|
+
Regular notes are displayed in normal text, warnings are shown in yellow, and errors in red.
|
|
1055
1057
|
Any sensitive tokens in the message are masked before display.
|
|
1058
|
+
Warnings and errors are always displayed, even in quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set).
|
|
1059
|
+
When an Error object is provided with level "error", the stack trace is automatically included.
|
|
1056
1060
|
|
|
1057
1061
|
##### Parameters
|
|
1058
1062
|
|
|
1059
1063
|
| Parameter | Type | Default value | Description |
|
|
1060
1064
|
| ------ | ------ | ------ | ------ |
|
|
1061
|
-
| `message` | `string` | `undefined` | The message to display as a note |
|
|
1062
|
-
| `level` | `"info"` \| `"warn"` | `"info"` | The note level: "info" (default)
|
|
1065
|
+
| `message` | `string` \| `Error` | `undefined` | The message to display as a note. Can be either: - A string: Displayed directly with appropriate styling - An Error object: The error message is displayed, and for level "error", the stack trace is automatically included |
|
|
1066
|
+
| `level` | `"error"` \| `"info"` \| `"warn"` | `"info"` | The note level: "info" (default), "warn" for warning styling, or "error" for error styling |
|
|
1063
1067
|
|
|
1064
1068
|
##### Returns
|
|
1065
1069
|
|
|
@@ -1075,6 +1079,17 @@ note("Operation completed successfully");
|
|
|
1075
1079
|
|
|
1076
1080
|
// Display warning note
|
|
1077
1081
|
note("Low disk space remaining", "warn");
|
|
1082
|
+
|
|
1083
|
+
// Display error note (string)
|
|
1084
|
+
note("Operation failed", "error");
|
|
1085
|
+
|
|
1086
|
+
// Display error with stack trace automatically (Error object)
|
|
1087
|
+
try {
|
|
1088
|
+
// some operation
|
|
1089
|
+
} catch (error) {
|
|
1090
|
+
// If error is an Error object and level is "error", stack trace is included automatically
|
|
1091
|
+
note(error, "error");
|
|
1092
|
+
}
|
|
1078
1093
|
```
|
|
1079
1094
|
|
|
1080
1095
|
***
|
|
@@ -1083,7 +1098,7 @@ note("Low disk space remaining", "warn");
|
|
|
1083
1098
|
|
|
1084
1099
|
> **outro**(`msg`): `void`
|
|
1085
1100
|
|
|
1086
|
-
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1101
|
+
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/outro.ts#L16)
|
|
1087
1102
|
|
|
1088
1103
|
Displays a closing message in green inverted text with padding.
|
|
1089
1104
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -1113,7 +1128,7 @@ outro("Deployment completed successfully!");
|
|
|
1113
1128
|
|
|
1114
1129
|
> **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
|
|
1115
1130
|
|
|
1116
|
-
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1131
|
+
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/filesystem/project-root.ts#L18)
|
|
1117
1132
|
|
|
1118
1133
|
Finds the root directory of the current project by locating the nearest package.json file
|
|
1119
1134
|
|
|
@@ -1150,7 +1165,7 @@ console.log(`Project root is at: ${rootDir}`);
|
|
|
1150
1165
|
|
|
1151
1166
|
> **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
|
|
1152
1167
|
|
|
1153
|
-
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1168
|
+
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/string.ts#L48)
|
|
1154
1169
|
|
|
1155
1170
|
Replaces underscores and hyphens with spaces.
|
|
1156
1171
|
|
|
@@ -1181,7 +1196,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
|
|
|
1181
1196
|
|
|
1182
1197
|
> **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
|
|
1183
1198
|
|
|
1184
|
-
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1199
|
+
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/request-logger.ts#L14)
|
|
1185
1200
|
|
|
1186
1201
|
Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
|
|
1187
1202
|
|
|
@@ -1215,7 +1230,7 @@ The fetch function
|
|
|
1215
1230
|
|
|
1216
1231
|
> **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
|
|
1217
1232
|
|
|
1218
|
-
Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1233
|
+
Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/retry.ts#L16)
|
|
1219
1234
|
|
|
1220
1235
|
Retry a function when it fails.
|
|
1221
1236
|
|
|
@@ -1255,7 +1270,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
|
|
|
1255
1270
|
|
|
1256
1271
|
> **setName**(`name`, `path?`): `Promise`\<`void`\>
|
|
1257
1272
|
|
|
1258
|
-
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1273
|
+
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/package-manager/set-name.ts#L16)
|
|
1259
1274
|
|
|
1260
1275
|
Sets the name field in the package.json file
|
|
1261
1276
|
|
|
@@ -1290,7 +1305,7 @@ await setName("my-new-project-name");
|
|
|
1290
1305
|
|
|
1291
1306
|
> **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
|
|
1292
1307
|
|
|
1293
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:
|
|
1308
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:54](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/spinner.ts#L54)
|
|
1294
1309
|
|
|
1295
1310
|
Displays a loading spinner while executing an async task.
|
|
1296
1311
|
Shows progress with start/stop messages and handles errors.
|
|
@@ -1340,7 +1355,7 @@ const result = await spinner({
|
|
|
1340
1355
|
|
|
1341
1356
|
> **table**(`title`, `data`): `void`
|
|
1342
1357
|
|
|
1343
|
-
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1358
|
+
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/table.ts#L21)
|
|
1344
1359
|
|
|
1345
1360
|
Displays data in a formatted table in the terminal.
|
|
1346
1361
|
|
|
@@ -1374,7 +1389,7 @@ table("My Table", data);
|
|
|
1374
1389
|
|
|
1375
1390
|
> **truncate**(`value`, `maxLength`): `string`
|
|
1376
1391
|
|
|
1377
|
-
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1392
|
+
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/string.ts#L65)
|
|
1378
1393
|
|
|
1379
1394
|
Truncates a string to a maximum length and appends "..." if it is longer.
|
|
1380
1395
|
|
|
@@ -1406,7 +1421,7 @@ const truncated = truncate("Hello, world!", 10);
|
|
|
1406
1421
|
|
|
1407
1422
|
> **tryParseJson**\<`T`\>(`value`, `defaultValue`): `T` \| `null`
|
|
1408
1423
|
|
|
1409
|
-
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1424
|
+
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/json.ts#L23)
|
|
1410
1425
|
|
|
1411
1426
|
Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
|
|
1412
1427
|
|
|
@@ -1453,7 +1468,7 @@ const invalid = tryParseJson<string[]>(
|
|
|
1453
1468
|
|
|
1454
1469
|
> **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
|
|
1455
1470
|
|
|
1456
|
-
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1471
|
+
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/validate.ts#L16)
|
|
1457
1472
|
|
|
1458
1473
|
Validates a value against a given Zod schema.
|
|
1459
1474
|
|
|
@@ -1494,7 +1509,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
|
|
|
1494
1509
|
|
|
1495
1510
|
> **writeEnv**(`options`): `Promise`\<`void`\>
|
|
1496
1511
|
|
|
1497
|
-
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1512
|
+
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/environment/write-env.ts#L41)
|
|
1498
1513
|
|
|
1499
1514
|
Writes environment variables to .env files across a project or monorepo
|
|
1500
1515
|
|
|
@@ -1546,7 +1561,7 @@ await writeEnv({
|
|
|
1546
1561
|
|
|
1547
1562
|
#### CancelError
|
|
1548
1563
|
|
|
1549
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1564
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/cancel.ts#L8)
|
|
1550
1565
|
|
|
1551
1566
|
Error class used to indicate that the operation was cancelled.
|
|
1552
1567
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1559,7 +1574,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1559
1574
|
|
|
1560
1575
|
#### CommandError
|
|
1561
1576
|
|
|
1562
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1577
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/execute-command.ts#L16)
|
|
1563
1578
|
|
|
1564
1579
|
Error class for command execution errors
|
|
1565
1580
|
|
|
@@ -1573,7 +1588,7 @@ Error class for command execution errors
|
|
|
1573
1588
|
|
|
1574
1589
|
> **new CommandError**(`message`, `code`, `output`): [`CommandError`](#commanderror)
|
|
1575
1590
|
|
|
1576
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1591
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/execute-command.ts#L23)
|
|
1577
1592
|
|
|
1578
1593
|
Constructs a new CommandError
|
|
1579
1594
|
|
|
@@ -1599,7 +1614,7 @@ Constructs a new CommandError
|
|
|
1599
1614
|
|
|
1600
1615
|
> `readonly` **code**: `number`
|
|
1601
1616
|
|
|
1602
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1617
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/execute-command.ts#L25)
|
|
1603
1618
|
|
|
1604
1619
|
The exit code of the command
|
|
1605
1620
|
|
|
@@ -1607,7 +1622,7 @@ The exit code of the command
|
|
|
1607
1622
|
|
|
1608
1623
|
> `readonly` **output**: `string`[]
|
|
1609
1624
|
|
|
1610
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1625
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/execute-command.ts#L26)
|
|
1611
1626
|
|
|
1612
1627
|
The output of the command
|
|
1613
1628
|
|
|
@@ -1615,7 +1630,7 @@ The output of the command
|
|
|
1615
1630
|
|
|
1616
1631
|
#### SpinnerError
|
|
1617
1632
|
|
|
1618
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:
|
|
1633
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:11](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/spinner.ts#L11)
|
|
1619
1634
|
|
|
1620
1635
|
Error class used to indicate that the spinner operation failed.
|
|
1621
1636
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1628,7 +1643,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1628
1643
|
|
|
1629
1644
|
#### ExecuteCommandOptions
|
|
1630
1645
|
|
|
1631
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1646
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/execute-command.ts#L7)
|
|
1632
1647
|
|
|
1633
1648
|
Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
1634
1649
|
|
|
@@ -1640,13 +1655,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
|
1640
1655
|
|
|
1641
1656
|
| Property | Type | Description | Defined in |
|
|
1642
1657
|
| ------ | ------ | ------ | ------ |
|
|
1643
|
-
| <a id="silent"></a> `silent?` | `boolean` | Whether to suppress output to stdout/stderr | [sdk/utils/src/terminal/execute-command.ts:9](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1658
|
+
| <a id="silent"></a> `silent?` | `boolean` | Whether to suppress output to stdout/stderr | [sdk/utils/src/terminal/execute-command.ts:9](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/execute-command.ts#L9) |
|
|
1644
1659
|
|
|
1645
1660
|
***
|
|
1646
1661
|
|
|
1647
1662
|
#### Logger
|
|
1648
1663
|
|
|
1649
|
-
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1664
|
+
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/logger.ts#L23)
|
|
1650
1665
|
|
|
1651
1666
|
Simple logger interface with basic logging methods
|
|
1652
1667
|
Logger
|
|
@@ -1655,16 +1670,16 @@ Simple logger interface with basic logging methods
|
|
|
1655
1670
|
|
|
1656
1671
|
| Property | Type | Description | Defined in |
|
|
1657
1672
|
| ------ | ------ | ------ | ------ |
|
|
1658
|
-
| <a id="debug"></a> `debug` | (`message`, ...`args`) => `void` | Log debug information | [sdk/utils/src/logging/logger.ts:25](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1659
|
-
| <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1660
|
-
| <a id="info"></a> `info` | (`message`, ...`args`) => `void` | Log general information | [sdk/utils/src/logging/logger.ts:27](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1661
|
-
| <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1673
|
+
| <a id="debug"></a> `debug` | (`message`, ...`args`) => `void` | Log debug information | [sdk/utils/src/logging/logger.ts:25](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/logger.ts#L25) |
|
|
1674
|
+
| <a id="error"></a> `error` | (`message`, ...`args`) => `void` | Log errors | [sdk/utils/src/logging/logger.ts:31](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/logger.ts#L31) |
|
|
1675
|
+
| <a id="info"></a> `info` | (`message`, ...`args`) => `void` | Log general information | [sdk/utils/src/logging/logger.ts:27](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/logger.ts#L27) |
|
|
1676
|
+
| <a id="warn"></a> `warn` | (`message`, ...`args`) => `void` | Log warnings | [sdk/utils/src/logging/logger.ts:29](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/logger.ts#L29) |
|
|
1662
1677
|
|
|
1663
1678
|
***
|
|
1664
1679
|
|
|
1665
1680
|
#### LoggerOptions
|
|
1666
1681
|
|
|
1667
|
-
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1682
|
+
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/logger.ts#L12)
|
|
1668
1683
|
|
|
1669
1684
|
Configuration options for the logger
|
|
1670
1685
|
LoggerOptions
|
|
@@ -1673,14 +1688,14 @@ Configuration options for the logger
|
|
|
1673
1688
|
|
|
1674
1689
|
| Property | Type | Description | Defined in |
|
|
1675
1690
|
| ------ | ------ | ------ | ------ |
|
|
1676
|
-
| <a id="level"></a> `level?` | [`LogLevel`](#loglevel) | The minimum log level to output | [sdk/utils/src/logging/logger.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1677
|
-
| <a id="prefix"></a> `prefix?` | `string` | The prefix to add to the log message | [sdk/utils/src/logging/logger.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1691
|
+
| <a id="level"></a> `level?` | [`LogLevel`](#loglevel) | The minimum log level to output | [sdk/utils/src/logging/logger.ts:14](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/logger.ts#L14) |
|
|
1692
|
+
| <a id="prefix"></a> `prefix?` | `string` | The prefix to add to the log message | [sdk/utils/src/logging/logger.ts:16](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/logger.ts#L16) |
|
|
1678
1693
|
|
|
1679
1694
|
***
|
|
1680
1695
|
|
|
1681
1696
|
#### SpinnerOptions
|
|
1682
1697
|
|
|
1683
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:
|
|
1698
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:24](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/spinner.ts#L24)
|
|
1684
1699
|
|
|
1685
1700
|
Options for configuring the spinner behavior
|
|
1686
1701
|
|
|
@@ -1694,9 +1709,9 @@ Options for configuring the spinner behavior
|
|
|
1694
1709
|
|
|
1695
1710
|
| Property | Type | Description | Defined in |
|
|
1696
1711
|
| ------ | ------ | ------ | ------ |
|
|
1697
|
-
| <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:
|
|
1698
|
-
| <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:
|
|
1699
|
-
| <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:
|
|
1712
|
+
| <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:26](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/spinner.ts#L26) |
|
|
1713
|
+
| <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:30](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/spinner.ts#L30) |
|
|
1714
|
+
| <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:28](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/terminal/spinner.ts#L28) |
|
|
1700
1715
|
|
|
1701
1716
|
### Type Aliases
|
|
1702
1717
|
|
|
@@ -1704,7 +1719,7 @@ Options for configuring the spinner behavior
|
|
|
1704
1719
|
|
|
1705
1720
|
> **AccessToken** = `string`
|
|
1706
1721
|
|
|
1707
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1722
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/access-token.schema.ts#L22)
|
|
1708
1723
|
|
|
1709
1724
|
Schema for validating both application and personal access tokens.
|
|
1710
1725
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1715,7 +1730,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1715
1730
|
|
|
1716
1731
|
> **ApplicationAccessToken** = `string`
|
|
1717
1732
|
|
|
1718
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1733
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/access-token.schema.ts#L8)
|
|
1719
1734
|
|
|
1720
1735
|
Schema for validating application access tokens.
|
|
1721
1736
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1726,7 +1741,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1726
1741
|
|
|
1727
1742
|
> **DotEnv** = `object`
|
|
1728
1743
|
|
|
1729
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1744
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L112)
|
|
1730
1745
|
|
|
1731
1746
|
Type definition for the environment variables schema.
|
|
1732
1747
|
|
|
@@ -1734,45 +1749,45 @@ Type definition for the environment variables schema.
|
|
|
1734
1749
|
|
|
1735
1750
|
| Name | Type | Description | Defined in |
|
|
1736
1751
|
| ------ | ------ | ------ | ------ |
|
|
1737
|
-
| <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:27](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1738
|
-
| <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:76](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1739
|
-
| <a id="settlemint_application"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:33](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1740
|
-
| <a id="settlemint_blockchain_network"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK?` | `string` | Unique name of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:35](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1741
|
-
| <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:37](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1742
|
-
| <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:39](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1743
|
-
| <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:41](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1744
|
-
| <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:43](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1745
|
-
| <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:45](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1746
|
-
| <a id="settlemint_blockscout"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:98](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1747
|
-
| <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:100](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1748
|
-
| <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:102](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1749
|
-
| <a id="settlemint_custom_deployment"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:94](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1750
|
-
| <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:96](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1751
|
-
| <a id="settlemint_hasura"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:47](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1752
|
-
| <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:51](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1753
|
-
| <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:53](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1754
|
-
| <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:49](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1755
|
-
| <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:72](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1756
|
-
| <a id="settlemint_hd_private_key_forwarder_address"></a> `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS?` | `string` | Address of the HD private key forwarder | [sdk/utils/src/validation/dot-env.schema.ts:74](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1757
|
-
| <a id="settlemint_instance"></a> `SETTLEMINT_INSTANCE` | `string` | Base URL of the SettleMint platform instance, set to standalone if your resources are not part of the SettleMint platform | [sdk/utils/src/validation/dot-env.schema.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1758
|
-
| <a id="settlemint_ipfs"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:86](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1759
|
-
| <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:88](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1760
|
-
| <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:92](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1761
|
-
| <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:90](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1762
|
-
| <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:106](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1763
|
-
| <a id="settlemint_minio"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:78](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1764
|
-
| <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:82](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1765
|
-
| <a id="settlemint_minio_endpoint"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:80](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1766
|
-
| <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:84](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1767
|
-
| <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:104](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1768
|
-
| <a id="settlemint_portal"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:64](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1769
|
-
| <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:66](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1770
|
-
| <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:68](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1771
|
-
| <a id="settlemint_portal_ws_endpoint"></a> `SETTLEMINT_PORTAL_WS_ENDPOINT?` | `string` | WebSocket endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:70](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1772
|
-
| <a id="settlemint_thegraph"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1773
|
-
| <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:62](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1774
|
-
| <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:57](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1775
|
-
| <a id="settlemint_workspace"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:31](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1752
|
+
| <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:27](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L27) |
|
|
1753
|
+
| <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:76](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L76) |
|
|
1754
|
+
| <a id="settlemint_application"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:33](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L33) |
|
|
1755
|
+
| <a id="settlemint_blockchain_network"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK?` | `string` | Unique name of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:35](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L35) |
|
|
1756
|
+
| <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:37](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L37) |
|
|
1757
|
+
| <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:39](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L39) |
|
|
1758
|
+
| <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:41](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L41) |
|
|
1759
|
+
| <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:43](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L43) |
|
|
1760
|
+
| <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:45](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L45) |
|
|
1761
|
+
| <a id="settlemint_blockscout"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:98](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L98) |
|
|
1762
|
+
| <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:100](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L100) |
|
|
1763
|
+
| <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:102](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L102) |
|
|
1764
|
+
| <a id="settlemint_custom_deployment"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:94](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L94) |
|
|
1765
|
+
| <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:96](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L96) |
|
|
1766
|
+
| <a id="settlemint_hasura"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:47](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L47) |
|
|
1767
|
+
| <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:51](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1768
|
+
| <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:53](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1769
|
+
| <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:49](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L49) |
|
|
1770
|
+
| <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:72](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L72) |
|
|
1771
|
+
| <a id="settlemint_hd_private_key_forwarder_address"></a> `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS?` | `string` | Address of the HD private key forwarder | [sdk/utils/src/validation/dot-env.schema.ts:74](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L74) |
|
|
1772
|
+
| <a id="settlemint_instance"></a> `SETTLEMINT_INSTANCE` | `string` | Base URL of the SettleMint platform instance, set to standalone if your resources are not part of the SettleMint platform | [sdk/utils/src/validation/dot-env.schema.ts:23](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L23) |
|
|
1773
|
+
| <a id="settlemint_ipfs"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:86](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L86) |
|
|
1774
|
+
| <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:88](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L88) |
|
|
1775
|
+
| <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:92](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L92) |
|
|
1776
|
+
| <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:90](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L90) |
|
|
1777
|
+
| <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:106](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L106) |
|
|
1778
|
+
| <a id="settlemint_minio"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:78](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L78) |
|
|
1779
|
+
| <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:82](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L82) |
|
|
1780
|
+
| <a id="settlemint_minio_endpoint"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:80](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L80) |
|
|
1781
|
+
| <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:84](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L84) |
|
|
1782
|
+
| <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:104](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L104) |
|
|
1783
|
+
| <a id="settlemint_portal"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:64](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L64) |
|
|
1784
|
+
| <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:66](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L66) |
|
|
1785
|
+
| <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:68](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L68) |
|
|
1786
|
+
| <a id="settlemint_portal_ws_endpoint"></a> `SETTLEMINT_PORTAL_WS_ENDPOINT?` | `string` | WebSocket endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:70](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L70) |
|
|
1787
|
+
| <a id="settlemint_thegraph"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
1788
|
+
| <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:62](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L62) |
|
|
1789
|
+
| <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:57](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1790
|
+
| <a id="settlemint_workspace"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:31](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L31) |
|
|
1776
1791
|
|
|
1777
1792
|
***
|
|
1778
1793
|
|
|
@@ -1780,7 +1795,7 @@ Type definition for the environment variables schema.
|
|
|
1780
1795
|
|
|
1781
1796
|
> **DotEnvPartial** = `object`
|
|
1782
1797
|
|
|
1783
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:123](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1798
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:123](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L123)
|
|
1784
1799
|
|
|
1785
1800
|
Type definition for the partial environment variables schema.
|
|
1786
1801
|
|
|
@@ -1788,45 +1803,45 @@ Type definition for the partial environment variables schema.
|
|
|
1788
1803
|
|
|
1789
1804
|
| Name | Type | Description | Defined in |
|
|
1790
1805
|
| ------ | ------ | ------ | ------ |
|
|
1791
|
-
| <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:27](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1792
|
-
| <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:76](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1793
|
-
| <a id="settlemint_application-1"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:33](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1794
|
-
| <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:35](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1795
|
-
| <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:37](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1796
|
-
| <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:39](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1797
|
-
| <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:41](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1798
|
-
| <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:43](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1799
|
-
| <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:45](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1800
|
-
| <a id="settlemint_blockscout-1"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:98](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1801
|
-
| <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:100](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1802
|
-
| <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:102](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1803
|
-
| <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:94](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1804
|
-
| <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:96](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1805
|
-
| <a id="settlemint_hasura-1"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:47](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1806
|
-
| <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:51](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1807
|
-
| <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:53](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1808
|
-
| <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:49](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1809
|
-
| <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:72](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1810
|
-
| <a id="settlemint_hd_private_key_forwarder_address-1"></a> `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS?` | `string` | Address of the HD private key forwarder | [sdk/utils/src/validation/dot-env.schema.ts:74](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1811
|
-
| <a id="settlemint_instance-1"></a> `SETTLEMINT_INSTANCE?` | `string` | Base URL of the SettleMint platform instance, set to standalone if your resources are not part of the SettleMint platform | [sdk/utils/src/validation/dot-env.schema.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1812
|
-
| <a id="settlemint_ipfs-1"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:86](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1813
|
-
| <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:88](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1814
|
-
| <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:92](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1815
|
-
| <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:90](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1816
|
-
| <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:106](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1817
|
-
| <a id="settlemint_minio-1"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:78](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1818
|
-
| <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:82](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1819
|
-
| <a id="settlemint_minio_endpoint-1"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:80](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1820
|
-
| <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:84](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1821
|
-
| <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:104](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1822
|
-
| <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:64](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1823
|
-
| <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:66](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1824
|
-
| <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:68](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1825
|
-
| <a id="settlemint_portal_ws_endpoint-1"></a> `SETTLEMINT_PORTAL_WS_ENDPOINT?` | `string` | WebSocket endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:70](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1826
|
-
| <a id="settlemint_thegraph-1"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1827
|
-
| <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:62](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1828
|
-
| <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:57](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1829
|
-
| <a id="settlemint_workspace-1"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:31](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1806
|
+
| <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:27](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L27) |
|
|
1807
|
+
| <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:76](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L76) |
|
|
1808
|
+
| <a id="settlemint_application-1"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:33](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L33) |
|
|
1809
|
+
| <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:35](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L35) |
|
|
1810
|
+
| <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:37](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L37) |
|
|
1811
|
+
| <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:39](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L39) |
|
|
1812
|
+
| <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:41](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L41) |
|
|
1813
|
+
| <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:43](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L43) |
|
|
1814
|
+
| <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:45](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L45) |
|
|
1815
|
+
| <a id="settlemint_blockscout-1"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:98](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L98) |
|
|
1816
|
+
| <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:100](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L100) |
|
|
1817
|
+
| <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:102](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L102) |
|
|
1818
|
+
| <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:94](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L94) |
|
|
1819
|
+
| <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:96](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L96) |
|
|
1820
|
+
| <a id="settlemint_hasura-1"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:47](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L47) |
|
|
1821
|
+
| <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:51](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1822
|
+
| <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:53](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1823
|
+
| <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:49](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L49) |
|
|
1824
|
+
| <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:72](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L72) |
|
|
1825
|
+
| <a id="settlemint_hd_private_key_forwarder_address-1"></a> `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS?` | `string` | Address of the HD private key forwarder | [sdk/utils/src/validation/dot-env.schema.ts:74](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L74) |
|
|
1826
|
+
| <a id="settlemint_instance-1"></a> `SETTLEMINT_INSTANCE?` | `string` | Base URL of the SettleMint platform instance, set to standalone if your resources are not part of the SettleMint platform | [sdk/utils/src/validation/dot-env.schema.ts:23](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L23) |
|
|
1827
|
+
| <a id="settlemint_ipfs-1"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:86](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L86) |
|
|
1828
|
+
| <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:88](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L88) |
|
|
1829
|
+
| <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:92](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L92) |
|
|
1830
|
+
| <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:90](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L90) |
|
|
1831
|
+
| <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:106](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L106) |
|
|
1832
|
+
| <a id="settlemint_minio-1"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:78](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L78) |
|
|
1833
|
+
| <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:82](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L82) |
|
|
1834
|
+
| <a id="settlemint_minio_endpoint-1"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:80](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L80) |
|
|
1835
|
+
| <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:84](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L84) |
|
|
1836
|
+
| <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:104](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L104) |
|
|
1837
|
+
| <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:64](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L64) |
|
|
1838
|
+
| <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:66](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L66) |
|
|
1839
|
+
| <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:68](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L68) |
|
|
1840
|
+
| <a id="settlemint_portal_ws_endpoint-1"></a> `SETTLEMINT_PORTAL_WS_ENDPOINT?` | `string` | WebSocket endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:70](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L70) |
|
|
1841
|
+
| <a id="settlemint_thegraph-1"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
1842
|
+
| <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:62](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L62) |
|
|
1843
|
+
| <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:57](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1844
|
+
| <a id="settlemint_workspace-1"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:31](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L31) |
|
|
1830
1845
|
|
|
1831
1846
|
***
|
|
1832
1847
|
|
|
@@ -1834,7 +1849,7 @@ Type definition for the partial environment variables schema.
|
|
|
1834
1849
|
|
|
1835
1850
|
> **Id** = `string`
|
|
1836
1851
|
|
|
1837
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1852
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/id.schema.ts#L30)
|
|
1838
1853
|
|
|
1839
1854
|
Type definition for database IDs, inferred from IdSchema.
|
|
1840
1855
|
Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
@@ -1845,7 +1860,7 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
|
1845
1860
|
|
|
1846
1861
|
> **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
|
|
1847
1862
|
|
|
1848
|
-
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1863
|
+
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/logging/logger.ts#L6)
|
|
1849
1864
|
|
|
1850
1865
|
Log levels supported by the logger
|
|
1851
1866
|
|
|
@@ -1855,7 +1870,7 @@ Log levels supported by the logger
|
|
|
1855
1870
|
|
|
1856
1871
|
> **PersonalAccessToken** = `string`
|
|
1857
1872
|
|
|
1858
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1873
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/access-token.schema.ts#L15)
|
|
1859
1874
|
|
|
1860
1875
|
Schema for validating personal access tokens.
|
|
1861
1876
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -1866,7 +1881,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
1866
1881
|
|
|
1867
1882
|
> **Url** = `string`
|
|
1868
1883
|
|
|
1869
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1884
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/url.schema.ts#L18)
|
|
1870
1885
|
|
|
1871
1886
|
Schema for validating URLs.
|
|
1872
1887
|
|
|
@@ -1890,7 +1905,7 @@ const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
|
|
|
1890
1905
|
|
|
1891
1906
|
> **UrlOrPath** = `string`
|
|
1892
1907
|
|
|
1893
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1908
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/url.schema.ts#L55)
|
|
1894
1909
|
|
|
1895
1910
|
Schema that accepts either a full URL or a URL path.
|
|
1896
1911
|
|
|
@@ -1914,7 +1929,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
1914
1929
|
|
|
1915
1930
|
> **UrlPath** = `string`
|
|
1916
1931
|
|
|
1917
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1932
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/url.schema.ts#L38)
|
|
1918
1933
|
|
|
1919
1934
|
Schema for validating URL paths.
|
|
1920
1935
|
|
|
@@ -1938,7 +1953,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
1938
1953
|
|
|
1939
1954
|
> `const` **AccessTokenSchema**: `ZodString`\<[`AccessToken`](#accesstoken)\>
|
|
1940
1955
|
|
|
1941
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1956
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/access-token.schema.ts#L21)
|
|
1942
1957
|
|
|
1943
1958
|
Schema for validating both application and personal access tokens.
|
|
1944
1959
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1949,7 +1964,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1949
1964
|
|
|
1950
1965
|
> `const` **ApplicationAccessTokenSchema**: `ZodString`\<[`ApplicationAccessToken`](#applicationaccesstoken)\>
|
|
1951
1966
|
|
|
1952
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1967
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/access-token.schema.ts#L7)
|
|
1953
1968
|
|
|
1954
1969
|
Schema for validating application access tokens.
|
|
1955
1970
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1960,7 +1975,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1960
1975
|
|
|
1961
1976
|
> `const` **DotEnvSchema**: `ZodObject`\<[`DotEnv`](#dotenv)\>
|
|
1962
1977
|
|
|
1963
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1978
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L21)
|
|
1964
1979
|
|
|
1965
1980
|
Schema for validating environment variables used by the SettleMint SDK.
|
|
1966
1981
|
Defines validation rules and types for configuration values like URLs,
|
|
@@ -1972,7 +1987,7 @@ access tokens, workspace names, and service endpoints.
|
|
|
1972
1987
|
|
|
1973
1988
|
> `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
|
|
1974
1989
|
|
|
1975
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:118](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1990
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:118](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L118)
|
|
1976
1991
|
|
|
1977
1992
|
Partial version of the environment variables schema where all fields are optional.
|
|
1978
1993
|
Useful for validating incomplete configurations during development or build time.
|
|
@@ -1983,7 +1998,7 @@ Useful for validating incomplete configurations during development or build time
|
|
|
1983
1998
|
|
|
1984
1999
|
> `const` **IdSchema**: `ZodUnion`\<[`Id`](#id)\>
|
|
1985
2000
|
|
|
1986
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2001
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/id.schema.ts#L17)
|
|
1987
2002
|
|
|
1988
2003
|
Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
|
|
1989
2004
|
PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
|
|
@@ -2007,7 +2022,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
|
|
|
2007
2022
|
|
|
2008
2023
|
> `const` **LOCAL\_INSTANCE**: `"local"` = `"local"`
|
|
2009
2024
|
|
|
2010
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2025
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L14)
|
|
2011
2026
|
|
|
2012
2027
|
Use this value to indicate that the resources are not part of the SettleMint platform.
|
|
2013
2028
|
|
|
@@ -2017,7 +2032,7 @@ Use this value to indicate that the resources are not part of the SettleMint pla
|
|
|
2017
2032
|
|
|
2018
2033
|
> `const` **PersonalAccessTokenSchema**: `ZodString`\<[`PersonalAccessToken`](#personalaccesstoken)\>
|
|
2019
2034
|
|
|
2020
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2035
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/access-token.schema.ts#L14)
|
|
2021
2036
|
|
|
2022
2037
|
Schema for validating personal access tokens.
|
|
2023
2038
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -2028,7 +2043,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
2028
2043
|
|
|
2029
2044
|
> `const` **runsInBrowser**: `boolean` = `isBrowser`
|
|
2030
2045
|
|
|
2031
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2046
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/runtime/ensure-server.ts#L40)
|
|
2032
2047
|
|
|
2033
2048
|
Boolean indicating if code is currently running in a browser environment
|
|
2034
2049
|
|
|
@@ -2038,7 +2053,7 @@ Boolean indicating if code is currently running in a browser environment
|
|
|
2038
2053
|
|
|
2039
2054
|
> `const` **runsOnServer**: `boolean` = `!isBrowser`
|
|
2040
2055
|
|
|
2041
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2056
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/runtime/ensure-server.ts#L45)
|
|
2042
2057
|
|
|
2043
2058
|
Boolean indicating if code is currently running in a server environment
|
|
2044
2059
|
|
|
@@ -2048,7 +2063,7 @@ Boolean indicating if code is currently running in a server environment
|
|
|
2048
2063
|
|
|
2049
2064
|
> `const` **STANDALONE\_INSTANCE**: `"standalone"` = `"standalone"`
|
|
2050
2065
|
|
|
2051
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2066
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/dot-env.schema.ts#L10)
|
|
2052
2067
|
|
|
2053
2068
|
Use this value to indicate that the resources are not part of the SettleMint platform.
|
|
2054
2069
|
|
|
@@ -2058,7 +2073,7 @@ Use this value to indicate that the resources are not part of the SettleMint pla
|
|
|
2058
2073
|
|
|
2059
2074
|
> `const` **UniqueNameSchema**: `ZodString`
|
|
2060
2075
|
|
|
2061
|
-
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2076
|
+
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/unique-name.schema.ts#L19)
|
|
2062
2077
|
|
|
2063
2078
|
Schema for validating unique names used across the SettleMint platform.
|
|
2064
2079
|
Only accepts lowercase alphanumeric characters and hyphens.
|
|
@@ -2084,7 +2099,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
|
|
|
2084
2099
|
|
|
2085
2100
|
> `const` **UrlOrPathSchema**: `ZodUnion`\<[`UrlOrPath`](#urlorpath)\>
|
|
2086
2101
|
|
|
2087
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2102
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/url.schema.ts#L54)
|
|
2088
2103
|
|
|
2089
2104
|
Schema that accepts either a full URL or a URL path.
|
|
2090
2105
|
|
|
@@ -2108,7 +2123,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
2108
2123
|
|
|
2109
2124
|
> `const` **UrlPathSchema**: `ZodString`\<[`UrlPath`](#urlpath)\>
|
|
2110
2125
|
|
|
2111
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2126
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/url.schema.ts#L34)
|
|
2112
2127
|
|
|
2113
2128
|
Schema for validating URL paths.
|
|
2114
2129
|
|
|
@@ -2132,7 +2147,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
2132
2147
|
|
|
2133
2148
|
> `const` **UrlSchema**: `ZodString`\<[`Url`](#url)\>
|
|
2134
2149
|
|
|
2135
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2150
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.6.4/sdk/utils/src/validation/url.schema.ts#L17)
|
|
2136
2151
|
|
|
2137
2152
|
Schema for validating URLs.
|
|
2138
2153
|
|