diff --git a/.env.sample b/.env.sample new file mode 100644 index 0000000..58fbba4 --- /dev/null +++ b/.env.sample @@ -0,0 +1,29 @@ +# Aptos Python SDK environment variables +# +# This repository does not load `.env` files automatically. +# Export these values in your shell, or use your preferred dotenv tooling. + +# Optional API key for Aptos endpoints that require authenticated access. +API_KEY= + +# Optional faucet bearer token. This is required for some non-devnet faucet setups. +FAUCET_AUTH_TOKEN= + +# Path to the Aptos CLI binary. Leave as `aptos` if it is already on your PATH. +APTOS_CLI_PATH=aptos + +# Path to a local aptos-core checkout used by the integration examples. +APTOS_CORE_PATH=C:/path/to/aptos-core + +# Faucet endpoint used by the examples and localnet integration tests. +APTOS_FAUCET_URL=https://faucet.devnet.aptoslabs.com + +# Optional indexer endpoint used by examples that query GraphQL data. +APTOS_INDEXER_URL=https://api.devnet.aptoslabs.com/v1/graphql + +# Aptos fullnode REST endpoint used by the async client examples. +APTOS_NODE_URL=https://api.devnet.aptoslabs.com/v1 + +# Set to `true` to make integration tests reuse an already-running local network. +# Leave unset or empty to let the test harness start its own local testnet. +APTOS_TEST_USE_EXISTING_NETWORK=