@settlemint/sdk-utils 2.4.0-pre98cfd17 → 2.4.0-prec526eee
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 +12 -211
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -79,16 +79,10 @@
|
|
|
79
79
|
- [LoggerOptions](#loggeroptions)
|
|
80
80
|
- [SpinnerOptions\<R\>](#spinneroptionsr)
|
|
81
81
|
- [Type Aliases](#type-aliases)
|
|
82
|
-
- [AccessToken](#accesstoken)
|
|
83
|
-
- [ApplicationAccessToken](#applicationaccesstoken)
|
|
84
82
|
- [DotEnv](#dotenv)
|
|
85
83
|
- [DotEnvPartial](#dotenvpartial)
|
|
86
84
|
- [Id](#id)
|
|
87
85
|
- [LogLevel](#loglevel)
|
|
88
|
-
- [PersonalAccessToken](#personalaccesstoken)
|
|
89
|
-
- [Url](#url)
|
|
90
|
-
- [UrlOrPath](#urlorpath)
|
|
91
|
-
- [UrlPath](#urlpath)
|
|
92
86
|
- [Variables](#variables)
|
|
93
87
|
- [AccessTokenSchema](#accesstokenschema)
|
|
94
88
|
- [ApplicationAccessTokenSchema](#applicationaccesstokenschema)
|
|
@@ -1700,139 +1694,29 @@ Options for configuring the spinner behavior
|
|
|
1700
1694
|
|
|
1701
1695
|
### Type Aliases
|
|
1702
1696
|
|
|
1703
|
-
#### AccessToken
|
|
1704
|
-
|
|
1705
|
-
> **AccessToken** = `string`
|
|
1706
|
-
|
|
1707
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:22](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/access-token.schema.ts#L22)
|
|
1708
|
-
|
|
1709
|
-
Schema for validating both application and personal access tokens.
|
|
1710
|
-
Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
1711
|
-
|
|
1712
|
-
***
|
|
1713
|
-
|
|
1714
|
-
#### ApplicationAccessToken
|
|
1715
|
-
|
|
1716
|
-
> **ApplicationAccessToken** = `string`
|
|
1717
|
-
|
|
1718
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:8](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/access-token.schema.ts#L8)
|
|
1719
|
-
|
|
1720
|
-
Schema for validating application access tokens.
|
|
1721
|
-
Application access tokens start with 'sm_aat_' prefix.
|
|
1722
|
-
|
|
1723
|
-
***
|
|
1724
|
-
|
|
1725
1697
|
#### DotEnv
|
|
1726
1698
|
|
|
1727
|
-
> **DotEnv** = `
|
|
1699
|
+
> **DotEnv** = `z.infer`\<*typeof* [`DotEnvSchema`](#dotenvschema)\>
|
|
1728
1700
|
|
|
1729
1701
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:112](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/dot-env.schema.ts#L112)
|
|
1730
1702
|
|
|
1731
1703
|
Type definition for the environment variables schema.
|
|
1732
1704
|
|
|
1733
|
-
##### Type declaration
|
|
1734
|
-
|
|
1735
|
-
| Name | Type | Description | Defined in |
|
|
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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/sdk/utils/src/validation/dot-env.schema.ts#L31) |
|
|
1776
|
-
|
|
1777
1705
|
***
|
|
1778
1706
|
|
|
1779
1707
|
#### DotEnvPartial
|
|
1780
1708
|
|
|
1781
|
-
> **DotEnvPartial** = `
|
|
1709
|
+
> **DotEnvPartial** = `z.infer`\<*typeof* [`DotEnvSchemaPartial`](#dotenvschemapartial)\>
|
|
1782
1710
|
|
|
1783
1711
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:123](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/dot-env.schema.ts#L123)
|
|
1784
1712
|
|
|
1785
1713
|
Type definition for the partial environment variables schema.
|
|
1786
1714
|
|
|
1787
|
-
##### Type declaration
|
|
1788
|
-
|
|
1789
|
-
| Name | Type | Description | Defined in |
|
|
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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/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.4.0/sdk/utils/src/validation/dot-env.schema.ts#L31) |
|
|
1830
|
-
|
|
1831
1715
|
***
|
|
1832
1716
|
|
|
1833
1717
|
#### Id
|
|
1834
1718
|
|
|
1835
|
-
> **Id** = `
|
|
1719
|
+
> **Id** = `z.infer`\<*typeof* [`IdSchema`](#idschema)\>
|
|
1836
1720
|
|
|
1837
1721
|
Defined in: [sdk/utils/src/validation/id.schema.ts:30](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/id.schema.ts#L30)
|
|
1838
1722
|
|
|
@@ -1849,94 +1733,11 @@ Defined in: [sdk/utils/src/logging/logger.ts:6](https://github.com/settlemint/sd
|
|
|
1849
1733
|
|
|
1850
1734
|
Log levels supported by the logger
|
|
1851
1735
|
|
|
1852
|
-
***
|
|
1853
|
-
|
|
1854
|
-
#### PersonalAccessToken
|
|
1855
|
-
|
|
1856
|
-
> **PersonalAccessToken** = `string`
|
|
1857
|
-
|
|
1858
|
-
Defined in: [sdk/utils/src/validation/access-token.schema.ts:15](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/access-token.schema.ts#L15)
|
|
1859
|
-
|
|
1860
|
-
Schema for validating personal access tokens.
|
|
1861
|
-
Personal access tokens start with 'sm_pat_' prefix.
|
|
1862
|
-
|
|
1863
|
-
***
|
|
1864
|
-
|
|
1865
|
-
#### Url
|
|
1866
|
-
|
|
1867
|
-
> **Url** = `string`
|
|
1868
|
-
|
|
1869
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:18](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/url.schema.ts#L18)
|
|
1870
|
-
|
|
1871
|
-
Schema for validating URLs.
|
|
1872
|
-
|
|
1873
|
-
##### Example
|
|
1874
|
-
|
|
1875
|
-
```ts
|
|
1876
|
-
import { UrlSchema } from "@settlemint/sdk-utils/validation";
|
|
1877
|
-
|
|
1878
|
-
// Validate a URL
|
|
1879
|
-
const isValidUrl = UrlSchema.safeParse("https://console.settlemint.com").success;
|
|
1880
|
-
// true
|
|
1881
|
-
|
|
1882
|
-
// Invalid URLs will fail validation
|
|
1883
|
-
const isInvalidUrl = UrlSchema.safeParse("not-a-url").success;
|
|
1884
|
-
// false
|
|
1885
|
-
```
|
|
1886
|
-
|
|
1887
|
-
***
|
|
1888
|
-
|
|
1889
|
-
#### UrlOrPath
|
|
1890
|
-
|
|
1891
|
-
> **UrlOrPath** = `string`
|
|
1892
|
-
|
|
1893
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:55](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/url.schema.ts#L55)
|
|
1894
|
-
|
|
1895
|
-
Schema that accepts either a full URL or a URL path.
|
|
1896
|
-
|
|
1897
|
-
##### Example
|
|
1898
|
-
|
|
1899
|
-
```ts
|
|
1900
|
-
import { UrlOrPathSchema } from "@settlemint/sdk-utils/validation";
|
|
1901
|
-
|
|
1902
|
-
// Validate a URL
|
|
1903
|
-
const isValidUrl = UrlOrPathSchema.safeParse("https://console.settlemint.com").success;
|
|
1904
|
-
// true
|
|
1905
|
-
|
|
1906
|
-
// Validate a path
|
|
1907
|
-
const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
1908
|
-
// true
|
|
1909
|
-
```
|
|
1910
|
-
|
|
1911
|
-
***
|
|
1912
|
-
|
|
1913
|
-
#### UrlPath
|
|
1914
|
-
|
|
1915
|
-
> **UrlPath** = `string`
|
|
1916
|
-
|
|
1917
|
-
Defined in: [sdk/utils/src/validation/url.schema.ts:38](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/url.schema.ts#L38)
|
|
1918
|
-
|
|
1919
|
-
Schema for validating URL paths.
|
|
1920
|
-
|
|
1921
|
-
##### Example
|
|
1922
|
-
|
|
1923
|
-
```ts
|
|
1924
|
-
import { UrlPathSchema } from "@settlemint/sdk-utils/validation";
|
|
1925
|
-
|
|
1926
|
-
// Validate a URL path
|
|
1927
|
-
const isValidPath = UrlPathSchema.safeParse("/api/v1/users").success;
|
|
1928
|
-
// true
|
|
1929
|
-
|
|
1930
|
-
// Invalid paths will fail validation
|
|
1931
|
-
const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
1932
|
-
// false
|
|
1933
|
-
```
|
|
1934
|
-
|
|
1935
1736
|
### Variables
|
|
1936
1737
|
|
|
1937
1738
|
#### AccessTokenSchema
|
|
1938
1739
|
|
|
1939
|
-
> `const` **AccessTokenSchema**: `ZodString
|
|
1740
|
+
> `const` **AccessTokenSchema**: `ZodString`
|
|
1940
1741
|
|
|
1941
1742
|
Defined in: [sdk/utils/src/validation/access-token.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/access-token.schema.ts#L21)
|
|
1942
1743
|
|
|
@@ -1947,7 +1748,7 @@ Accepts tokens starting with either 'sm_pat_' or 'sm_aat_' prefix.
|
|
|
1947
1748
|
|
|
1948
1749
|
#### ApplicationAccessTokenSchema
|
|
1949
1750
|
|
|
1950
|
-
> `const` **ApplicationAccessTokenSchema**: `ZodString
|
|
1751
|
+
> `const` **ApplicationAccessTokenSchema**: `ZodString`
|
|
1951
1752
|
|
|
1952
1753
|
Defined in: [sdk/utils/src/validation/access-token.schema.ts:7](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/access-token.schema.ts#L7)
|
|
1953
1754
|
|
|
@@ -1958,7 +1759,7 @@ Application access tokens start with 'sm_aat_' prefix.
|
|
|
1958
1759
|
|
|
1959
1760
|
#### DotEnvSchema
|
|
1960
1761
|
|
|
1961
|
-
> `const` **DotEnvSchema**: `ZodObject`\<[`
|
|
1762
|
+
> `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`\<`ZodUnion`\<readonly \[`ZodString`, `ZodLiteral`\<`"standalone"`\>, `ZodLiteral`\<`"local"`\>\]\>\>; `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`\>
|
|
1962
1763
|
|
|
1963
1764
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:21](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/dot-env.schema.ts#L21)
|
|
1964
1765
|
|
|
@@ -1970,7 +1771,7 @@ access tokens, workspace names, and service endpoints.
|
|
|
1970
1771
|
|
|
1971
1772
|
#### DotEnvSchemaPartial
|
|
1972
1773
|
|
|
1973
|
-
> `const` **DotEnvSchemaPartial**: `ZodObject`\<[`
|
|
1774
|
+
> `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`\<`ZodUnion`\<readonly \[`ZodString`, `ZodLiteral`\<`"standalone"`\>, `ZodLiteral`\<`"local"`\>\]\>\>\>; `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`\>
|
|
1974
1775
|
|
|
1975
1776
|
Defined in: [sdk/utils/src/validation/dot-env.schema.ts:118](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/dot-env.schema.ts#L118)
|
|
1976
1777
|
|
|
@@ -1981,7 +1782,7 @@ Useful for validating incomplete configurations during development or build time
|
|
|
1981
1782
|
|
|
1982
1783
|
#### IdSchema
|
|
1983
1784
|
|
|
1984
|
-
> `const` **IdSchema**: `ZodUnion`\<[`
|
|
1785
|
+
> `const` **IdSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
|
|
1985
1786
|
|
|
1986
1787
|
Defined in: [sdk/utils/src/validation/id.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/id.schema.ts#L17)
|
|
1987
1788
|
|
|
@@ -2015,7 +1816,7 @@ Use this value to indicate that the resources are not part of the SettleMint pla
|
|
|
2015
1816
|
|
|
2016
1817
|
#### PersonalAccessTokenSchema
|
|
2017
1818
|
|
|
2018
|
-
> `const` **PersonalAccessTokenSchema**: `ZodString
|
|
1819
|
+
> `const` **PersonalAccessTokenSchema**: `ZodString`
|
|
2019
1820
|
|
|
2020
1821
|
Defined in: [sdk/utils/src/validation/access-token.schema.ts:14](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/access-token.schema.ts#L14)
|
|
2021
1822
|
|
|
@@ -2082,7 +1883,7 @@ const isInvalidName = UniqueNameSchema.safeParse("My Workspace!").success;
|
|
|
2082
1883
|
|
|
2083
1884
|
#### UrlOrPathSchema
|
|
2084
1885
|
|
|
2085
|
-
> `const` **UrlOrPathSchema**: `ZodUnion`\<[`
|
|
1886
|
+
> `const` **UrlOrPathSchema**: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>
|
|
2086
1887
|
|
|
2087
1888
|
Defined in: [sdk/utils/src/validation/url.schema.ts:54](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/url.schema.ts#L54)
|
|
2088
1889
|
|
|
@@ -2106,7 +1907,7 @@ const isValidPath = UrlOrPathSchema.safeParse("/api/v1/users").success;
|
|
|
2106
1907
|
|
|
2107
1908
|
#### UrlPathSchema
|
|
2108
1909
|
|
|
2109
|
-
> `const` **UrlPathSchema**: `ZodString
|
|
1910
|
+
> `const` **UrlPathSchema**: `ZodString`
|
|
2110
1911
|
|
|
2111
1912
|
Defined in: [sdk/utils/src/validation/url.schema.ts:34](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/url.schema.ts#L34)
|
|
2112
1913
|
|
|
@@ -2130,7 +1931,7 @@ const isInvalidPath = UrlPathSchema.safeParse("not-a-path").success;
|
|
|
2130
1931
|
|
|
2131
1932
|
#### UrlSchema
|
|
2132
1933
|
|
|
2133
|
-
> `const` **UrlSchema**: `ZodString
|
|
1934
|
+
> `const` **UrlSchema**: `ZodString`
|
|
2134
1935
|
|
|
2135
1936
|
Defined in: [sdk/utils/src/validation/url.schema.ts:17](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/utils/src/validation/url.schema.ts#L17)
|
|
2136
1937
|
|
package/package.json
CHANGED