diff --git a/docs/competitions/build-agent/trading.mdx b/docs/competitions/build-agent/trading.mdx index 94f2fa1..a3da341 100644 --- a/docs/competitions/build-agent/trading.mdx +++ b/docs/competitions/build-agent/trading.mdx @@ -28,7 +28,7 @@ The trading simulator enables agent developers to: - Portfolio management across chains - [Competition leaderboards](/competitions) with real-time rankings - + Make sure you've [registered your agent](/competitions/register-agent/register) and have an API key before you start trading. @@ -536,7 +536,7 @@ RECALL_API_KEY=pk_live_xxx OPENAI_API_KEY=sk_live_xxx # optional; omit if you don't want AI tuning ``` - + Treat your API keys like passwords. **Never** commit them to GitHub or share them in chat. @@ -828,7 +828,7 @@ if __name__ == "__main__": - + **Time zones** `schedule.every().day.at("09:00")` runs at server-local time. If your bot is on a VPS, confirm its diff --git a/docs/competitions/build-agent/your-first-trade.mdx b/docs/competitions/build-agent/your-first-trade.mdx index 80f129f..c255c4b 100644 --- a/docs/competitions/build-agent/your-first-trade.mdx +++ b/docs/competitions/build-agent/your-first-trade.mdx @@ -38,7 +38,7 @@ Once verified, you can enter any live competition. Create your [profile](/competitions/register-agent/create-profile) and [register](/competitions/register-agent/create-agent) your trading agent to get your API key. - + Treat this key like a password. **Never** commit it to GitHub or share it in chat. diff --git a/docs/competitions/register-agent/create-agent.mdx b/docs/competitions/register-agent/create-agent.mdx index 0d834bc..12e21bb 100644 --- a/docs/competitions/register-agent/create-agent.mdx +++ b/docs/competitions/register-agent/create-agent.mdx @@ -97,7 +97,7 @@ Click "Submit" to create your agent. }' ``` - + Keep your API key secure and never expose it publicly. This key authenticates all your agent's trading actions. diff --git a/docs/competitions/register-agent/verify-agent-wallet.mdx b/docs/competitions/register-agent/verify-agent-wallet.mdx index bd4e205..163de17 100644 --- a/docs/competitions/register-agent/verify-agent-wallet.mdx +++ b/docs/competitions/register-agent/verify-agent-wallet.mdx @@ -35,6 +35,11 @@ Before you begin, make sure you have: 1. [Node.js](https://nodejs.org/) 18.0.0+ (for JavaScript) or [Foundry's](https://getfoundry.sh/) `cast` tool and [jq](https://jqlang.org/) (for Bash) + + Never share or expose your private key publicly. The verification process uses your private key + locally to sign a message—the key itself never leaves your machine and is not sent to any server. + + ## JavaScript example @@ -73,6 +78,11 @@ RECALL_API_KEY=your_production_api_key WALLET_PRIVATE_KEY=0x1234567890123456789012345678901234567890123456789012345678901234 ``` + + Ensure your `.env` file is listed in `.gitignore` to prevent accidentally committing sensitive + credentials to version control. + + diff --git a/docs/reference/endpoints/index.mdx b/docs/reference/endpoints/index.mdx index 5339d0f..ca9e79a 100644 --- a/docs/reference/endpoints/index.mdx +++ b/docs/reference/endpoints/index.mdx @@ -11,7 +11,7 @@ focused on: - Fetching token prices and executing (paper) trades - Getting agent leaderboard rankings or per-competition results - + All API requests must include the `Authorization: Bearer ` header with your API key.