@settlemint/sdk-utils 2.3.1-main3492b514 → 2.3.1-main432cffe9
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 +13 -212
- package/dist/environment.cjs +31 -31
- package/dist/environment.cjs.map +1 -1
- package/dist/environment.d.cts +19 -211
- package/dist/environment.d.ts +19 -211
- package/dist/environment.mjs +8 -8
- package/dist/environment.mjs.map +1 -1
- package/dist/validation.cjs +31 -31
- package/dist/validation.cjs.map +1 -1
- package/dist/validation.d.cts +22 -214
- package/dist/validation.d.ts +22 -214
- package/dist/validation.mjs +8 -8
- package/dist/validation.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -78,16 +78,10 @@
|
|
|
78
78
|
- [LoggerOptions](#loggeroptions)
|
|
79
79
|
- [SpinnerOptions\<R\>](#spinneroptionsr)
|
|
80
80
|
- [Type Aliases](#type-aliases)
|
|
81
|
-
- [AccessToken](#accesstoken)
|
|
82
|
-
- [ApplicationAccessToken](#applicationaccesstoken)
|
|
83
81
|
- [DotEnv](#dotenv)
|
|
84
82
|
- [DotEnvPartial](#dotenvpartial)
|
|
85
83
|
- [Id](#id)
|
|
86
84
|
- [LogLevel](#loglevel)
|
|
87
|
-
- [PersonalAccessToken](#personalaccesstoken)
|
|
88
|
-
- [Url](#url)
|
|
89
|
-
- [UrlOrPath](#urlorpath)
|
|
90
|
-
- [UrlPath](#urlpath)
|
|
91
85
|
- [Variables](#variables)
|
|
92
86
|
- [AccessTokenSchema](#accesstokenschema)
|
|
93
87
|
- [ApplicationAccessTokenSchema](#applicationaccesstokenschema)
|
|
@@ -1426,7 +1420,7 @@ Validates a value against a given Zod schema.
|
|
|
1426
1420
|
|
|
1427
1421
|
| Type Parameter |
|
|
1428
1422
|
| ------ |
|
|
1429
|
-
| `T` *extends* `ZodType`\<`
|
|
1423
|
+
| `T` *extends* `ZodType`\<`unknown`, `unknown`\> |
|
|
1430
1424
|
|
|
1431
1425
|
##### Parameters
|
|
1432
1426
|
|
|
@@ -1665,139 +1659,29 @@ Options for configuring the spinner behavior
|
|
|
1665
1659
|
|
|
1666
1660
|
### Type Aliases
|
|
1667
1661
|
|
|
1668
|
-
#### AccessToken
|
|
1669
|
-
|
|
1670
|
-
> **AccessToken** = `string`
|
|
1671
|
-
|
|
1672
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L22)
|
|
1673
|
-
|
|
1674
|
-
Schema for validating both application and personal access tokens.
|
|
1675
|
-
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
1676
|
-
|
|
1677
|
-
***
|
|
1678
|
-
|
|
1679
|
-
#### ApplicationAccessToken
|
|
1680
|
-
|
|
1681
|
-
> **ApplicationAccessToken** = `string`
|
|
1682
|
-
|
|
1683
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L8)
|
|
1684
|
-
|
|
1685
|
-
Schema for validating application access tokens.
|
|
1686
|
-
Application access tokens start with 'sm_aat_' prefix.
|
|
1687
|
-
|
|
1688
|
-
***
|
|
1689
|
-
|
|
1690
1662
|
#### DotEnv
|
|
1691
1663
|
|
|
1692
|
-
> **DotEnv** = `
|
|
1664
|
+
> **DotEnv** = `z.infer`\<*typeof* [`DotEnvSchema`](#dotenvschema)\>
|
|
1693
1665
|
|
|
1694
1666
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:101](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L101)
|
|
1695
1667
|
|
|
1696
1668
|
Type definition for the environment variables schema.
|
|
1697
1669
|
|
|
1698
|
-
##### Type declaration
|
|
1699
|
-
|
|
1700
|
-
| Name | Type | Description | Defined in |
|
|
1701
|
-
| ------ | ------ | ------ | ------ |
|
|
1702
|
-
| <a id="settlemint_access_token"></a> `SETTLEMINT_ACCESS_TOKEN?` | `string` | Application access token for authenticating with SettleMint services | [sdk/utils/src/validation/dot-env.schema.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L16) |
|
|
1703
|
-
| <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:65](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L65) |
|
|
1704
|
-
| <a id="settlemint_application"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L22) |
|
|
1705
|
-
| <a id="settlemint_blockchain_network"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK?` | `string` | Unique name of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:24](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L24) |
|
|
1706
|
-
| <a id="settlemint_blockchain_network_chain_id"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?` | `string` | Chain ID of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L26) |
|
|
1707
|
-
| <a id="settlemint_blockchain_node"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node (should have a private key for signing transactions) | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L28) |
|
|
1708
|
-
| <a id="settlemint_blockchain_node_json_rpc_endpoint"></a> `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L30) |
|
|
1709
|
-
| <a id="settlemint_blockchain_node_or_load_balancer"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?` | `string` | Unique name of the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:32](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L32) |
|
|
1710
|
-
| <a id="settlemint_blockchain_node_or_load_balancer_json_rpc_endpoint"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L34) |
|
|
1711
|
-
| <a id="settlemint_blockscout"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:87](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L87) |
|
|
1712
|
-
| <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:89](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L89) |
|
|
1713
|
-
| <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:91](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L91) |
|
|
1714
|
-
| <a id="settlemint_custom_deployment"></a> `SETTLEMINT_CUSTOM_DEPLOYMENT?` | `string` | Unique name of the custom deployment | [sdk/utils/src/validation/dot-env.schema.ts:83](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L83) |
|
|
1715
|
-
| <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:85](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L85) |
|
|
1716
|
-
| <a id="settlemint_hasura"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:36](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L36) |
|
|
1717
|
-
| <a id="settlemint_hasura_admin_secret"></a> `SETTLEMINT_HASURA_ADMIN_SECRET?` | `string` | Admin secret for authenticating with Hasura | [sdk/utils/src/validation/dot-env.schema.ts:40](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1718
|
-
| <a id="settlemint_hasura_database_url"></a> `SETTLEMINT_HASURA_DATABASE_URL?` | `string` | Database connection URL for Hasura | [sdk/utils/src/validation/dot-env.schema.ts:42](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L42) |
|
|
1719
|
-
| <a id="settlemint_hasura_endpoint"></a> `SETTLEMINT_HASURA_ENDPOINT?` | `string` | Endpoint URL for the Hasura GraphQL API | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L38) |
|
|
1720
|
-
| <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:61](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L61) |
|
|
1721
|
-
| <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:63](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L63) |
|
|
1722
|
-
| <a id="settlemint_instance"></a> `SETTLEMINT_INSTANCE` | `string` | Base URL of the SettleMint platform instance | [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L14) |
|
|
1723
|
-
| <a id="settlemint_ipfs"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:75](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L75) |
|
|
1724
|
-
| <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:77](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L77) |
|
|
1725
|
-
| <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:81](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L81) |
|
|
1726
|
-
| <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:79](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L79) |
|
|
1727
|
-
| <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:95](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L95) |
|
|
1728
|
-
| <a id="settlemint_minio"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:67](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L67) |
|
|
1729
|
-
| <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:71](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L71) |
|
|
1730
|
-
| <a id="settlemint_minio_endpoint"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:69](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L69) |
|
|
1731
|
-
| <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:73](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L73) |
|
|
1732
|
-
| <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:93](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L93) |
|
|
1733
|
-
| <a id="settlemint_portal"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:53](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1734
|
-
| <a id="settlemint_portal_graphql_endpoint"></a> `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
1735
|
-
| <a id="settlemint_portal_rest_endpoint"></a> `SETTLEMINT_PORTAL_REST_ENDPOINT?` | `string` | REST endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1736
|
-
| <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:59](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L59) |
|
|
1737
|
-
| <a id="settlemint_thegraph"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:44](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L44) |
|
|
1738
|
-
| <a id="settlemint_thegraph_default_subgraph"></a> `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH?` | `string` | Default The Graph subgraph to use | [sdk/utils/src/validation/dot-env.schema.ts:51](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1739
|
-
| <a id="settlemint_thegraph_subgraphs_endpoints"></a> `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?` | `string`[] | Array of endpoint URLs for The Graph subgraphs | [sdk/utils/src/validation/dot-env.schema.ts:46](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L46) |
|
|
1740
|
-
| <a id="settlemint_workspace"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:20](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1741
|
-
|
|
1742
1670
|
***
|
|
1743
1671
|
|
|
1744
1672
|
#### DotEnvPartial
|
|
1745
1673
|
|
|
1746
|
-
> **DotEnvPartial** = `
|
|
1674
|
+
> **DotEnvPartial** = `z.infer`\<*typeof* [`DotEnvSchemaPartial`](#dotenvschemapartial)\>
|
|
1747
1675
|
|
|
1748
1676
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L112)
|
|
1749
1677
|
|
|
1750
1678
|
Type definition for the partial environment variables schema.
|
|
1751
1679
|
|
|
1752
|
-
##### Type declaration
|
|
1753
|
-
|
|
1754
|
-
| Name | Type | Description | Defined in |
|
|
1755
|
-
| ------ | ------ | ------ | ------ |
|
|
1756
|
-
| <a id="settlemint_access_token-1"></a> `SETTLEMINT_ACCESS_TOKEN?` | `string` | Application access token for authenticating with SettleMint services | [sdk/utils/src/validation/dot-env.schema.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L16) |
|
|
1757
|
-
| <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:65](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L65) |
|
|
1758
|
-
| <a id="settlemint_application-1"></a> `SETTLEMINT_APPLICATION?` | `string` | Unique name of the application | [sdk/utils/src/validation/dot-env.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L22) |
|
|
1759
|
-
| <a id="settlemint_blockchain_network-1"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK?` | `string` | Unique name of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:24](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L24) |
|
|
1760
|
-
| <a id="settlemint_blockchain_network_chain_id-1"></a> `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID?` | `string` | Chain ID of the blockchain network | [sdk/utils/src/validation/dot-env.schema.ts:26](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L26) |
|
|
1761
|
-
| <a id="settlemint_blockchain_node-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE?` | `string` | Unique name of the blockchain node (should have a private key for signing transactions) | [sdk/utils/src/validation/dot-env.schema.ts:28](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L28) |
|
|
1762
|
-
| <a id="settlemint_blockchain_node_json_rpc_endpoint-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node | [sdk/utils/src/validation/dot-env.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L30) |
|
|
1763
|
-
| <a id="settlemint_blockchain_node_or_load_balancer-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER?` | `string` | Unique name of the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:32](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L32) |
|
|
1764
|
-
| <a id="settlemint_blockchain_node_or_load_balancer_json_rpc_endpoint-1"></a> `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT?` | `string` | JSON RPC endpoint for the blockchain node or load balancer | [sdk/utils/src/validation/dot-env.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L34) |
|
|
1765
|
-
| <a id="settlemint_blockscout-1"></a> `SETTLEMINT_BLOCKSCOUT?` | `string` | Unique name of the Blockscout instance | [sdk/utils/src/validation/dot-env.schema.ts:87](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L87) |
|
|
1766
|
-
| <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:89](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L89) |
|
|
1767
|
-
| <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:91](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L91) |
|
|
1768
|
-
| <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:83](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L83) |
|
|
1769
|
-
| <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:85](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L85) |
|
|
1770
|
-
| <a id="settlemint_hasura-1"></a> `SETTLEMINT_HASURA?` | `string` | Unique name of the Hasura instance | [sdk/utils/src/validation/dot-env.schema.ts:36](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L36) |
|
|
1771
|
-
| <a id="settlemint_hasura_admin_secret-1"></a> `SETTLEMINT_HASURA_ADMIN_SECRET?` | `string` | Admin secret for authenticating with Hasura | [sdk/utils/src/validation/dot-env.schema.ts:40](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L40) |
|
|
1772
|
-
| <a id="settlemint_hasura_database_url-1"></a> `SETTLEMINT_HASURA_DATABASE_URL?` | `string` | Database connection URL for Hasura | [sdk/utils/src/validation/dot-env.schema.ts:42](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L42) |
|
|
1773
|
-
| <a id="settlemint_hasura_endpoint-1"></a> `SETTLEMINT_HASURA_ENDPOINT?` | `string` | Endpoint URL for the Hasura GraphQL API | [sdk/utils/src/validation/dot-env.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L38) |
|
|
1774
|
-
| <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:61](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L61) |
|
|
1775
|
-
| <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:63](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L63) |
|
|
1776
|
-
| <a id="settlemint_instance-1"></a> `SETTLEMINT_INSTANCE?` | `string` | Base URL of the SettleMint platform instance | [sdk/utils/src/validation/dot-env.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L14) |
|
|
1777
|
-
| <a id="settlemint_ipfs-1"></a> `SETTLEMINT_IPFS?` | `string` | Unique name of the IPFS instance | [sdk/utils/src/validation/dot-env.schema.ts:75](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L75) |
|
|
1778
|
-
| <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:77](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L77) |
|
|
1779
|
-
| <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:81](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L81) |
|
|
1780
|
-
| <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:79](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L79) |
|
|
1781
|
-
| <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:95](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L95) |
|
|
1782
|
-
| <a id="settlemint_minio-1"></a> `SETTLEMINT_MINIO?` | `string` | Unique name of the MinIO instance | [sdk/utils/src/validation/dot-env.schema.ts:67](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L67) |
|
|
1783
|
-
| <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:71](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L71) |
|
|
1784
|
-
| <a id="settlemint_minio_endpoint-1"></a> `SETTLEMINT_MINIO_ENDPOINT?` | `string` | Endpoint URL for MinIO | [sdk/utils/src/validation/dot-env.schema.ts:69](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L69) |
|
|
1785
|
-
| <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:73](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L73) |
|
|
1786
|
-
| <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:93](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L93) |
|
|
1787
|
-
| <a id="settlemint_portal-1"></a> `SETTLEMINT_PORTAL?` | `string` | Unique name of the Smart Contract Portal instance | [sdk/utils/src/validation/dot-env.schema.ts:53](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L53) |
|
|
1788
|
-
| <a id="settlemint_portal_graphql_endpoint-1"></a> `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT?` | `string` | GraphQL endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L55) |
|
|
1789
|
-
| <a id="settlemint_portal_rest_endpoint-1"></a> `SETTLEMINT_PORTAL_REST_ENDPOINT?` | `string` | REST endpoint URL for the Portal | [sdk/utils/src/validation/dot-env.schema.ts:57](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L57) |
|
|
1790
|
-
| <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:59](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L59) |
|
|
1791
|
-
| <a id="settlemint_thegraph-1"></a> `SETTLEMINT_THEGRAPH?` | `string` | Unique name of The Graph instance | [sdk/utils/src/validation/dot-env.schema.ts:44](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L44) |
|
|
1792
|
-
| <a id="settlemint_thegraph_default_subgraph-1"></a> `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH?` | `string` | Default The Graph subgraph to use | [sdk/utils/src/validation/dot-env.schema.ts:51](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L51) |
|
|
1793
|
-
| <a id="settlemint_thegraph_subgraphs_endpoints-1"></a> `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS?` | `string`[] | Array of endpoint URLs for The Graph subgraphs | [sdk/utils/src/validation/dot-env.schema.ts:46](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L46) |
|
|
1794
|
-
| <a id="settlemint_workspace-1"></a> `SETTLEMINT_WORKSPACE?` | `string` | Unique name of the workspace | [sdk/utils/src/validation/dot-env.schema.ts:20](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L20) |
|
|
1795
|
-
|
|
1796
1680
|
***
|
|
1797
1681
|
|
|
1798
1682
|
#### Id
|
|
1799
1683
|
|
|
1800
|
-
> **Id** = `
|
|
1684
|
+
> **Id** = `z.infer`\<*typeof* [`IdSchema`](#idschema)\>
|
|
1801
1685
|
|
|
1802
1686
|
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/id.schema.ts#L30)
|
|
1803
1687
|
|
|
@@ -1814,94 +1698,11 @@ Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sd
|
|
|
1814
1698
|
|
|
1815
1699
|
Log levels supported by the logger
|
|
1816
1700
|
|
|
1817
|
-
***
|
|
1818
|
-
|
|
1819
|
-
#### PersonalAccessToken
|
|
1820
|
-
|
|
1821
|
-
> **PersonalAccessToken** = `string`
|
|
1822
|
-
|
|
1823
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L15)
|
|
1824
|
-
|
|
1825
|
-
Schema for validating personal access tokens.
|
|
1826
|
-
Personal access tokens start with 'sm_pat_' prefix.
|
|
1827
|
-
|
|
1828
|
-
***
|
|
1829
|
-
|
|
1830
|
-
#### Url
|
|
1831
|
-
|
|
1832
|
-
> **Url** = `string`
|
|
1833
|
-
|
|
1834
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L18)
|
|
1835
|
-
|
|
1836
|
-
Schema for validating URLs.
|
|
1837
|
-
|
|
1838
|
-
##### Example
|
|
1839
|
-
|
|
1840
|
-
```ts
|
|
1841
|
-
import { UrlSchema } from "@settlemint/sdk-utils/validation";
|
|
1842
|
-
|
|
1843
|
-
// Validate a URL
|
|
1844
|
-
const isValidUrl = UrlSchema.safeParse("https://console.settlemint.com").success;
|
|
1845
|
-
// true
|
|
1846
|
-
|
|
1847
|
-
// Invalid URLs will fail validation
|
|
1848
|
-
const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
|
|
1849
|
-
// false
|
|
1850
|
-
```
|
|
1851
|
-
|
|
1852
|
-
***
|
|
1853
|
-
|
|
1854
|
-
#### UrlOrPath
|
|
1855
|
-
|
|
1856
|
-
> **UrlOrPath** = `string`
|
|
1857
|
-
|
|
1858
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L55)
|
|
1859
|
-
|
|
1860
|
-
Schema that accepts either a full URL or a URL path.
|
|
1861
|
-
|
|
1862
|
-
##### Example
|
|
1863
|
-
|
|
1864
|
-
```ts
|
|
1865
|
-
import { UrlOrPathSchema } from "@settlemint/sdk-utils/validation";
|
|
1866
|
-
|
|
1867
|
-
// Validate a URL
|
|
1868
|
-
const isValidUrl = UrlOrPathSchema.safeParse("https://console.settlemint.com").success;
|
|
1869
|
-
// true
|
|
1870
|
-
|
|
1871
|
-
// Validate a path
|
|
1872
|
-
const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
1873
|
-
// true
|
|
1874
|
-
```
|
|
1875
|
-
|
|
1876
|
-
***
|
|
1877
|
-
|
|
1878
|
-
#### UrlPath
|
|
1879
|
-
|
|
1880
|
-
> **UrlPath** = `string`
|
|
1881
|
-
|
|
1882
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L38)
|
|
1883
|
-
|
|
1884
|
-
Schema for validating URL paths.
|
|
1885
|
-
|
|
1886
|
-
##### Example
|
|
1887
|
-
|
|
1888
|
-
```ts
|
|
1889
|
-
import { UrlPathSchema } from "@settlemint/sdk-utils/validation";
|
|
1890
|
-
|
|
1891
|
-
// Validate a URL path
|
|
1892
|
-
const isValidPath = UrlPathSchema.safeParse("/api/v1/users").success;
|
|
1893
|
-
// true
|
|
1894
|
-
|
|
1895
|
-
// Invalid paths will fail validation
|
|
1896
|
-
const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
1897
|
-
// false
|
|
1898
|
-
```
|
|
1899
|
-
|
|
1900
1701
|
### Variables
|
|
1901
1702
|
|
|
1902
1703
|
#### AccessTokenSchema
|
|
1903
1704
|
|
|
1904
|
-
> `const` **AccessTokenSchema**: `ZodString
|
|
1705
|
+
> `const` **AccessTokenSchema**: `ZodString`
|
|
1905
1706
|
|
|
1906
1707
|
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L21)
|
|
1907
1708
|
|
|
@@ -1912,7 +1713,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1912
1713
|
|
|
1913
1714
|
#### ApplicationAccessTokenSchema
|
|
1914
1715
|
|
|
1915
|
-
> `const` **ApplicationAccessTokenSchema**: `ZodString
|
|
1716
|
+
> `const` **ApplicationAccessTokenSchema**: `ZodString`
|
|
1916
1717
|
|
|
1917
1718
|
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L7)
|
|
1918
1719
|
|
|
@@ -1923,7 +1724,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1923
1724
|
|
|
1924
1725
|
#### DotEnvSchema
|
|
1925
1726
|
|
|
1926
|
-
> `const` **DotEnvSchema**: `ZodObject
|
|
1727
|
+
> `const` **DotEnvSchema**: `ZodObject`\<\{ `SETTLEMINT_ACCESS_TOKEN`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_APPLICATION`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_ADMIN_SECRET`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_DATABASE_URL`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HASURA_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HD_PRIVATE_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_INSTANCE`: `ZodDefault`\<`ZodString`\>; `SETTLEMINT_IPFS`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_API_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_LOG_LEVEL`: `ZodDefault`\<`ZodEnum`\<\{ `debug`: `"debug"`; `error`: `"error"`; `info`: `"info"`; `none`: `"none"`; `warn`: `"warn"`; \}\>\>; `SETTLEMINT_MINIO`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_ACCESS_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_MINIO_SECRET_KEY`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_NEW_PROJECT_NAME`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_PORTAL_WS_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `ZodOptional`\<`ZodString`\>; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `ZodPipe`\<`ZodTransform`\<`null` \| `never`[], `unknown`\>, `ZodOptional`\<`ZodArray`\<`ZodString`\>\>\>; `SETTLEMINT_WORKSPACE`: `ZodOptional`\<`ZodString`\>; \}, `$strip`\>
|
|
1927
1728
|
|
|
1928
1729
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:12](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L12)
|
|
1929
1730
|
|
|
@@ -1935,7 +1736,7 @@ access tokens, workspace names, and service endpoints.
|
|
|
1935
1736
|
|
|
1936
1737
|
#### DotEnvSchemaPartial
|
|
1937
1738
|
|
|
1938
|
-
> `const` **DotEnvSchemaPartial**: `ZodObject
|
|
1739
|
+
> `const` **DotEnvSchemaPartial**: `ZodObject`\<\{ `SETTLEMINT_ACCESS_TOKEN`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_ACCESSIBLE_PRIVATE_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_APPLICATION`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NETWORK`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_CUSTOM_DEPLOYMENT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_CUSTOM_DEPLOYMENT_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_ADMIN_SECRET`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_DATABASE_URL`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HASURA_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HD_PRIVATE_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_INSTANCE`: `ZodOptional`\<`ZodDefault`\<`ZodString`\>\>; `SETTLEMINT_IPFS`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_API_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_GATEWAY_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_IPFS_PINNING_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_LOG_LEVEL`: `ZodOptional`\<`ZodDefault`\<`ZodEnum`\<\{ `debug`: `"debug"`; `error`: `"error"`; `info`: `"info"`; `none`: `"none"`; `warn`: `"warn"`; \}\>\>\>; `SETTLEMINT_MINIO`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_ACCESS_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_MINIO_SECRET_KEY`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_NEW_PROJECT_NAME`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_REST_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_PORTAL_WS_ENDPOINT`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; `SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS`: `ZodOptional`\<`ZodPipe`\<`ZodTransform`\<`null` \| `never`[], `unknown`\>, `ZodOptional`\<`ZodArray`\<`ZodString`\>\>\>\>; `SETTLEMINT_WORKSPACE`: `ZodOptional`\<`ZodOptional`\<`ZodString`\>\>; \}, `$strip`\>
|
|
1939
1740
|
|
|
1940
1741
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:107](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/dot-env.schema.ts#L107)
|
|
1941
1742
|
|
|
@@ -1946,7 +1747,7 @@ Useful for validating incomplete configurations during development or build time
|
|
|
1946
1747
|
|
|
1947
1748
|
#### IdSchema
|
|
1948
1749
|
|
|
1949
|
-
> `const` **IdSchema**: `ZodUnion`\<[`
|
|
1750
|
+
> `const` **IdSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
|
|
1950
1751
|
|
|
1951
1752
|
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/id.schema.ts#L17)
|
|
1952
1753
|
|
|
@@ -1970,7 +1771,7 @@ const isValidObjectId = IdSchema.safeParse("507f1f77bcf86cd799439011").success;
|
|
|
1970
1771
|
|
|
1971
1772
|
#### PersonalAccessTokenSchema
|
|
1972
1773
|
|
|
1973
|
-
> `const` **PersonalAccessTokenSchema**: `ZodString
|
|
1774
|
+
> `const` **PersonalAccessTokenSchema**: `ZodString`
|
|
1974
1775
|
|
|
1975
1776
|
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/access-token.schema.ts#L14)
|
|
1976
1777
|
|
|
@@ -2027,7 +1828,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
|
|
|
2027
1828
|
|
|
2028
1829
|
#### UrlOrPathSchema
|
|
2029
1830
|
|
|
2030
|
-
> `const` **UrlOrPathSchema**: `ZodUnion`\<[`
|
|
1831
|
+
> `const` **UrlOrPathSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
|
|
2031
1832
|
|
|
2032
1833
|
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L54)
|
|
2033
1834
|
|
|
@@ -2051,7 +1852,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
2051
1852
|
|
|
2052
1853
|
#### UrlPathSchema
|
|
2053
1854
|
|
|
2054
|
-
> `const` **UrlPathSchema**: `ZodString
|
|
1855
|
+
> `const` **UrlPathSchema**: `ZodString`
|
|
2055
1856
|
|
|
2056
1857
|
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L34)
|
|
2057
1858
|
|
|
@@ -2075,7 +1876,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
2075
1876
|
|
|
2076
1877
|
#### UrlSchema
|
|
2077
1878
|
|
|
2078
|
-
> `const` **UrlSchema**: `ZodString
|
|
1879
|
+
> `const` **UrlSchema**: `ZodString`
|
|
2079
1880
|
|
|
2080
1881
|
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/utils/src/validation/url.schema.ts#L17)
|
|
2081
1882
|
|
package/dist/environment.cjs
CHANGED
|
@@ -79,14 +79,14 @@ var import_console_table_printer = require("console-table-printer");
|
|
|
79
79
|
var import_yoctocolors7 = require("yoctocolors");
|
|
80
80
|
|
|
81
81
|
// src/validation/validate.ts
|
|
82
|
-
var
|
|
82
|
+
var import_v4 = require("zod/v4");
|
|
83
83
|
function validate(schema, value) {
|
|
84
84
|
try {
|
|
85
85
|
return schema.parse(value);
|
|
86
86
|
} catch (error) {
|
|
87
|
-
if (error instanceof
|
|
88
|
-
const formattedErrors = error.
|
|
89
|
-
throw new Error(`Validation error${error.
|
|
87
|
+
if (error instanceof import_v4.ZodError) {
|
|
88
|
+
const formattedErrors = error.issues.map((err) => `- ${err.path.join(".")}: ${err.message}`).join("\n");
|
|
89
|
+
throw new Error(`Validation error${error.issues.length > 1 ? "s" : ""}:
|
|
90
90
|
${formattedErrors}`);
|
|
91
91
|
}
|
|
92
92
|
throw error;
|
|
@@ -94,10 +94,10 @@ ${formattedErrors}`);
|
|
|
94
94
|
}
|
|
95
95
|
|
|
96
96
|
// src/validation/access-token.schema.ts
|
|
97
|
-
var
|
|
98
|
-
var ApplicationAccessTokenSchema =
|
|
99
|
-
var PersonalAccessTokenSchema =
|
|
100
|
-
var AccessTokenSchema =
|
|
97
|
+
var import_v42 = require("zod/v4");
|
|
98
|
+
var ApplicationAccessTokenSchema = import_v42.z.string().regex(/^sm_aat_.*$/);
|
|
99
|
+
var PersonalAccessTokenSchema = import_v42.z.string().regex(/^sm_pat_.*$/);
|
|
100
|
+
var AccessTokenSchema = import_v42.z.string().regex(/^sm_pat_.*|sm_aat_.*$/);
|
|
101
101
|
|
|
102
102
|
// src/json.ts
|
|
103
103
|
function tryParseJson(value, defaultValue = null) {
|
|
@@ -113,22 +113,22 @@ function tryParseJson(value, defaultValue = null) {
|
|
|
113
113
|
}
|
|
114
114
|
|
|
115
115
|
// src/validation/dot-env.schema.ts
|
|
116
|
-
var
|
|
116
|
+
var import_v45 = require("zod/v4");
|
|
117
117
|
|
|
118
118
|
// src/validation/unique-name.schema.ts
|
|
119
|
-
var
|
|
120
|
-
var UniqueNameSchema =
|
|
119
|
+
var import_v43 = require("zod/v4");
|
|
120
|
+
var UniqueNameSchema = import_v43.z.string().regex(/^[a-z0-9-]+$/);
|
|
121
121
|
|
|
122
122
|
// src/validation/url.schema.ts
|
|
123
|
-
var
|
|
124
|
-
var UrlSchema =
|
|
125
|
-
var UrlPathSchema =
|
|
123
|
+
var import_v44 = require("zod/v4");
|
|
124
|
+
var UrlSchema = import_v44.z.string().url();
|
|
125
|
+
var UrlPathSchema = import_v44.z.string().regex(/^\/(?:[a-zA-Z0-9-_]+(?:\/[a-zA-Z0-9-_]+)*\/?)?$/, {
|
|
126
126
|
message: "Invalid URL path format. Must start with '/' and can contain letters, numbers, hyphens, and underscores."
|
|
127
127
|
});
|
|
128
|
-
var UrlOrPathSchema =
|
|
128
|
+
var UrlOrPathSchema = import_v44.z.union([UrlSchema, UrlPathSchema]);
|
|
129
129
|
|
|
130
130
|
// src/validation/dot-env.schema.ts
|
|
131
|
-
var DotEnvSchema =
|
|
131
|
+
var DotEnvSchema = import_v45.z.object({
|
|
132
132
|
/** Base URL of the SettleMint platform instance */
|
|
133
133
|
SETTLEMINT_INSTANCE: UrlSchema.default("https://console.settlemint.com"),
|
|
134
134
|
/** Application access token for authenticating with SettleMint services */
|
|
@@ -142,7 +142,7 @@ var DotEnvSchema = import_zod5.z.object({
|
|
|
142
142
|
/** Unique name of the blockchain network */
|
|
143
143
|
SETTLEMINT_BLOCKCHAIN_NETWORK: UniqueNameSchema.optional(),
|
|
144
144
|
/** Chain ID of the blockchain network */
|
|
145
|
-
SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID:
|
|
145
|
+
SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID: import_v45.z.string().optional(),
|
|
146
146
|
/** Unique name of the blockchain node (should have a private key for signing transactions) */
|
|
147
147
|
SETTLEMINT_BLOCKCHAIN_NODE: UniqueNameSchema.optional(),
|
|
148
148
|
/** JSON RPC endpoint for the blockchain node */
|
|
@@ -156,18 +156,18 @@ var DotEnvSchema = import_zod5.z.object({
|
|
|
156
156
|
/** Endpoint URL for the Hasura GraphQL API */
|
|
157
157
|
SETTLEMINT_HASURA_ENDPOINT: UrlSchema.optional(),
|
|
158
158
|
/** Admin secret for authenticating with Hasura */
|
|
159
|
-
SETTLEMINT_HASURA_ADMIN_SECRET:
|
|
159
|
+
SETTLEMINT_HASURA_ADMIN_SECRET: import_v45.z.string().optional(),
|
|
160
160
|
/** Database connection URL for Hasura */
|
|
161
|
-
SETTLEMINT_HASURA_DATABASE_URL:
|
|
161
|
+
SETTLEMINT_HASURA_DATABASE_URL: import_v45.z.string().optional(),
|
|
162
162
|
/** Unique name of The Graph instance */
|
|
163
163
|
SETTLEMINT_THEGRAPH: UniqueNameSchema.optional(),
|
|
164
164
|
/** Array of endpoint URLs for The Graph subgraphs */
|
|
165
|
-
SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS:
|
|
165
|
+
SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS: import_v45.z.preprocess(
|
|
166
166
|
(value) => tryParseJson(value, []),
|
|
167
|
-
|
|
167
|
+
import_v45.z.array(UrlSchema).optional()
|
|
168
168
|
),
|
|
169
169
|
/** Default The Graph subgraph to use */
|
|
170
|
-
SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH:
|
|
170
|
+
SETTLEMINT_THEGRAPH_DEFAULT_SUBGRAPH: import_v45.z.string().optional(),
|
|
171
171
|
/** Unique name of the Smart Contract Portal instance */
|
|
172
172
|
SETTLEMINT_PORTAL: UniqueNameSchema.optional(),
|
|
173
173
|
/** GraphQL endpoint URL for the Portal */
|
|
@@ -179,7 +179,7 @@ var DotEnvSchema = import_zod5.z.object({
|
|
|
179
179
|
/** Unique name of the HD private key */
|
|
180
180
|
SETTLEMINT_HD_PRIVATE_KEY: UniqueNameSchema.optional(),
|
|
181
181
|
/** Address of the HD private key forwarder */
|
|
182
|
-
SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS:
|
|
182
|
+
SETTLEMINT_HD_PRIVATE_KEY_FORWARDER_ADDRESS: import_v45.z.string().optional(),
|
|
183
183
|
/** Unique name of the accessible private key */
|
|
184
184
|
SETTLEMINT_ACCESSIBLE_PRIVATE_KEY: UniqueNameSchema.optional(),
|
|
185
185
|
/** Unique name of the MinIO instance */
|
|
@@ -187,9 +187,9 @@ var DotEnvSchema = import_zod5.z.object({
|
|
|
187
187
|
/** Endpoint URL for MinIO */
|
|
188
188
|
SETTLEMINT_MINIO_ENDPOINT: UrlSchema.optional(),
|
|
189
189
|
/** Access key for MinIO authentication */
|
|
190
|
-
SETTLEMINT_MINIO_ACCESS_KEY:
|
|
190
|
+
SETTLEMINT_MINIO_ACCESS_KEY: import_v45.z.string().optional(),
|
|
191
191
|
/** Secret key for MinIO authentication */
|
|
192
|
-
SETTLEMINT_MINIO_SECRET_KEY:
|
|
192
|
+
SETTLEMINT_MINIO_SECRET_KEY: import_v45.z.string().optional(),
|
|
193
193
|
/** Unique name of the IPFS instance */
|
|
194
194
|
SETTLEMINT_IPFS: UniqueNameSchema.optional(),
|
|
195
195
|
/** API endpoint URL for IPFS */
|
|
@@ -209,18 +209,18 @@ var DotEnvSchema = import_zod5.z.object({
|
|
|
209
209
|
/** UI endpoint URL for Blockscout */
|
|
210
210
|
SETTLEMINT_BLOCKSCOUT_UI_ENDPOINT: UrlSchema.optional(),
|
|
211
211
|
/** Name of the new project being created */
|
|
212
|
-
SETTLEMINT_NEW_PROJECT_NAME:
|
|
212
|
+
SETTLEMINT_NEW_PROJECT_NAME: import_v45.z.string().optional(),
|
|
213
213
|
/** The log level to use */
|
|
214
|
-
SETTLEMINT_LOG_LEVEL:
|
|
214
|
+
SETTLEMINT_LOG_LEVEL: import_v45.z.enum(["debug", "info", "warn", "error", "none"]).default("warn")
|
|
215
215
|
});
|
|
216
216
|
var DotEnvSchemaPartial = DotEnvSchema.partial();
|
|
217
217
|
|
|
218
218
|
// src/validation/id.schema.ts
|
|
219
|
-
var
|
|
220
|
-
var IdSchema =
|
|
221
|
-
|
|
219
|
+
var import_v46 = require("zod/v4");
|
|
220
|
+
var IdSchema = import_v46.z.union([
|
|
221
|
+
import_v46.z.string().uuid(),
|
|
222
222
|
// PostgreSQL UUID
|
|
223
|
-
|
|
223
|
+
import_v46.z.string().regex(/^[0-9a-fA-F]{24}$/)
|
|
224
224
|
// MongoDB ObjectID
|
|
225
225
|
]);
|
|
226
226
|
|