diff --git a/plugins/docusaurus-plugin-api-docs/src/index.ts b/plugins/docusaurus-plugin-api-docs/src/index.ts index d930e9229f..b1f8331bc1 100644 --- a/plugins/docusaurus-plugin-api-docs/src/index.ts +++ b/plugins/docusaurus-plugin-api-docs/src/index.ts @@ -355,11 +355,11 @@ export default function apiDocsPlugin( const sortedTypedocItems = sidebarItems[version].sort(sortPackages); const protoSidebarItems = protobufSidebarItems[version] ?? []; const versionSidebarItems: PropSidebarItem[] = [ - { - type: "link", - label: "Overview", - href: normalizeUrl(["/api"]), - }, + // { + // type: "link", + // label: "Overview", + // href: normalizeUrl(["/api"]), + // }, { type: "html", value: '
', @@ -378,54 +378,54 @@ export default function apiDocsPlugin( type: "html", value: '', }, - { - type: "html", - className: "heading_icon__typescript", - value: " Typescript", - }, - { - type: "html", - value: 'Env Variable | -Definition | -
---|---|
CHAIN | -
- Required
- - Type - Enum [aptos / evm / solana / starknet / sui] - - Description - Dictates which chain to listen on for on-chain - events - |
-
ORACLE_KEY | -
- Required
- - Type - String - - Description - The address of the Switchboard oracle - |
-
HEARTBEAT_INTERVAL | -
- Type - Integer
- - Default - 30 - - Description - Seconds between oracle heartbeats. Queues have - different oracle heartbeat requirements. Recommended value is 30 - |
-
RPC_URL | -
- Required
- - Type - String - - Description - The URL of the RPC server to connect to for any - on-chain network requests. - |
-
NETWORK_ID | -
- Type - Enum [mainnet / mainnet-beta / devnet / testnet /
- localnet]
- - Description - The network ID of the $CHAIN to connect to. Not - required for most CHAINS. - |
-
PROGRAM_ID | -
- Type - String
- - Description - The Switchboard program ID for the given $CHAIN and - $NETWORK_ID - |
-
TASK_RUNNER_SOLANA_RPC | -
- Required, if $CHAIN is not solana and $NETWORK_ID is not
- mainnet-beta
- - Type - String - - Description - Solana mainnet RPC URL used for fulfilling task - types that require data on Solana. - |
-
VERBOSE | -
- Type - Boolean
- - Default - disabled - - Description - Enable additional logging. - |
-
DEBUG | -
- Type - Boolean
- - Default - disabled - - Description - Enable additional debug logging. - |
-
Env Variable | -Definition | -
---|---|
FS_PAYER_SECRET_PATH | -
- Type - Filesystem Path
- - Default - /home/node/sbv2-oracle/payer_secrets.json - - Description - Local filesystem path to keypair file that will pay - for on-chain transactions and is the authority for the oracle - |
-
PAYER_SECRETS or DOCKER_PAYER_SECRET | -
- Type - Docker Secret
- - Description - Docker Secret path to keypair file that will pay - for on-chain transactions and is the authority for the oracle - |
-
GOOGLE_PAYER_SECRET_PATH | -
- Type - GCP Resource Path
- - Description - Google cloud resource to manage your keypair - securely. - |
-
AMAZON_PAYER_SECRET_PATH | -
- Type - AWS ARN path
- - Description - Amazon web services ARN path of secret. - |
-
Env Variable | -Definition | -
---|---|
PAGERDUTY_EVENT_KEY | -
- Type - String
- - Description - PagerDuty event key to send alerts. Paging disabled - if not provided. - |
-
HEALTH_CHECK_PORT | -
- Type - Integer
- - Default - 8080 - - Description - The network port to serve healthcheck requests. The - docker healthcheck will ping /healthz periodically to determine a - containers health status. - |
-
METRICS_EXPORTER | -
- Type - Enum [prometheus / opentelemetry-collector]
- - Default - prometheus - - Description - The OpenTelemetry metrics provider. - |
-
METRICS_EXPORTER_PORT | -
- Type - Integer
- - Default - 9090 - - Description - The network port to collect metrics. - |
-
Env Variable | -Definition | -
---|---|
CLUSTER | -
-
- Required
-
- - Type - String (devnet / mainnet-beta) - - Description - Solana cluster you will be running an oracle on - (mainnet-beta/devnet) - |
-
RPC_URL | -
-
- Required
-
- - Type - URL - - Description - Solana RPC URL that must be capable of supporting - websockets. The default RPC pools should be avoided at all cost as you - will quickly hit the rate limits and risk being slashed - |
-
WS_URL | -
-
- Optional
-
- - Type - URL - - Default - RPC_URL - - Description - Websocket URL to connect to a Solana RPC server. If - not provided, oracle will fallback to RPC_URL - |
-
BACKUP_MAINNET_RPC | -
-
- Optional
-
- - Type - URL - - Default - https://api.mainnet-beta.solana.com - - Description - Backup RPC URL in case of network congestion - |
-
ORACLE_KEY | -
-
- Required
-
- - Type - Public Key - - Description - Public key of the oracle account that has been - granted permissions to use an oracle queue - |
-
HEARTBEAT_INTERVAL | -
-
- Optional
-
- - Type - Number (seconds) - - Default - 15 - - Description - Seconds between oracle heartbeats. Queues have - different oracle heartbeat requirements. Recommended value is 15 - |
-
SERVICE_ACCOUNT_BASE64 | -
-
- Required
-
- - Type - Base64 encoded JSON file - - Description - Base64 encoded JSON file containing the private key - for your service account that has access to your google secret keypair - and config bucket - |
-
GOOGLE_PAYER_SECRET_PATH | -
-
- Required
-
- - Type - GCP Resource Path - - Description - Google cloud resource to manage your keypair - securely. - |
-
GCP_CONFIG_BUCKET | -
-
- Optional
-
- - Type - GCP Resource Path - - Default - oracle-configs:configs.json - - Description - Contains API keys for private API endpoints - |
-
EXTERNAL_IP | -
-
- Required
-
- - Type - IPv4 Address - - Description - IP Address where your grafana instance will be - hosted to view metrics and oracle operating status - |
-
GRAFANA_HOSTNAME | -
-
- Required
-
- - Type - Fully Qualified Domain Name - - Description - Hostname where your grafana instance will point to - |
-
GRAFANA_ADMIN_PASSWORD | -
-
- Optional
-
- - Type - String / Password - - Default - Sbv2K8sPassword123@ - - Description - Password to admin account that allows access to - your grafana instance. You can set this to whatever value you want. - - |
-
GRAFANA_TLS_CRT | -
-
- Required
-
- - Type - Base64 encoded CRT file - - Description - Base64 encoded string of your TLS certificate to - secure your grafana instance - |
-
GRAFANA_TLS_KEY | -
-
- Required
-
- - Type - Base64 encoded private key file - - Description - Base64 encoded string of the private key used to - create your TLS certificate - |
-