@settlemint/sdk-utils 2.6.6-prc6016dbc → 2.6.11-main5328fef
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 +162 -162
- 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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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,7 +353,7 @@ ensureServer();
|
|
|
353
353
|
|
|
354
354
|
> **executeCommand**(`command`, `args`, `options?`): `Promise`\<`string`[]\>
|
|
355
355
|
|
|
356
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:60](https://github.com/settlemint/sdk/blob/v2.6.
|
|
356
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:60](https://github.com/settlemint/sdk/blob/v2.6.11/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.
|
|
@@ -397,7 +397,7 @@ await executeCommand("npm", ["install"], { silent: true });
|
|
|
397
397
|
|
|
398
398
|
> **exists**(`path`): `Promise`\<`boolean`\>
|
|
399
399
|
|
|
400
|
-
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.11/sdk/utils/src/filesystem/exists.ts#L17)
|
|
401
401
|
|
|
402
402
|
Checks if a file or directory exists at the given path
|
|
403
403
|
|
|
@@ -430,7 +430,7 @@ if (await exists('/path/to/file.txt')) {
|
|
|
430
430
|
|
|
431
431
|
> **extractBaseUrlBeforeSegment**(`baseUrl`, `pathSegment`): `string`
|
|
432
432
|
|
|
433
|
-
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.11/sdk/utils/src/url.ts#L15)
|
|
434
434
|
|
|
435
435
|
Extracts the base URL before a specific segment in a URL.
|
|
436
436
|
|
|
@@ -462,7 +462,7 @@ const baseUrl = extractBaseUrlBeforeSegment("https://example.com/api/v1/subgraph
|
|
|
462
462
|
|
|
463
463
|
> **extractJsonObject**\<`T`\>(`value`): `T` \| `null`
|
|
464
464
|
|
|
465
|
-
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.11/sdk/utils/src/json.ts#L50)
|
|
466
466
|
|
|
467
467
|
Extracts a JSON object from a string.
|
|
468
468
|
|
|
@@ -505,7 +505,7 @@ const json = extractJsonObject<{ port: number }>(
|
|
|
505
505
|
|
|
506
506
|
> **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
|
|
507
507
|
|
|
508
|
-
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.11/sdk/utils/src/http/fetch-with-retry.ts#L18)
|
|
509
509
|
|
|
510
510
|
Retry an HTTP request with exponential backoff and jitter.
|
|
511
511
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -543,7 +543,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
|
|
|
543
543
|
|
|
544
544
|
> **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
|
|
545
545
|
|
|
546
|
-
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.11/sdk/utils/src/filesystem/mono-repo.ts#L59)
|
|
547
547
|
|
|
548
548
|
Finds all packages in a monorepo
|
|
549
549
|
|
|
@@ -574,7 +574,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
|
|
|
574
574
|
|
|
575
575
|
> **findMonoRepoRoot**(`startDir`): `Promise`\<`string` \| `null`\>
|
|
576
576
|
|
|
577
|
-
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.11/sdk/utils/src/filesystem/mono-repo.ts#L19)
|
|
578
578
|
|
|
579
579
|
Finds the root directory of a monorepo
|
|
580
580
|
|
|
@@ -605,7 +605,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
|
|
|
605
605
|
|
|
606
606
|
> **formatTargetDir**(`targetDir`): `string`
|
|
607
607
|
|
|
608
|
-
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.11/sdk/utils/src/package-manager/download-and-extract.ts#L15)
|
|
609
609
|
|
|
610
610
|
Formats a directory path by removing trailing slashes and whitespace
|
|
611
611
|
|
|
@@ -635,7 +635,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
|
|
|
635
635
|
|
|
636
636
|
> **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
|
|
637
637
|
|
|
638
|
-
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.11/sdk/utils/src/package-manager/get-package-manager.ts#L15)
|
|
639
639
|
|
|
640
640
|
Detects the package manager used in the current project
|
|
641
641
|
|
|
@@ -666,7 +666,7 @@ console.log(`Using ${packageManager}`);
|
|
|
666
666
|
|
|
667
667
|
> **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
|
|
668
668
|
|
|
669
|
-
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.11/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
|
|
670
670
|
|
|
671
671
|
Retrieves the executable command and arguments for the package manager
|
|
672
672
|
|
|
@@ -697,7 +697,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
|
|
|
697
697
|
|
|
698
698
|
> **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
|
|
699
699
|
|
|
700
|
-
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.11/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
|
|
701
701
|
|
|
702
702
|
Executes a GraphQL request with automatic retries using exponential backoff and jitter.
|
|
703
703
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -756,7 +756,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
|
|
|
756
756
|
|
|
757
757
|
> **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
|
|
758
758
|
|
|
759
|
-
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.11/sdk/utils/src/package-manager/install-dependencies.ts#L20)
|
|
760
760
|
|
|
761
761
|
Installs one or more packages as dependencies using the detected package manager
|
|
762
762
|
|
|
@@ -795,7 +795,7 @@ await installDependencies(["express", "cors"]);
|
|
|
795
795
|
|
|
796
796
|
> **intro**(`msg`): `void`
|
|
797
797
|
|
|
798
|
-
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.11/sdk/utils/src/terminal/intro.ts#L16)
|
|
799
799
|
|
|
800
800
|
Displays an introductory message in magenta text with padding.
|
|
801
801
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -825,7 +825,7 @@ intro("Starting deployment...");
|
|
|
825
825
|
|
|
826
826
|
> **isEmpty**(`path`): `Promise`\<`boolean`\>
|
|
827
827
|
|
|
828
|
-
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.11/sdk/utils/src/package-manager/download-and-extract.ts#L31)
|
|
829
829
|
|
|
830
830
|
Checks if a directory is empty or contains only a .git folder
|
|
831
831
|
|
|
@@ -857,7 +857,7 @@ if (await isEmpty("/path/to/dir")) {
|
|
|
857
857
|
|
|
858
858
|
> **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
|
|
859
859
|
|
|
860
|
-
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.11/sdk/utils/src/package-manager/is-package-installed.ts#L17)
|
|
861
861
|
|
|
862
862
|
Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
|
|
863
863
|
|
|
@@ -893,7 +893,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
|
|
|
893
893
|
|
|
894
894
|
> **list**(`title`, `items`): `void`
|
|
895
895
|
|
|
896
|
-
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.11/sdk/utils/src/terminal/list.ts#L23)
|
|
897
897
|
|
|
898
898
|
Displays a list of items in a formatted manner, supporting nested items.
|
|
899
899
|
|
|
@@ -933,7 +933,7 @@ list("Providers", [
|
|
|
933
933
|
|
|
934
934
|
> **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
|
|
935
935
|
|
|
936
|
-
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.11/sdk/utils/src/environment/load-env.ts#L25)
|
|
937
937
|
|
|
938
938
|
Loads environment variables from .env files.
|
|
939
939
|
To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
|
|
@@ -981,7 +981,7 @@ const rawEnv = await loadEnv(false, false);
|
|
|
981
981
|
|
|
982
982
|
> **makeJsonStringifiable**\<`T`\>(`value`): `T`
|
|
983
983
|
|
|
984
|
-
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.11/sdk/utils/src/json.ts#L73)
|
|
985
985
|
|
|
986
986
|
Converts a value to a JSON stringifiable format.
|
|
987
987
|
|
|
@@ -1018,7 +1018,7 @@ const json = makeJsonStringifiable<{ amount: bigint }>({ amount: BigInt(1000) })
|
|
|
1018
1018
|
|
|
1019
1019
|
> **maskTokens**(`output`): `string`
|
|
1020
1020
|
|
|
1021
|
-
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.11/sdk/utils/src/logging/mask-tokens.ts#L13)
|
|
1022
1022
|
|
|
1023
1023
|
Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
|
|
1024
1024
|
Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
|
|
@@ -1050,7 +1050,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
|
|
|
1050
1050
|
|
|
1051
1051
|
> **note**(`message`, `level`): `void`
|
|
1052
1052
|
|
|
1053
|
-
Defined in: [sdk/utils/src/terminal/note.ts:90](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1053
|
+
Defined in: [sdk/utils/src/terminal/note.ts:90](https://github.com/settlemint/sdk/blob/v2.6.11/sdk/utils/src/terminal/note.ts#L90)
|
|
1054
1054
|
|
|
1055
1055
|
Displays a note message with optional warning or error level formatting.
|
|
1056
1056
|
Regular notes are displayed in normal text, warnings are shown in yellow, and errors in red.
|
|
@@ -1098,7 +1098,7 @@ try {
|
|
|
1098
1098
|
|
|
1099
1099
|
> **outro**(`msg`): `void`
|
|
1100
1100
|
|
|
1101
|
-
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.11/sdk/utils/src/terminal/outro.ts#L16)
|
|
1102
1102
|
|
|
1103
1103
|
Displays a closing message in green inverted text with padding.
|
|
1104
1104
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -1128,7 +1128,7 @@ outro("Deployment completed successfully!");
|
|
|
1128
1128
|
|
|
1129
1129
|
> **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
|
|
1130
1130
|
|
|
1131
|
-
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.11/sdk/utils/src/filesystem/project-root.ts#L18)
|
|
1132
1132
|
|
|
1133
1133
|
Finds the root directory of the current project by locating the nearest package.json file
|
|
1134
1134
|
|
|
@@ -1165,7 +1165,7 @@ console.log(`Project root is at: ${rootDir}`);
|
|
|
1165
1165
|
|
|
1166
1166
|
> **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
|
|
1167
1167
|
|
|
1168
|
-
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.11/sdk/utils/src/string.ts#L48)
|
|
1169
1169
|
|
|
1170
1170
|
Replaces underscores and hyphens with spaces.
|
|
1171
1171
|
|
|
@@ -1196,7 +1196,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
|
|
|
1196
1196
|
|
|
1197
1197
|
> **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
|
|
1198
1198
|
|
|
1199
|
-
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.11/sdk/utils/src/logging/request-logger.ts#L14)
|
|
1200
1200
|
|
|
1201
1201
|
Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
|
|
1202
1202
|
|
|
@@ -1230,7 +1230,7 @@ The fetch function
|
|
|
1230
1230
|
|
|
1231
1231
|
> **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
|
|
1232
1232
|
|
|
1233
|
-
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.11/sdk/utils/src/retry.ts#L16)
|
|
1234
1234
|
|
|
1235
1235
|
Retry a function when it fails.
|
|
1236
1236
|
|
|
@@ -1270,7 +1270,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
|
|
|
1270
1270
|
|
|
1271
1271
|
> **setName**(`name`, `path?`): `Promise`\<`void`\>
|
|
1272
1272
|
|
|
1273
|
-
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.11/sdk/utils/src/package-manager/set-name.ts#L16)
|
|
1274
1274
|
|
|
1275
1275
|
Sets the name field in the package.json file
|
|
1276
1276
|
|
|
@@ -1305,7 +1305,7 @@ await setName("my-new-project-name");
|
|
|
1305
1305
|
|
|
1306
1306
|
> **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
|
|
1307
1307
|
|
|
1308
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:54](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1308
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:54](https://github.com/settlemint/sdk/blob/v2.6.11/sdk/utils/src/terminal/spinner.ts#L54)
|
|
1309
1309
|
|
|
1310
1310
|
Displays a loading spinner while executing an async task.
|
|
1311
1311
|
Shows progress with start/stop messages and handles errors.
|
|
@@ -1355,7 +1355,7 @@ const result = await spinner({
|
|
|
1355
1355
|
|
|
1356
1356
|
> **table**(`title`, `data`): `void`
|
|
1357
1357
|
|
|
1358
|
-
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.11/sdk/utils/src/terminal/table.ts#L21)
|
|
1359
1359
|
|
|
1360
1360
|
Displays data in a formatted table in the terminal.
|
|
1361
1361
|
|
|
@@ -1389,7 +1389,7 @@ table("My Table", data);
|
|
|
1389
1389
|
|
|
1390
1390
|
> **truncate**(`value`, `maxLength`): `string`
|
|
1391
1391
|
|
|
1392
|
-
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.11/sdk/utils/src/string.ts#L65)
|
|
1393
1393
|
|
|
1394
1394
|
Truncates a string to a maximum length and appends "..." if it is longer.
|
|
1395
1395
|
|
|
@@ -1421,7 +1421,7 @@ const truncated = truncate("Hello, world!", 10);
|
|
|
1421
1421
|
|
|
1422
1422
|
> **tryParseJson**\<`T`\>(`value`, `defaultValue`): `T` \| `null`
|
|
1423
1423
|
|
|
1424
|
-
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.11/sdk/utils/src/json.ts#L23)
|
|
1425
1425
|
|
|
1426
1426
|
Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
|
|
1427
1427
|
|
|
@@ -1468,7 +1468,7 @@ const invalid = tryParseJson<string[]>(
|
|
|
1468
1468
|
|
|
1469
1469
|
> **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
|
|
1470
1470
|
|
|
1471
|
-
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.11/sdk/utils/src/validation/validate.ts#L16)
|
|
1472
1472
|
|
|
1473
1473
|
Validates a value against a given Zod schema.
|
|
1474
1474
|
|
|
@@ -1509,7 +1509,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
|
|
|
1509
1509
|
|
|
1510
1510
|
> **writeEnv**(`options`): `Promise`\<`void`\>
|
|
1511
1511
|
|
|
1512
|
-
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.11/sdk/utils/src/environment/write-env.ts#L41)
|
|
1513
1513
|
|
|
1514
1514
|
Writes environment variables to .env files across a project or monorepo
|
|
1515
1515
|
|
|
@@ -1561,7 +1561,7 @@ await writeEnv({
|
|
|
1561
1561
|
|
|
1562
1562
|
#### CancelError
|
|
1563
1563
|
|
|
1564
|
-
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.11/sdk/utils/src/terminal/cancel.ts#L8)
|
|
1565
1565
|
|
|
1566
1566
|
Error class used to indicate that the operation was cancelled.
|
|
1567
1567
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1574,7 +1574,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1574
1574
|
|
|
1575
1575
|
#### CommandError
|
|
1576
1576
|
|
|
1577
|
-
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.11/sdk/utils/src/terminal/execute-command.ts#L16)
|
|
1578
1578
|
|
|
1579
1579
|
Error class for command execution errors
|
|
1580
1580
|
|
|
@@ -1588,7 +1588,7 @@ Error class for command execution errors
|
|
|
1588
1588
|
|
|
1589
1589
|
> **new CommandError**(`message`, `code`, `output`): [`CommandError`](#commanderror)
|
|
1590
1590
|
|
|
1591
|
-
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.11/sdk/utils/src/terminal/execute-command.ts#L23)
|
|
1592
1592
|
|
|
1593
1593
|
Constructs a new CommandError
|
|
1594
1594
|
|
|
@@ -1614,7 +1614,7 @@ Constructs a new CommandError
|
|
|
1614
1614
|
|
|
1615
1615
|
> `readonly` **code**: `number`
|
|
1616
1616
|
|
|
1617
|
-
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.11/sdk/utils/src/terminal/execute-command.ts#L25)
|
|
1618
1618
|
|
|
1619
1619
|
The exit code of the command
|
|
1620
1620
|
|
|
@@ -1622,7 +1622,7 @@ The exit code of the command
|
|
|
1622
1622
|
|
|
1623
1623
|
> `readonly` **output**: `string`[]
|
|
1624
1624
|
|
|
1625
|
-
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.11/sdk/utils/src/terminal/execute-command.ts#L26)
|
|
1626
1626
|
|
|
1627
1627
|
The output of the command
|
|
1628
1628
|
|
|
@@ -1630,7 +1630,7 @@ The output of the command
|
|
|
1630
1630
|
|
|
1631
1631
|
#### SpinnerError
|
|
1632
1632
|
|
|
1633
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:11](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1633
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:11](https://github.com/settlemint/sdk/blob/v2.6.11/sdk/utils/src/terminal/spinner.ts#L11)
|
|
1634
1634
|
|
|
1635
1635
|
Error class used to indicate that the spinner operation failed.
|
|
1636
1636
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1643,7 +1643,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1643
1643
|
|
|
1644
1644
|
#### ExecuteCommandOptions
|
|
1645
1645
|
|
|
1646
|
-
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.11/sdk/utils/src/terminal/execute-command.ts#L7)
|
|
1647
1647
|
|
|
1648
1648
|
Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
1649
1649
|
|
|
@@ -1655,13 +1655,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
|
1655
1655
|
|
|
1656
1656
|
| Property | Type | Description | Defined in |
|
|
1657
1657
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.11/sdk/utils/src/terminal/execute-command.ts#L9) |
|
|
1659
1659
|
|
|
1660
1660
|
***
|
|
1661
1661
|
|
|
1662
1662
|
#### Logger
|
|
1663
1663
|
|
|
1664
|
-
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.11/sdk/utils/src/logging/logger.ts#L23)
|
|
1665
1665
|
|
|
1666
1666
|
Simple logger interface with basic logging methods
|
|
1667
1667
|
Logger
|
|
@@ -1670,16 +1670,16 @@ Simple logger interface with basic logging methods
|
|
|
1670
1670
|
|
|
1671
1671
|
| Property | Type | Description | Defined in |
|
|
1672
1672
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.11/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.11/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.11/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.11/sdk/utils/src/logging/logger.ts#L29) |
|
|
1677
1677
|
|
|
1678
1678
|
***
|
|
1679
1679
|
|
|
1680
1680
|
#### LoggerOptions
|
|
1681
1681
|
|
|
1682
|
-
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.11/sdk/utils/src/logging/logger.ts#L12)
|
|
1683
1683
|
|
|
1684
1684
|
Configuration options for the logger
|
|
1685
1685
|
LoggerOptions
|
|
@@ -1688,14 +1688,14 @@ Configuration options for the logger
|
|
|
1688
1688
|
|
|
1689
1689
|
| Property | Type | Description | Defined in |
|
|
1690
1690
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.11/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.11/sdk/utils/src/logging/logger.ts#L16) |
|
|
1693
1693
|
|
|
1694
1694
|
***
|
|
1695
1695
|
|
|
1696
1696
|
#### SpinnerOptions
|
|
1697
1697
|
|
|
1698
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:24](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1698
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:24](https://github.com/settlemint/sdk/blob/v2.6.11/sdk/utils/src/terminal/spinner.ts#L24)
|
|
1699
1699
|
|
|
1700
1700
|
Options for configuring the spinner behavior
|
|
1701
1701
|
|
|
@@ -1709,9 +1709,9 @@ Options for configuring the spinner behavior
|
|
|
1709
1709
|
|
|
1710
1710
|
| Property | Type | Description | Defined in |
|
|
1711
1711
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.11/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.11/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.11/sdk/utils/src/terminal/spinner.ts#L28) |
|
|
1715
1715
|
|
|
1716
1716
|
### Type Aliases
|
|
1717
1717
|
|
|
@@ -1719,7 +1719,7 @@ Options for configuring the spinner behavior
|
|
|
1719
1719
|
|
|
1720
1720
|
> **AccessToken** = `string`
|
|
1721
1721
|
|
|
1722
|
-
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.11/sdk/utils/src/validation/access-token.schema.ts#L22)
|
|
1723
1723
|
|
|
1724
1724
|
Schema for validating both application and personal access tokens.
|
|
1725
1725
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1730,7 +1730,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1730
1730
|
|
|
1731
1731
|
> **ApplicationAccessToken** = `string`
|
|
1732
1732
|
|
|
1733
|
-
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.11/sdk/utils/src/validation/access-token.schema.ts#L8)
|
|
1734
1734
|
|
|
1735
1735
|
Schema for validating application access tokens.
|
|
1736
1736
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1741,7 +1741,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1741
1741
|
|
|
1742
1742
|
> **DotEnv** = `object`
|
|
1743
1743
|
|
|
1744
|
-
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.11/sdk/utils/src/validation/dot-env.schema.ts#L112)
|
|
1745
1745
|
|
|
1746
1746
|
Type definition for the environment variables schema.
|
|
1747
1747
|
|
|
@@ -1749,45 +1749,45 @@ Type definition for the environment variables schema.
|
|
|
1749
1749
|
|
|
1750
1750
|
| Name | Type | Description | Defined in |
|
|
1751
1751
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/sdk/utils/src/validation/dot-env.schema.ts#L31) |
|
|
1791
1791
|
|
|
1792
1792
|
***
|
|
1793
1793
|
|
|
@@ -1795,7 +1795,7 @@ Type definition for the environment variables schema.
|
|
|
1795
1795
|
|
|
1796
1796
|
> **DotEnvPartial** = `object`
|
|
1797
1797
|
|
|
1798
|
-
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.11/sdk/utils/src/validation/dot-env.schema.ts#L123)
|
|
1799
1799
|
|
|
1800
1800
|
Type definition for the partial environment variables schema.
|
|
1801
1801
|
|
|
@@ -1803,45 +1803,45 @@ Type definition for the partial environment variables schema.
|
|
|
1803
1803
|
|
|
1804
1804
|
| Name | Type | Description | Defined in |
|
|
1805
1805
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/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.11/sdk/utils/src/validation/dot-env.schema.ts#L31) |
|
|
1845
1845
|
|
|
1846
1846
|
***
|
|
1847
1847
|
|
|
@@ -1849,7 +1849,7 @@ Type definition for the partial environment variables schema.
|
|
|
1849
1849
|
|
|
1850
1850
|
> **Id** = `string`
|
|
1851
1851
|
|
|
1852
|
-
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.11/sdk/utils/src/validation/id.schema.ts#L30)
|
|
1853
1853
|
|
|
1854
1854
|
Type definition for database IDs, inferred from IdSchema.
|
|
1855
1855
|
Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
@@ -1860,7 +1860,7 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
|
1860
1860
|
|
|
1861
1861
|
> **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
|
|
1862
1862
|
|
|
1863
|
-
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.11/sdk/utils/src/logging/logger.ts#L6)
|
|
1864
1864
|
|
|
1865
1865
|
Log levels supported by the logger
|
|
1866
1866
|
|
|
@@ -1870,7 +1870,7 @@ Log levels supported by the logger
|
|
|
1870
1870
|
|
|
1871
1871
|
> **PersonalAccessToken** = `string`
|
|
1872
1872
|
|
|
1873
|
-
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.11/sdk/utils/src/validation/access-token.schema.ts#L15)
|
|
1874
1874
|
|
|
1875
1875
|
Schema for validating personal access tokens.
|
|
1876
1876
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -1881,7 +1881,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
1881
1881
|
|
|
1882
1882
|
> **Url** = `string`
|
|
1883
1883
|
|
|
1884
|
-
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.11/sdk/utils/src/validation/url.schema.ts#L18)
|
|
1885
1885
|
|
|
1886
1886
|
Schema for validating URLs.
|
|
1887
1887
|
|
|
@@ -1905,7 +1905,7 @@ const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
|
|
|
1905
1905
|
|
|
1906
1906
|
> **UrlOrPath** = `string`
|
|
1907
1907
|
|
|
1908
|
-
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.11/sdk/utils/src/validation/url.schema.ts#L55)
|
|
1909
1909
|
|
|
1910
1910
|
Schema that accepts either a full URL or a URL path.
|
|
1911
1911
|
|
|
@@ -1929,7 +1929,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
1929
1929
|
|
|
1930
1930
|
> **UrlPath** = `string`
|
|
1931
1931
|
|
|
1932
|
-
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.11/sdk/utils/src/validation/url.schema.ts#L38)
|
|
1933
1933
|
|
|
1934
1934
|
Schema for validating URL paths.
|
|
1935
1935
|
|
|
@@ -1953,7 +1953,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
1953
1953
|
|
|
1954
1954
|
> `const` **AccessTokenSchema**: `ZodString`\<[`AccessToken`](#accesstoken)\>
|
|
1955
1955
|
|
|
1956
|
-
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.11/sdk/utils/src/validation/access-token.schema.ts#L21)
|
|
1957
1957
|
|
|
1958
1958
|
Schema for validating both application and personal access tokens.
|
|
1959
1959
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1964,7 +1964,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1964
1964
|
|
|
1965
1965
|
> `const` **ApplicationAccessTokenSchema**: `ZodString`\<[`ApplicationAccessToken`](#applicationaccesstoken)\>
|
|
1966
1966
|
|
|
1967
|
-
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.11/sdk/utils/src/validation/access-token.schema.ts#L7)
|
|
1968
1968
|
|
|
1969
1969
|
Schema for validating application access tokens.
|
|
1970
1970
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1975,7 +1975,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1975
1975
|
|
|
1976
1976
|
> `const` **DotEnvSchema**: `ZodObject`\<[`DotEnv`](#dotenv)\>
|
|
1977
1977
|
|
|
1978
|
-
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.11/sdk/utils/src/validation/dot-env.schema.ts#L21)
|
|
1979
1979
|
|
|
1980
1980
|
Schema for validating environment variables used by the SettleMint SDK.
|
|
1981
1981
|
Defines validation rules and types for configuration values like URLs,
|
|
@@ -1987,7 +1987,7 @@ access tokens, workspace names, and service endpoints.
|
|
|
1987
1987
|
|
|
1988
1988
|
> `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
|
|
1989
1989
|
|
|
1990
|
-
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.11/sdk/utils/src/validation/dot-env.schema.ts#L118)
|
|
1991
1991
|
|
|
1992
1992
|
Partial version of the environment variables schema where all fields are optional.
|
|
1993
1993
|
Useful for validating incomplete configurations during development or build time.
|
|
@@ -1998,7 +1998,7 @@ Useful for validating incomplete configurations during development or build time
|
|
|
1998
1998
|
|
|
1999
1999
|
> `const` **IdSchema**: `ZodUnion`\<[`Id`](#id)\>
|
|
2000
2000
|
|
|
2001
|
-
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.11/sdk/utils/src/validation/id.schema.ts#L17)
|
|
2002
2002
|
|
|
2003
2003
|
Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
|
|
2004
2004
|
PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
|
|
@@ -2022,7 +2022,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
|
|
|
2022
2022
|
|
|
2023
2023
|
> `const` **LOCAL\_INSTANCE**: `"local"` = `"local"`
|
|
2024
2024
|
|
|
2025
|
-
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.11/sdk/utils/src/validation/dot-env.schema.ts#L14)
|
|
2026
2026
|
|
|
2027
2027
|
Use this value to indicate that the resources are not part of the SettleMint platform.
|
|
2028
2028
|
|
|
@@ -2032,7 +2032,7 @@ Use this value to indicate that the resources are not part of the SettleMint pla
|
|
|
2032
2032
|
|
|
2033
2033
|
> `const` **PersonalAccessTokenSchema**: `ZodString`\<[`PersonalAccessToken`](#personalaccesstoken)\>
|
|
2034
2034
|
|
|
2035
|
-
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.11/sdk/utils/src/validation/access-token.schema.ts#L14)
|
|
2036
2036
|
|
|
2037
2037
|
Schema for validating personal access tokens.
|
|
2038
2038
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -2043,7 +2043,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
2043
2043
|
|
|
2044
2044
|
> `const` **runsInBrowser**: `boolean` = `isBrowser`
|
|
2045
2045
|
|
|
2046
|
-
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.11/sdk/utils/src/runtime/ensure-server.ts#L40)
|
|
2047
2047
|
|
|
2048
2048
|
Boolean indicating if code is currently running in a browser environment
|
|
2049
2049
|
|
|
@@ -2053,7 +2053,7 @@ Boolean indicating if code is currently running in a browser environment
|
|
|
2053
2053
|
|
|
2054
2054
|
> `const` **runsOnServer**: `boolean` = `!isBrowser`
|
|
2055
2055
|
|
|
2056
|
-
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.11/sdk/utils/src/runtime/ensure-server.ts#L45)
|
|
2057
2057
|
|
|
2058
2058
|
Boolean indicating if code is currently running in a server environment
|
|
2059
2059
|
|
|
@@ -2063,7 +2063,7 @@ Boolean indicating if code is currently running in a server environment
|
|
|
2063
2063
|
|
|
2064
2064
|
> `const` **STANDALONE\_INSTANCE**: `"standalone"` = `"standalone"`
|
|
2065
2065
|
|
|
2066
|
-
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.11/sdk/utils/src/validation/dot-env.schema.ts#L10)
|
|
2067
2067
|
|
|
2068
2068
|
Use this value to indicate that the resources are not part of the SettleMint platform.
|
|
2069
2069
|
|
|
@@ -2073,7 +2073,7 @@ Use this value to indicate that the resources are not part of the SettleMint pla
|
|
|
2073
2073
|
|
|
2074
2074
|
> `const` **UniqueNameSchema**: `ZodString`
|
|
2075
2075
|
|
|
2076
|
-
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.11/sdk/utils/src/validation/unique-name.schema.ts#L19)
|
|
2077
2077
|
|
|
2078
2078
|
Schema for validating unique names used across the SettleMint platform.
|
|
2079
2079
|
Only accepts lowercase alphanumeric characters and hyphens.
|
|
@@ -2099,7 +2099,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
|
|
|
2099
2099
|
|
|
2100
2100
|
> `const` **UrlOrPathSchema**: `ZodUnion`\<[`UrlOrPath`](#urlorpath)\>
|
|
2101
2101
|
|
|
2102
|
-
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.11/sdk/utils/src/validation/url.schema.ts#L54)
|
|
2103
2103
|
|
|
2104
2104
|
Schema that accepts either a full URL or a URL path.
|
|
2105
2105
|
|
|
@@ -2123,7 +2123,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
2123
2123
|
|
|
2124
2124
|
> `const` **UrlPathSchema**: `ZodString`\<[`UrlPath`](#urlpath)\>
|
|
2125
2125
|
|
|
2126
|
-
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.11/sdk/utils/src/validation/url.schema.ts#L34)
|
|
2127
2127
|
|
|
2128
2128
|
Schema for validating URL paths.
|
|
2129
2129
|
|
|
@@ -2147,7 +2147,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
2147
2147
|
|
|
2148
2148
|
> `const` **UrlSchema**: `ZodString`\<[`Url`](#url)\>
|
|
2149
2149
|
|
|
2150
|
-
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.11/sdk/utils/src/validation/url.schema.ts#L17)
|
|
2151
2151
|
|
|
2152
2152
|
Schema for validating URLs.
|
|
2153
2153
|
|
package/package.json
CHANGED