@settlemint/sdk-utils 2.6.1-prd8cf44b4 → 2.6.2
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.2/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.2/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.2/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.2/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.2/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.2/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.2/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.2/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:51](https://github.com/settlemint/sdk/blob/v2.6.
|
|
356
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:51](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/execute-command.ts#L51)
|
|
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.
|
|
@@ -395,7 +395,7 @@ await executeCommand("npm", ["install"], { silent: true });
|
|
|
395
395
|
|
|
396
396
|
> **exists**(`path`): `Promise`\<`boolean`\>
|
|
397
397
|
|
|
398
|
-
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.6.
|
|
398
|
+
Defined in: [sdk/utils/src/filesystem/exists.ts:17](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/filesystem/exists.ts#L17)
|
|
399
399
|
|
|
400
400
|
Checks if a file or directory exists at the given path
|
|
401
401
|
|
|
@@ -428,7 +428,7 @@ if (await exists('/path/to/file.txt')) {
|
|
|
428
428
|
|
|
429
429
|
> **extractBaseUrlBeforeSegment**(`baseUrl`, `pathSegment`): `string`
|
|
430
430
|
|
|
431
|
-
Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.6.
|
|
431
|
+
Defined in: [sdk/utils/src/url.ts:15](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/url.ts#L15)
|
|
432
432
|
|
|
433
433
|
Extracts the base URL before a specific segment in a URL.
|
|
434
434
|
|
|
@@ -460,7 +460,7 @@ const baseUrl = extractBaseUrlBeforeSegment("https://example.com/api/v1/subgraph
|
|
|
460
460
|
|
|
461
461
|
> **extractJsonObject**\<`T`\>(`value`): `null` \| `T`
|
|
462
462
|
|
|
463
|
-
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.6.
|
|
463
|
+
Defined in: [sdk/utils/src/json.ts:50](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/json.ts#L50)
|
|
464
464
|
|
|
465
465
|
Extracts a JSON object from a string.
|
|
466
466
|
|
|
@@ -503,7 +503,7 @@ const json = extractJsonObject<{ port: number }>(
|
|
|
503
503
|
|
|
504
504
|
> **fetchWithRetry**(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Response`\>
|
|
505
505
|
|
|
506
|
-
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.6.
|
|
506
|
+
Defined in: [sdk/utils/src/http/fetch-with-retry.ts:18](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/http/fetch-with-retry.ts#L18)
|
|
507
507
|
|
|
508
508
|
Retry an HTTP request with exponential backoff and jitter.
|
|
509
509
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -541,7 +541,7 @@ const response = await fetchWithRetry("https://api.example.com/data");
|
|
|
541
541
|
|
|
542
542
|
> **findMonoRepoPackages**(`projectDir`): `Promise`\<`string`[]\>
|
|
543
543
|
|
|
544
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.6.
|
|
544
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:59](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/filesystem/mono-repo.ts#L59)
|
|
545
545
|
|
|
546
546
|
Finds all packages in a monorepo
|
|
547
547
|
|
|
@@ -572,7 +572,7 @@ console.log(packages); // Output: ["/path/to/your/project/packages/core", "/path
|
|
|
572
572
|
|
|
573
573
|
> **findMonoRepoRoot**(`startDir`): `Promise`\<`null` \| `string`\>
|
|
574
574
|
|
|
575
|
-
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.6.
|
|
575
|
+
Defined in: [sdk/utils/src/filesystem/mono-repo.ts:19](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/filesystem/mono-repo.ts#L19)
|
|
576
576
|
|
|
577
577
|
Finds the root directory of a monorepo
|
|
578
578
|
|
|
@@ -603,7 +603,7 @@ console.log(root); // Output: /path/to/your/project/packages/core
|
|
|
603
603
|
|
|
604
604
|
> **formatTargetDir**(`targetDir`): `string`
|
|
605
605
|
|
|
606
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.6.
|
|
606
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:15](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/package-manager/download-and-extract.ts#L15)
|
|
607
607
|
|
|
608
608
|
Formats a directory path by removing trailing slashes and whitespace
|
|
609
609
|
|
|
@@ -633,7 +633,7 @@ const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
|
|
|
633
633
|
|
|
634
634
|
> **getPackageManager**(`targetDir?`): `Promise`\<`AgentName`\>
|
|
635
635
|
|
|
636
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.6.
|
|
636
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager.ts:15](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/package-manager/get-package-manager.ts#L15)
|
|
637
637
|
|
|
638
638
|
Detects the package manager used in the current project
|
|
639
639
|
|
|
@@ -664,7 +664,7 @@ console.log(`Using ${packageManager}`);
|
|
|
664
664
|
|
|
665
665
|
> **getPackageManagerExecutable**(`targetDir?`): `Promise`\<\{ `args`: `string`[]; `command`: `string`; \}\>
|
|
666
666
|
|
|
667
|
-
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
667
|
+
Defined in: [sdk/utils/src/package-manager/get-package-manager-executable.ts:14](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/package-manager/get-package-manager-executable.ts#L14)
|
|
668
668
|
|
|
669
669
|
Retrieves the executable command and arguments for the package manager
|
|
670
670
|
|
|
@@ -695,7 +695,7 @@ console.log(`Using ${command} with args: ${args.join(" ")}`);
|
|
|
695
695
|
|
|
696
696
|
> **graphqlFetchWithRetry**\<`Data`\>(`input`, `init?`, `maxRetries?`, `initialSleepTime?`): `Promise`\<`Data`\>
|
|
697
697
|
|
|
698
|
-
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.6.
|
|
698
|
+
Defined in: [sdk/utils/src/http/graphql-fetch-with-retry.ts:34](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/http/graphql-fetch-with-retry.ts#L34)
|
|
699
699
|
|
|
700
700
|
Executes a GraphQL request with automatic retries using exponential backoff and jitter.
|
|
701
701
|
Only retries on server errors (5xx), rate limits (429), timeouts (408), and network errors.
|
|
@@ -754,7 +754,7 @@ const data = await graphqlFetchWithRetry<{ user: { id: string } }>(
|
|
|
754
754
|
|
|
755
755
|
> **installDependencies**(`pkgs`, `cwd?`): `Promise`\<`void`\>
|
|
756
756
|
|
|
757
|
-
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.6.
|
|
757
|
+
Defined in: [sdk/utils/src/package-manager/install-dependencies.ts:20](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/package-manager/install-dependencies.ts#L20)
|
|
758
758
|
|
|
759
759
|
Installs one or more packages as dependencies using the detected package manager
|
|
760
760
|
|
|
@@ -793,7 +793,7 @@ await installDependencies(["express", "cors"]);
|
|
|
793
793
|
|
|
794
794
|
> **intro**(`msg`): `void`
|
|
795
795
|
|
|
796
|
-
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
796
|
+
Defined in: [sdk/utils/src/terminal/intro.ts:16](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/intro.ts#L16)
|
|
797
797
|
|
|
798
798
|
Displays an introductory message in magenta text with padding.
|
|
799
799
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -823,7 +823,7 @@ intro("Starting deployment...");
|
|
|
823
823
|
|
|
824
824
|
> **isEmpty**(`path`): `Promise`\<`boolean`\>
|
|
825
825
|
|
|
826
|
-
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.6.
|
|
826
|
+
Defined in: [sdk/utils/src/package-manager/download-and-extract.ts:31](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/package-manager/download-and-extract.ts#L31)
|
|
827
827
|
|
|
828
828
|
Checks if a directory is empty or contains only a .git folder
|
|
829
829
|
|
|
@@ -855,7 +855,7 @@ if (await isEmpty("/path/to/dir")) {
|
|
|
855
855
|
|
|
856
856
|
> **isPackageInstalled**(`name`, `path?`): `Promise`\<`boolean`\>
|
|
857
857
|
|
|
858
|
-
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.6.
|
|
858
|
+
Defined in: [sdk/utils/src/package-manager/is-package-installed.ts:17](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/package-manager/is-package-installed.ts#L17)
|
|
859
859
|
|
|
860
860
|
Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
|
|
861
861
|
|
|
@@ -891,7 +891,7 @@ console.log(`@settlemint/sdk-utils is installed: ${isInstalled}`);
|
|
|
891
891
|
|
|
892
892
|
> **list**(`title`, `items`): `void`
|
|
893
893
|
|
|
894
|
-
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
894
|
+
Defined in: [sdk/utils/src/terminal/list.ts:23](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/list.ts#L23)
|
|
895
895
|
|
|
896
896
|
Displays a list of items in a formatted manner, supporting nested items.
|
|
897
897
|
|
|
@@ -931,7 +931,7 @@ list("Providers", [
|
|
|
931
931
|
|
|
932
932
|
> **loadEnv**\<`T`\>(`validateEnv`, `prod`, `path`): `Promise`\<`T` *extends* `true` ? `object` : `object`\>
|
|
933
933
|
|
|
934
|
-
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.6.
|
|
934
|
+
Defined in: [sdk/utils/src/environment/load-env.ts:25](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/environment/load-env.ts#L25)
|
|
935
935
|
|
|
936
936
|
Loads environment variables from .env files.
|
|
937
937
|
To enable encryption with dotenvx (https://www.dotenvx.com/docs) run `bunx dotenvx encrypt`
|
|
@@ -979,7 +979,7 @@ const rawEnv = await loadEnv(false, false);
|
|
|
979
979
|
|
|
980
980
|
> **makeJsonStringifiable**\<`T`\>(`value`): `T`
|
|
981
981
|
|
|
982
|
-
Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.6.
|
|
982
|
+
Defined in: [sdk/utils/src/json.ts:73](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/json.ts#L73)
|
|
983
983
|
|
|
984
984
|
Converts a value to a JSON stringifiable format.
|
|
985
985
|
|
|
@@ -1016,7 +1016,7 @@ const json = makeJsonStringifiable<{ amount: bigint }>({ amount: BigInt(1000) })
|
|
|
1016
1016
|
|
|
1017
1017
|
> **maskTokens**(`output`): `string`
|
|
1018
1018
|
|
|
1019
|
-
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1019
|
+
Defined in: [sdk/utils/src/logging/mask-tokens.ts:13](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/logging/mask-tokens.ts#L13)
|
|
1020
1020
|
|
|
1021
1021
|
Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
|
|
1022
1022
|
Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
|
|
@@ -1048,7 +1048,7 @@ const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
|
|
|
1048
1048
|
|
|
1049
1049
|
> **note**(`message`, `level`): `void`
|
|
1050
1050
|
|
|
1051
|
-
Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1051
|
+
Defined in: [sdk/utils/src/terminal/note.ts:21](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/note.ts#L21)
|
|
1052
1052
|
|
|
1053
1053
|
Displays a note message with optional warning level formatting.
|
|
1054
1054
|
Regular notes are displayed in normal text, while warnings are shown in yellow.
|
|
@@ -1083,7 +1083,7 @@ note("Low disk space remaining", "warn");
|
|
|
1083
1083
|
|
|
1084
1084
|
> **outro**(`msg`): `void`
|
|
1085
1085
|
|
|
1086
|
-
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1086
|
+
Defined in: [sdk/utils/src/terminal/outro.ts:16](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/outro.ts#L16)
|
|
1087
1087
|
|
|
1088
1088
|
Displays a closing message in green inverted text with padding.
|
|
1089
1089
|
Any sensitive tokens in the message are masked before display.
|
|
@@ -1113,7 +1113,7 @@ outro("Deployment completed successfully!");
|
|
|
1113
1113
|
|
|
1114
1114
|
> **projectRoot**(`fallbackToCwd`, `cwd?`): `Promise`\<`string`\>
|
|
1115
1115
|
|
|
1116
|
-
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1116
|
+
Defined in: [sdk/utils/src/filesystem/project-root.ts:18](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/filesystem/project-root.ts#L18)
|
|
1117
1117
|
|
|
1118
1118
|
Finds the root directory of the current project by locating the nearest package.json file
|
|
1119
1119
|
|
|
@@ -1150,7 +1150,7 @@ console.log(`Project root is at: ${rootDir}`);
|
|
|
1150
1150
|
|
|
1151
1151
|
> **replaceUnderscoresAndHyphensWithSpaces**(`s`): `string`
|
|
1152
1152
|
|
|
1153
|
-
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1153
|
+
Defined in: [sdk/utils/src/string.ts:48](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/string.ts#L48)
|
|
1154
1154
|
|
|
1155
1155
|
Replaces underscores and hyphens with spaces.
|
|
1156
1156
|
|
|
@@ -1181,7 +1181,7 @@ const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
|
|
|
1181
1181
|
|
|
1182
1182
|
> **requestLogger**(`logger`, `name`, `fn`): (...`args`) => `Promise`\<`Response`\>
|
|
1183
1183
|
|
|
1184
|
-
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1184
|
+
Defined in: [sdk/utils/src/logging/request-logger.ts:14](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/logging/request-logger.ts#L14)
|
|
1185
1185
|
|
|
1186
1186
|
Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
|
|
1187
1187
|
|
|
@@ -1215,7 +1215,7 @@ The fetch function
|
|
|
1215
1215
|
|
|
1216
1216
|
> **retryWhenFailed**\<`T`\>(`fn`, `maxRetries`, `initialSleepTime`, `stopOnError?`): `Promise`\<`T`\>
|
|
1217
1217
|
|
|
1218
|
-
Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1218
|
+
Defined in: [sdk/utils/src/retry.ts:16](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/retry.ts#L16)
|
|
1219
1219
|
|
|
1220
1220
|
Retry a function when it fails.
|
|
1221
1221
|
|
|
@@ -1255,7 +1255,7 @@ const result = await retryWhenFailed(() => readFile("/path/to/file.txt"), 3, 1_0
|
|
|
1255
1255
|
|
|
1256
1256
|
> **setName**(`name`, `path?`): `Promise`\<`void`\>
|
|
1257
1257
|
|
|
1258
|
-
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1258
|
+
Defined in: [sdk/utils/src/package-manager/set-name.ts:16](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/package-manager/set-name.ts#L16)
|
|
1259
1259
|
|
|
1260
1260
|
Sets the name field in the package.json file
|
|
1261
1261
|
|
|
@@ -1290,7 +1290,7 @@ await setName("my-new-project-name");
|
|
|
1290
1290
|
|
|
1291
1291
|
> **spinner**\<`R`\>(`options`): `Promise`\<`R`\>
|
|
1292
1292
|
|
|
1293
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1293
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:55](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/spinner.ts#L55)
|
|
1294
1294
|
|
|
1295
1295
|
Displays a loading spinner while executing an async task.
|
|
1296
1296
|
Shows progress with start/stop messages and handles errors.
|
|
@@ -1340,7 +1340,7 @@ const result = await spinner({
|
|
|
1340
1340
|
|
|
1341
1341
|
> **table**(`title`, `data`): `void`
|
|
1342
1342
|
|
|
1343
|
-
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1343
|
+
Defined in: [sdk/utils/src/terminal/table.ts:21](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/table.ts#L21)
|
|
1344
1344
|
|
|
1345
1345
|
Displays data in a formatted table in the terminal.
|
|
1346
1346
|
|
|
@@ -1374,7 +1374,7 @@ table("My Table", data);
|
|
|
1374
1374
|
|
|
1375
1375
|
> **truncate**(`value`, `maxLength`): `string`
|
|
1376
1376
|
|
|
1377
|
-
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1377
|
+
Defined in: [sdk/utils/src/string.ts:65](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/string.ts#L65)
|
|
1378
1378
|
|
|
1379
1379
|
Truncates a string to a maximum length and appends "..." if it is longer.
|
|
1380
1380
|
|
|
@@ -1406,7 +1406,7 @@ const truncated = truncate("Hello, world!", 10);
|
|
|
1406
1406
|
|
|
1407
1407
|
> **tryParseJson**\<`T`\>(`value`, `defaultValue`): `null` \| `T`
|
|
1408
1408
|
|
|
1409
|
-
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1409
|
+
Defined in: [sdk/utils/src/json.ts:23](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/json.ts#L23)
|
|
1410
1410
|
|
|
1411
1411
|
Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
|
|
1412
1412
|
|
|
@@ -1453,7 +1453,7 @@ const invalid = tryParseJson<string[]>(
|
|
|
1453
1453
|
|
|
1454
1454
|
> **validate**\<`T`\>(`schema`, `value`): `T`\[`"_output"`\]
|
|
1455
1455
|
|
|
1456
|
-
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1456
|
+
Defined in: [sdk/utils/src/validation/validate.ts:16](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/validate.ts#L16)
|
|
1457
1457
|
|
|
1458
1458
|
Validates a value against a given Zod schema.
|
|
1459
1459
|
|
|
@@ -1494,7 +1494,7 @@ const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
|
|
|
1494
1494
|
|
|
1495
1495
|
> **writeEnv**(`options`): `Promise`\<`void`\>
|
|
1496
1496
|
|
|
1497
|
-
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1497
|
+
Defined in: [sdk/utils/src/environment/write-env.ts:41](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/environment/write-env.ts#L41)
|
|
1498
1498
|
|
|
1499
1499
|
Writes environment variables to .env files across a project or monorepo
|
|
1500
1500
|
|
|
@@ -1546,7 +1546,7 @@ await writeEnv({
|
|
|
1546
1546
|
|
|
1547
1547
|
#### CancelError
|
|
1548
1548
|
|
|
1549
|
-
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1549
|
+
Defined in: [sdk/utils/src/terminal/cancel.ts:8](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/cancel.ts#L8)
|
|
1550
1550
|
|
|
1551
1551
|
Error class used to indicate that the operation was cancelled.
|
|
1552
1552
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1559,7 +1559,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1559
1559
|
|
|
1560
1560
|
#### CommandError
|
|
1561
1561
|
|
|
1562
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1562
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:16](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/execute-command.ts#L16)
|
|
1563
1563
|
|
|
1564
1564
|
Error class for command execution errors
|
|
1565
1565
|
|
|
@@ -1573,7 +1573,7 @@ Error class for command execution errors
|
|
|
1573
1573
|
|
|
1574
1574
|
> **new CommandError**(`message`, `code`, `output`): [`CommandError`](#commanderror)
|
|
1575
1575
|
|
|
1576
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1576
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:23](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/execute-command.ts#L23)
|
|
1577
1577
|
|
|
1578
1578
|
Constructs a new CommandError
|
|
1579
1579
|
|
|
@@ -1599,7 +1599,7 @@ Constructs a new CommandError
|
|
|
1599
1599
|
|
|
1600
1600
|
> `readonly` **code**: `number`
|
|
1601
1601
|
|
|
1602
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1602
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:25](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/execute-command.ts#L25)
|
|
1603
1603
|
|
|
1604
1604
|
The exit code of the command
|
|
1605
1605
|
|
|
@@ -1607,7 +1607,7 @@ The exit code of the command
|
|
|
1607
1607
|
|
|
1608
1608
|
> `readonly` **output**: `string`[]
|
|
1609
1609
|
|
|
1610
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1610
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:26](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/execute-command.ts#L26)
|
|
1611
1611
|
|
|
1612
1612
|
The output of the command
|
|
1613
1613
|
|
|
@@ -1615,7 +1615,7 @@ The output of the command
|
|
|
1615
1615
|
|
|
1616
1616
|
#### SpinnerError
|
|
1617
1617
|
|
|
1618
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1618
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:12](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/spinner.ts#L12)
|
|
1619
1619
|
|
|
1620
1620
|
Error class used to indicate that the spinner operation failed.
|
|
1621
1621
|
This error is used to signal that the operation should be aborted.
|
|
@@ -1628,7 +1628,7 @@ This error is used to signal that the operation should be aborted.
|
|
|
1628
1628
|
|
|
1629
1629
|
#### ExecuteCommandOptions
|
|
1630
1630
|
|
|
1631
|
-
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1631
|
+
Defined in: [sdk/utils/src/terminal/execute-command.ts:7](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/execute-command.ts#L7)
|
|
1632
1632
|
|
|
1633
1633
|
Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
1634
1634
|
|
|
@@ -1640,13 +1640,13 @@ Options for executing a command, extending SpawnOptionsWithoutStdio
|
|
|
1640
1640
|
|
|
1641
1641
|
| Property | Type | Description | Defined in |
|
|
1642
1642
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.2/sdk/utils/src/terminal/execute-command.ts#L9) |
|
|
1644
1644
|
|
|
1645
1645
|
***
|
|
1646
1646
|
|
|
1647
1647
|
#### Logger
|
|
1648
1648
|
|
|
1649
|
-
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1649
|
+
Defined in: [sdk/utils/src/logging/logger.ts:23](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/logging/logger.ts#L23)
|
|
1650
1650
|
|
|
1651
1651
|
Simple logger interface with basic logging methods
|
|
1652
1652
|
Logger
|
|
@@ -1655,16 +1655,16 @@ Simple logger interface with basic logging methods
|
|
|
1655
1655
|
|
|
1656
1656
|
| Property | Type | Description | Defined in |
|
|
1657
1657
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.2/sdk/utils/src/logging/logger.ts#L25) |
|
|
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.2/sdk/utils/src/logging/logger.ts#L31) |
|
|
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.2/sdk/utils/src/logging/logger.ts#L27) |
|
|
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.2/sdk/utils/src/logging/logger.ts#L29) |
|
|
1662
1662
|
|
|
1663
1663
|
***
|
|
1664
1664
|
|
|
1665
1665
|
#### LoggerOptions
|
|
1666
1666
|
|
|
1667
|
-
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1667
|
+
Defined in: [sdk/utils/src/logging/logger.ts:12](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/logging/logger.ts#L12)
|
|
1668
1668
|
|
|
1669
1669
|
Configuration options for the logger
|
|
1670
1670
|
LoggerOptions
|
|
@@ -1673,14 +1673,14 @@ Configuration options for the logger
|
|
|
1673
1673
|
|
|
1674
1674
|
| Property | Type | Description | Defined in |
|
|
1675
1675
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.2/sdk/utils/src/logging/logger.ts#L14) |
|
|
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.2/sdk/utils/src/logging/logger.ts#L16) |
|
|
1678
1678
|
|
|
1679
1679
|
***
|
|
1680
1680
|
|
|
1681
1681
|
#### SpinnerOptions\<R\>
|
|
1682
1682
|
|
|
1683
|
-
Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1683
|
+
Defined in: [sdk/utils/src/terminal/spinner.ts:25](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/spinner.ts#L25)
|
|
1684
1684
|
|
|
1685
1685
|
Options for configuring the spinner behavior
|
|
1686
1686
|
|
|
@@ -1694,9 +1694,9 @@ Options for configuring the spinner behavior
|
|
|
1694
1694
|
|
|
1695
1695
|
| Property | Type | Description | Defined in |
|
|
1696
1696
|
| ------ | ------ | ------ | ------ |
|
|
1697
|
-
| <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:27](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1698
|
-
| <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:31](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1699
|
-
| <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:29](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1697
|
+
| <a id="startmessage"></a> `startMessage` | `string` | Message to display when spinner starts | [sdk/utils/src/terminal/spinner.ts:27](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/spinner.ts#L27) |
|
|
1698
|
+
| <a id="stopmessage"></a> `stopMessage` | `string` | Message to display when spinner completes successfully | [sdk/utils/src/terminal/spinner.ts:31](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/spinner.ts#L31) |
|
|
1699
|
+
| <a id="task"></a> `task` | (`spinner?`) => `Promise`\<`R`\> | Async task to execute while spinner is active | [sdk/utils/src/terminal/spinner.ts:29](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/terminal/spinner.ts#L29) |
|
|
1700
1700
|
|
|
1701
1701
|
### Type Aliases
|
|
1702
1702
|
|
|
@@ -1704,7 +1704,7 @@ Options for configuring the spinner behavior
|
|
|
1704
1704
|
|
|
1705
1705
|
> **AccessToken** = `string`
|
|
1706
1706
|
|
|
1707
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1707
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/access-token.schema.ts#L22)
|
|
1708
1708
|
|
|
1709
1709
|
Schema for validating both application and personal access tokens.
|
|
1710
1710
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1715,7 +1715,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1715
1715
|
|
|
1716
1716
|
> **ApplicationAccessToken** = `string`
|
|
1717
1717
|
|
|
1718
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1718
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/access-token.schema.ts#L8)
|
|
1719
1719
|
|
|
1720
1720
|
Schema for validating application access tokens.
|
|
1721
1721
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1726,7 +1726,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1726
1726
|
|
|
1727
1727
|
> **DotEnv** = `object`
|
|
1728
1728
|
|
|
1729
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1729
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/dot-env.schema.ts#L112)
|
|
1730
1730
|
|
|
1731
1731
|
Type definition for the environment variables schema.
|
|
1732
1732
|
|
|
@@ -1734,45 +1734,45 @@ Type definition for the environment variables schema.
|
|
|
1734
1734
|
|
|
1735
1735
|
| Name | Type | Description | Defined in |
|
|
1736
1736
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L27) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L76) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L33) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L35) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L37) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L39) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L41) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L43) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L45) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L98) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L100) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L102) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L94) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L96) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L47) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L49) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L72) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L74) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L23) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L86) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L88) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L92) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L90) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L106) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L78) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L82) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L80) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L84) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L104) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L64) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L66) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L68) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L70) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L62) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L31) |
|
|
1776
1776
|
|
|
1777
1777
|
***
|
|
1778
1778
|
|
|
@@ -1780,7 +1780,7 @@ Type definition for the environment variables schema.
|
|
|
1780
1780
|
|
|
1781
1781
|
> **DotEnvPartial** = `object`
|
|
1782
1782
|
|
|
1783
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:123](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1783
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:123](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/dot-env.schema.ts#L123)
|
|
1784
1784
|
|
|
1785
1785
|
Type definition for the partial environment variables schema.
|
|
1786
1786
|
|
|
@@ -1788,45 +1788,45 @@ Type definition for the partial environment variables schema.
|
|
|
1788
1788
|
|
|
1789
1789
|
| Name | Type | Description | Defined in |
|
|
1790
1790
|
| ------ | ------ | ------ | ------ |
|
|
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.
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L27) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L76) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L33) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L35) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L37) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L39) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L41) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L43) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L45) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L98) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L100) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L102) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L94) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L96) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L47) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L49) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L72) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L74) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L23) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L86) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L88) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L92) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L90) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L106) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L78) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L82) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L80) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L84) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L104) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L64) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L66) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L68) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L70) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L62) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
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.2/sdk/utils/src/validation/dot-env.schema.ts#L31) |
|
|
1830
1830
|
|
|
1831
1831
|
***
|
|
1832
1832
|
|
|
@@ -1834,7 +1834,7 @@ Type definition for the partial environment variables schema.
|
|
|
1834
1834
|
|
|
1835
1835
|
> **Id** = `string`
|
|
1836
1836
|
|
|
1837
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1837
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/id.schema.ts#L30)
|
|
1838
1838
|
|
|
1839
1839
|
Type definition for database IDs, inferred from IdSchema.
|
|
1840
1840
|
Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
@@ -1845,7 +1845,7 @@ Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
|
|
|
1845
1845
|
|
|
1846
1846
|
> **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` \| `"none"`
|
|
1847
1847
|
|
|
1848
|
-
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1848
|
+
Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/logging/logger.ts#L6)
|
|
1849
1849
|
|
|
1850
1850
|
Log levels supported by the logger
|
|
1851
1851
|
|
|
@@ -1855,7 +1855,7 @@ Log levels supported by the logger
|
|
|
1855
1855
|
|
|
1856
1856
|
> **PersonalAccessToken** = `string`
|
|
1857
1857
|
|
|
1858
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1858
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/access-token.schema.ts#L15)
|
|
1859
1859
|
|
|
1860
1860
|
Schema for validating personal access tokens.
|
|
1861
1861
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -1866,7 +1866,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
1866
1866
|
|
|
1867
1867
|
> **Url** = `string`
|
|
1868
1868
|
|
|
1869
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1869
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/url.schema.ts#L18)
|
|
1870
1870
|
|
|
1871
1871
|
Schema for validating URLs.
|
|
1872
1872
|
|
|
@@ -1890,7 +1890,7 @@ const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
|
|
|
1890
1890
|
|
|
1891
1891
|
> **UrlOrPath** = `string`
|
|
1892
1892
|
|
|
1893
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1893
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/url.schema.ts#L55)
|
|
1894
1894
|
|
|
1895
1895
|
Schema that accepts either a full URL or a URL path.
|
|
1896
1896
|
|
|
@@ -1914,7 +1914,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
1914
1914
|
|
|
1915
1915
|
> **UrlPath** = `string`
|
|
1916
1916
|
|
|
1917
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1917
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/url.schema.ts#L38)
|
|
1918
1918
|
|
|
1919
1919
|
Schema for validating URL paths.
|
|
1920
1920
|
|
|
@@ -1938,7 +1938,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
1938
1938
|
|
|
1939
1939
|
> `const` **AccessTokenSchema**: `ZodString`\<[`AccessToken`](#accesstoken)\>
|
|
1940
1940
|
|
|
1941
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1941
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/access-token.schema.ts#L21)
|
|
1942
1942
|
|
|
1943
1943
|
Schema for validating both application and personal access tokens.
|
|
1944
1944
|
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
@@ -1949,7 +1949,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1949
1949
|
|
|
1950
1950
|
> `const` **ApplicationAccessTokenSchema**: `ZodString`\<[`ApplicationAccessToken`](#applicationaccesstoken)\>
|
|
1951
1951
|
|
|
1952
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1952
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/access-token.schema.ts#L7)
|
|
1953
1953
|
|
|
1954
1954
|
Schema for validating application access tokens.
|
|
1955
1955
|
Application access tokens start with 'sm_aat_' prefix.
|
|
@@ -1960,7 +1960,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1960
1960
|
|
|
1961
1961
|
> `const` **DotEnvSchema**: `ZodObject`\<[`DotEnv`](#dotenv)\>
|
|
1962
1962
|
|
|
1963
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1963
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/dot-env.schema.ts#L21)
|
|
1964
1964
|
|
|
1965
1965
|
Schema for validating environment variables used by the SettleMint SDK.
|
|
1966
1966
|
Defines validation rules and types for configuration values like URLs,
|
|
@@ -1972,7 +1972,7 @@ access tokens, workspace names, and service endpoints.
|
|
|
1972
1972
|
|
|
1973
1973
|
> `const` **DotEnvSchemaPartial**: `ZodObject`\<[`DotEnvPartial`](#dotenvpartial)\>
|
|
1974
1974
|
|
|
1975
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:118](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1975
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:118](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/dot-env.schema.ts#L118)
|
|
1976
1976
|
|
|
1977
1977
|
Partial version of the environment variables schema where all fields are optional.
|
|
1978
1978
|
Useful for validating incomplete configurations during development or build time.
|
|
@@ -1983,7 +1983,7 @@ Useful for validating incomplete configurations during development or build time
|
|
|
1983
1983
|
|
|
1984
1984
|
> `const` **IdSchema**: `ZodUnion`\<[`Id`](#id)\>
|
|
1985
1985
|
|
|
1986
|
-
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.6.
|
|
1986
|
+
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/id.schema.ts#L17)
|
|
1987
1987
|
|
|
1988
1988
|
Schema for validating database IDs. Accepts both PostgreSQL UUIDs and MongoDB ObjectIDs.
|
|
1989
1989
|
PostgreSQL UUIDs are 32 hexadecimal characters with hyphens (e.g. 123e4567-e89b-12d3-a456-426614174000).
|
|
@@ -2007,7 +2007,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
|
|
|
2007
2007
|
|
|
2008
2008
|
> `const` **LOCAL\_INSTANCE**: `"local"` = `"local"`
|
|
2009
2009
|
|
|
2010
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2010
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/dot-env.schema.ts#L14)
|
|
2011
2011
|
|
|
2012
2012
|
Use this value to indicate that the resources are not part of the SettleMint platform.
|
|
2013
2013
|
|
|
@@ -2017,7 +2017,7 @@ Use this value to indicate that the resources are not part of the SettleMint pla
|
|
|
2017
2017
|
|
|
2018
2018
|
> `const` **PersonalAccessTokenSchema**: `ZodString`\<[`PersonalAccessToken`](#personalaccesstoken)\>
|
|
2019
2019
|
|
|
2020
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2020
|
+
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/access-token.schema.ts#L14)
|
|
2021
2021
|
|
|
2022
2022
|
Schema for validating personal access tokens.
|
|
2023
2023
|
Personal access tokens start with 'sm_pat_' prefix.
|
|
@@ -2028,7 +2028,7 @@ Personal access tokens start with 'sm_pat_' prefix.
|
|
|
2028
2028
|
|
|
2029
2029
|
> `const` **runsInBrowser**: `boolean` = `isBrowser`
|
|
2030
2030
|
|
|
2031
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2031
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:40](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/runtime/ensure-server.ts#L40)
|
|
2032
2032
|
|
|
2033
2033
|
Boolean indicating if code is currently running in a browser environment
|
|
2034
2034
|
|
|
@@ -2038,7 +2038,7 @@ Boolean indicating if code is currently running in a browser environment
|
|
|
2038
2038
|
|
|
2039
2039
|
> `const` **runsOnServer**: `boolean` = `!isBrowser`
|
|
2040
2040
|
|
|
2041
|
-
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2041
|
+
Defined in: [sdk/utils/src/runtime/ensure-server.ts:45](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/runtime/ensure-server.ts#L45)
|
|
2042
2042
|
|
|
2043
2043
|
Boolean indicating if code is currently running in a server environment
|
|
2044
2044
|
|
|
@@ -2048,7 +2048,7 @@ Boolean indicating if code is currently running in a server environment
|
|
|
2048
2048
|
|
|
2049
2049
|
> `const` **STANDALONE\_INSTANCE**: `"standalone"` = `"standalone"`
|
|
2050
2050
|
|
|
2051
|
-
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2051
|
+
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:10](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/dot-env.schema.ts#L10)
|
|
2052
2052
|
|
|
2053
2053
|
Use this value to indicate that the resources are not part of the SettleMint platform.
|
|
2054
2054
|
|
|
@@ -2058,7 +2058,7 @@ Use this value to indicate that the resources are not part of the SettleMint pla
|
|
|
2058
2058
|
|
|
2059
2059
|
> `const` **UniqueNameSchema**: `ZodString`
|
|
2060
2060
|
|
|
2061
|
-
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2061
|
+
Defined in: [sdk/utils/src/validation/unique-name.schema.ts:19](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/unique-name.schema.ts#L19)
|
|
2062
2062
|
|
|
2063
2063
|
Schema for validating unique names used across the SettleMint platform.
|
|
2064
2064
|
Only accepts lowercase alphanumeric characters and hyphens.
|
|
@@ -2084,7 +2084,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
|
|
|
2084
2084
|
|
|
2085
2085
|
> `const` **UrlOrPathSchema**: `ZodUnion`\<[`UrlOrPath`](#urlorpath)\>
|
|
2086
2086
|
|
|
2087
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2087
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/url.schema.ts#L54)
|
|
2088
2088
|
|
|
2089
2089
|
Schema that accepts either a full URL or a URL path.
|
|
2090
2090
|
|
|
@@ -2108,7 +2108,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
2108
2108
|
|
|
2109
2109
|
> `const` **UrlPathSchema**: `ZodString`\<[`UrlPath`](#urlpath)\>
|
|
2110
2110
|
|
|
2111
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2111
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/url.schema.ts#L34)
|
|
2112
2112
|
|
|
2113
2113
|
Schema for validating URL paths.
|
|
2114
2114
|
|
|
@@ -2132,7 +2132,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
2132
2132
|
|
|
2133
2133
|
> `const` **UrlSchema**: `ZodString`\<[`Url`](#url)\>
|
|
2134
2134
|
|
|
2135
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.6.
|
|
2135
|
+
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.6.2/sdk/utils/src/validation/url.schema.ts#L17)
|
|
2136
2136
|
|
|
2137
2137
|
Schema for validating URLs.
|
|
2138
2138
|
|
package/package.json
CHANGED