diff --git a/docs/HyperIndex/Guides/environment-variables.md b/docs/HyperIndex/Guides/environment-variables.md index 1109d08c..39d62207 100644 --- a/docs/HyperIndex/Guides/environment-variables.md +++ b/docs/HyperIndex/Guides/environment-variables.md @@ -17,11 +17,21 @@ All environment variables used by Envio must be prefixed with `ENVIO_`. This nam - Makes it clear which variables are used by the Envio indexer - Ensures consistency across different environments +## Envio API Token (required for HyperSync) + +To ensure continued access to HyperSync, set an Envio API token in your environment. + +- Use `ENVIO_API_TOKEN` to provide your token at runtime +- See the API Tokens guide for how to generate a token: [API Tokens](/docs/HyperSync/api-tokens) + ## Example Environment Variables Here are some commonly used environment variables: ```bash +# Envio API Token (required for continued HyperSync access) +ENVIO_API_TOKEN=your-secret-token + # Blockchain RPC URL ENVIO_RPC_URL=https://arbitrum.direct.dev/your-api-key @@ -42,6 +52,7 @@ For local development, you can set environment variables in several ways: ```bash # .env +ENVIO_API_TOKEN=your-secret-token ENVIO_RPC_URL=https://arbitrum.direct.dev/your-api-key ENVIO_START_BLOCK=12345678 ``` @@ -49,6 +60,7 @@ ENVIO_START_BLOCK=12345678 2. Directly in your terminal: ```bash +export ENVIO_API_TOKEN=your-secret-token export ENVIO_RPC_URL=https://arbitrum.direct.dev/your-api-key ``` diff --git a/docs/HyperIndex/Hosted_Service/self-hosting.md b/docs/HyperIndex/Hosted_Service/self-hosting.md index 7dc02635..45031704 100644 --- a/docs/HyperIndex/Hosted_Service/self-hosting.md +++ b/docs/HyperIndex/Hosted_Service/self-hosting.md @@ -32,6 +32,7 @@ Before self-hosting, ensure you have: - Sufficient storage for blockchain data and the indexer database - Adequate CPU and memory resources (requirements vary based on chains and indexing complexity) - Required HyperSync and/or RPC endpoints +- Envio API token for HyperSync access (`ENVIO_API_TOKEN`) — required for continued access. See [API Tokens](/docs/HyperSync/api-tokens). ## Getting Started @@ -51,6 +52,7 @@ The compose file in that repository sets up three main services: The configuration uses environment variables with sensible defaults. For production, you should customize: +- Envio API token (`ENVIO_API_TOKEN`) - Database credentials (`ENVIO_PG_PASSWORD`, `ENVIO_PG_USER`, etc.) - Hasura admin secret (`HASURA_GRAPHQL_ADMIN_SECRET`) - Resource limits based on your workload requirements diff --git a/docs/HyperIndex/supported-networks/hyperliquid.md b/docs/HyperIndex/supported-networks/hyperliquid.md index 23af0f40..b8a88999 100644 --- a/docs/HyperIndex/supported-networks/hyperliquid.md +++ b/docs/HyperIndex/supported-networks/hyperliquid.md @@ -11,9 +11,9 @@ slug: /hyperliquid | **Field** | **Value** | |-------------------------------|----------------------------------------------------------------------------------------------------| -| **Hyperliquid Chain ID** | 645749 | -| **HyperSync URL Endpoint** | [https://hyperliquid.hypersync.xyz](https://hyperliquid.hypersync.xyz) or [https://645749.hypersync.xyz](https://645749.hypersync.xyz) | -| **HyperRPC URL Endpoint** | [https://hyperliquid.rpc.hypersync.xyz](https://hyperliquid.rpc.hypersync.xyz) or [https://645749.rpc.hypersync.xyz](https://645749.rpc.hypersync.xyz) | +| **Hyperliquid Chain ID** | 999 | +| **HyperSync URL Endpoint** | [https://hyperliquid.hypersync.xyz](https://hyperliquid.hypersync.xyz) or [https://999.hypersync.xyz](https://999.hypersync.xyz) | +| **HyperRPC URL Endpoint** | [https://hyperliquid.rpc.hypersync.xyz](https://hyperliquid.rpc.hypersync.xyz) or [https://999.rpc.hypersync.xyz](https://999.rpc.hypersync.xyz) | --- @@ -39,7 +39,7 @@ To get started, see our documentation or follow our quickstart [guide](/docs/Hyp name: IndexerName # Specify indexer name description: Indexer Description # Include indexer description networks: - - id: 645749 # Hyperliquid + - id: 999 # Hyperliquid start_block: START_BLOCK_NUMBER # Specify the starting block contracts: - name: ContractName diff --git a/supported-networks.json b/supported-networks.json index 2922923d..ed02e475 100644 --- a/supported-networks.json +++ b/supported-networks.json @@ -2,4 +2,4 @@ "supported-networks/any-evm-with-rpc", "supported-networks/local-anvil", "supported-networks/local-hardhat", - "supported-networks/0g-newton-testnet","supported-networks/abstract","supported-networks/aleph-zero-evm","supported-networks/altlayer-op-demo-testnet","supported-networks/ancient8","supported-networks/arbitrum","supported-networks/arbitrum-blueberry","supported-networks/arbitrum-nova","supported-networks/arbitrum-sepolia","supported-networks/artela-testnet","supported-networks/arthera-mainnet","supported-networks/asset-chain-mainnet","supported-networks/astar-zkevm","supported-networks/astar-zkyoto","supported-networks/aurora","supported-networks/aurora-turbo","supported-networks/avalanche","supported-networks/b2-hub-testnet","supported-networks/b3","supported-networks/b3-sepolia-testnet","supported-networks/base","supported-networks/base-sepolia","supported-networks/beam","supported-networks/berachain","supported-networks/berachain-artio-testnet","supported-networks/berachain-bartio","supported-networks/bevm-mainnet","supported-networks/bevm-testnet","supported-networks/bitfinity-mainnet","supported-networks/bitfinity-testnet","supported-networks/bitgert-mainnet","supported-networks/bitlayer","supported-networks/blast","supported-networks/blast-sepolia","supported-networks/bob-mainnet","supported-networks/boba","supported-networks/boba-bnb-mainnet","supported-networks/botanix-testnet","supported-networks/bsc","supported-networks/bsc-testnet","supported-networks/canto","supported-networks/canto-testnet","supported-networks/celo","supported-networks/celo-alfajores-testnet","supported-networks/chainweb-testnet-20","supported-networks/chainweb-testnet-21","supported-networks/chiliz","supported-networks/chiliz-testnet-spicy","supported-networks/citrea-devnet","supported-networks/citrea-testnet","supported-networks/core","supported-networks/creator-testnet","supported-networks/cronos-zkevm","supported-networks/cronos-zkevm-testnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet","supported-networks/curtis","supported-networks/cyber","supported-networks/degen-chain","supported-networks/dfk-chain","supported-networks/dogechain-mainnet","supported-networks/dogechain-testnet","supported-networks/dos-chain","supported-networks/energy-web","supported-networks/eos","supported-networks/eth","supported-networks/etherlink-testnet","supported-networks/exosama","supported-networks/fantom","supported-networks/fantom-testnet","supported-networks/flare","supported-networks/flare-songbird","supported-networks/flow","supported-networks/flow-testnet","supported-networks/fraxtal","supported-networks/fuel-mainnet","supported-networks/fuel-testnet","supported-networks/fuji","supported-networks/galadriel-devnet","supported-networks/gnosis","supported-networks/gnosis-chiado","supported-networks/gravity-alpha-mainnet","supported-networks/harmony-shard-0","supported-networks/heco-chain","supported-networks/holesky","supported-networks/hyperliquid","supported-networks/immutable-zkevm","supported-networks/immutable-zkevm-testnet","supported-networks/ink","supported-networks/iotex-network","supported-networks/japan-open-chain","supported-networks/kaia","supported-networks/kakarot-starknet-sepolia","supported-networks/kroma","supported-networks/layeredge-testnet","supported-networks/lightlink-pegasus-testnet","supported-networks/lightlink-phoenix","supported-networks/linea","supported-networks/lisk","supported-networks/lukso","supported-networks/lukso-testnet","supported-networks/manta","supported-networks/manta-pacific-sepolia","supported-networks/mantle","supported-networks/megaeth-testnet","supported-networks/merlin","supported-networks/metall2","supported-networks/meter-mainnet","supported-networks/meter-testnet","supported-networks/mev-commit","supported-networks/mint-mainnet","supported-networks/mode","supported-networks/monad-testnet","supported-networks/moonbase-alpha","supported-networks/moonbeam","supported-networks/morph","supported-networks/nautilus","supported-networks/neo-x-testnet","supported-networks/nibiru-testnet","supported-networks/now-chaint","supported-networks/oasis-emerald","supported-networks/oasis-sapphire","supported-networks/onigiri-subnet","supported-networks/onigiri-test-subnet","supported-networks/ontology-mainnet","supported-networks/ontology-testnet","supported-networks/op-celestia-raspberry","supported-networks/opbnb","supported-networks/optimism","supported-networks/optimism-sepolia","supported-networks/optopia","supported-networks/peaq","supported-networks/plume","supported-networks/polygon","supported-networks/polygon-amoy","supported-networks/polygon-zkevm","supported-networks/polygon-zkevm-cardona-testnet","supported-networks/public-goods-network","supported-networks/pulsechain","supported-networks/puppynet-shibarium","supported-networks/ronin","supported-networks/rootstock","supported-networks/saakuru","supported-networks/satoshivm","supported-networks/scroll","supported-networks/scroll-sepolia","supported-networks/sepolia","supported-networks/shibarium","supported-networks/shimmer-evm","supported-networks/skale-europa","supported-networks/soneium","supported-networks/sonic","supported-networks/sophon","supported-networks/sophon-testnet","supported-networks/stratovm-testnet","supported-networks/superseed","supported-networks/superseed-sepolia-testnet","supported-networks/swell","supported-networks/taiko","supported-networks/tangle","supported-networks/tanssi-demo","supported-networks/taraxa","supported-networks/telos-evm-mainnet","supported-networks/telos-evm-testnet","supported-networks/torus-mainnet","supported-networks/torus-testnet","supported-networks/unichain","supported-networks/unichain-sepolia","supported-networks/unicorn-ultra-nebulas-testnet","supported-networks/velas-mainnet","supported-networks/viction","supported-networks/worldchain","supported-networks/x-layer-mainnet","supported-networks/x-layer-testnet","supported-networks/xdc","supported-networks/xdc-testnet","supported-networks/zeta","supported-networks/zeta-testnet","supported-networks/zircuit","supported-networks/zklink-nova-mainnet","supported-networks/zksync","supported-networks/zksync-sepolia-testnet","supported-networks/zora","supported-networks/zora-sepolia"]} \ No newline at end of file + "supported-networks/0g-newton-testnet","supported-networks/aleph-zero-evm","supported-networks/altlayer-op-demo-testnet","supported-networks/ancient8","supported-networks/arbitrum","supported-networks/arbitrum-blueberry","supported-networks/arbitrum-sepolia","supported-networks/artela-testnet","supported-networks/arthera-mainnet","supported-networks/asset-chain-mainnet","supported-networks/astar-zkevm","supported-networks/astar-zkyoto","supported-networks/aurora-turbo","supported-networks/avalanche","supported-networks/b2-hub-testnet","supported-networks/b3","supported-networks/b3-sepolia-testnet","supported-networks/base","supported-networks/base-sepolia","supported-networks/beam","supported-networks/berachain","supported-networks/berachain-artio-testnet","supported-networks/berachain-bartio","supported-networks/bevm-mainnet","supported-networks/bevm-testnet","supported-networks/bitfinity-mainnet","supported-networks/bitfinity-testnet","supported-networks/bitgert-mainnet","supported-networks/bitlayer","supported-networks/blast","supported-networks/blast-sepolia","supported-networks/bob-mainnet","supported-networks/boba","supported-networks/boba-bnb-mainnet","supported-networks/botanix-testnet","supported-networks/bsc","supported-networks/bsc-testnet","supported-networks/canto","supported-networks/canto-testnet","supported-networks/celo-alfajores-testnet","supported-networks/chiliz","supported-networks/chiliz-testnet-spicy","supported-networks/citrea-devnet","supported-networks/core","supported-networks/creator-testnet","supported-networks/cronos-zkevm","supported-networks/cronos-zkevm-testnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet","supported-networks/cyber","supported-networks/degen-chain","supported-networks/dfk-chain","supported-networks/dogechain-mainnet","supported-networks/dogechain-testnet","supported-networks/dos-chain","supported-networks/energy-web","supported-networks/eos","supported-networks/eth","supported-networks/etherlink-testnet","supported-networks/exosama","supported-networks/fantom","supported-networks/fantom-testnet","supported-networks/flare-songbird","supported-networks/flow","supported-networks/flow-testnet","supported-networks/fuel-mainnet","supported-networks/fuel-testnet","supported-networks/fuji","supported-networks/gnosis","supported-networks/gnosis-chiado","supported-networks/gravity-alpha-mainnet","supported-networks/harmony-shard-0","supported-networks/heco-chain","supported-networks/holesky","supported-networks/hyperliquid","supported-networks/immutable-zkevm","supported-networks/immutable-zkevm-testnet","supported-networks/iotex-network","supported-networks/japan-open-chain","supported-networks/kaia","supported-networks/kakarot-starknet-sepolia","supported-networks/layeredge-testnet","supported-networks/lightlink-pegasus-testnet","supported-networks/lightlink-phoenix","supported-networks/linea","supported-networks/lisk","supported-networks/lukso","supported-networks/lukso-testnet","supported-networks/manta-pacific-sepolia","supported-networks/megaeth-testnet","supported-networks/meter-mainnet","supported-networks/meter-testnet","supported-networks/mint-mainnet","supported-networks/monad-testnet","supported-networks/moonbeam","supported-networks/morph","supported-networks/nautilus","supported-networks/neo-x-testnet","supported-networks/nibiru-testnet","supported-networks/now-chaint","supported-networks/oasis-emerald","supported-networks/oasis-sapphire","supported-networks/onigiri-subnet","supported-networks/onigiri-test-subnet","supported-networks/ontology-mainnet","supported-networks/ontology-testnet","supported-networks/op-celestia-raspberry","supported-networks/optimism","supported-networks/optimism-sepolia","supported-networks/optopia","supported-networks/peaq","supported-networks/plume","supported-networks/polygon","supported-networks/polygon-amoy","supported-networks/polygon-zkevm","supported-networks/polygon-zkevm-cardona-testnet","supported-networks/public-goods-network","supported-networks/pulsechain","supported-networks/puppynet-shibarium","supported-networks/ronin","supported-networks/saakuru","supported-networks/satoshivm","supported-networks/scroll","supported-networks/scroll-sepolia","supported-networks/sepolia","supported-networks/shibarium","supported-networks/skale-europa","supported-networks/sonic","supported-networks/sophon","supported-networks/sophon-testnet","supported-networks/stratovm-testnet","supported-networks/superseed-sepolia-testnet","supported-networks/taiko","supported-networks/tanssi-demo","supported-networks/telos-evm-mainnet","supported-networks/telos-evm-testnet","supported-networks/torus-mainnet","supported-networks/torus-testnet","supported-networks/unichain","supported-networks/unichain-sepolia","supported-networks/unicorn-ultra-nebulas-testnet","supported-networks/velas-mainnet","supported-networks/viction","supported-networks/worldchain","supported-networks/x-layer-mainnet","supported-networks/x-layer-testnet","supported-networks/xdc","supported-networks/xdc-testnet","supported-networks/zeta-testnet","supported-networks/zklink-nova-mainnet","supported-networks/zksync","supported-networks/zksync-sepolia-testnet","supported-networks/zora","supported-networks/zora-sepolia"]} \ No newline at end of file