Skip to content

Commit 8d2a42e

Browse files
chore: add cautionary language around private key management (#134)
- Add security warnings about private key handling in wallet verification docs - Also updates Callout component types from "warning" to "warn" for consistency
1 parent 91a6c44 commit 8d2a42e

File tree

5 files changed

+16
-6
lines changed

5 files changed

+16
-6
lines changed

docs/competitions/build-agent/trading.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The trading simulator enables agent developers to:
2828
- Portfolio management across chains
2929
- [Competition leaderboards](/competitions) with real-time rankings
3030

31-
<Callout type="warning">
31+
<Callout type="warn">
3232
Make sure you've [registered your agent](/competitions/register-agent/register) and have an API
3333
key before you start trading.
3434
</Callout>
@@ -536,7 +536,7 @@ RECALL_API_KEY=pk_live_xxx
536536
OPENAI_API_KEY=sk_live_xxx # optional; omit if you don't want AI tuning
537537
```
538538

539-
<Callout type="warning">
539+
<Callout type="warn">
540540
Treat your API keys like passwords. **Never** commit them to GitHub or share them in chat.
541541
</Callout>
542542

@@ -828,7 +828,7 @@ if __name__ == "__main__":
828828
</Tab>
829829
</Tabs>
830830

831-
<Callout type="warning">
831+
<Callout type="warn">
832832
**Time zones**
833833

834834
`schedule.every().day.at("09:00")` runs at server-local time. If your bot is on a VPS, confirm its

docs/competitions/build-agent/your-first-trade.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Once verified, you can enter any live competition.
3838
Create your [profile](/competitions/register-agent/create-profile) and
3939
[register](/competitions/register-agent/create-agent) your trading agent to get your API key.
4040

41-
<Callout type="warning">
41+
<Callout type="warn">
4242
Treat this key like a password. **Never** commit it to GitHub or share it in chat.
4343
</Callout>
4444

docs/competitions/register-agent/create-agent.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Click "Submit" to create your agent.
9797
}'
9898
```
9999

100-
<Callout type="warning" title="API key security">
100+
<Callout type="warn" title="API key security">
101101

102102
Keep your API key secure and never expose it publicly. This key authenticates all your agent's
103103
trading actions.

docs/competitions/register-agent/verify-agent-wallet.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ Before you begin, make sure you have:
3535
1. [Node.js](https://nodejs.org/) 18.0.0+ (for JavaScript) or [Foundry's](https://getfoundry.sh/)
3636
`cast` tool and [jq](https://jqlang.org/) (for Bash)
3737

38+
<Callout type="warn" title="Private key security">
39+
Never share or expose your private key publicly. The verification process uses your private key
40+
locally to sign a message—the key itself never leaves your machine and is not sent to any server.
41+
</Callout>
42+
3843
## JavaScript example
3944

4045
<Steps>
@@ -73,6 +78,11 @@ RECALL_API_KEY=your_production_api_key
7378
WALLET_PRIVATE_KEY=0x1234567890123456789012345678901234567890123456789012345678901234
7479
```
7580

81+
<Callout type="warn">
82+
Ensure your `.env` file is listed in `.gitignore` to prevent accidentally committing sensitive
83+
credentials to version control.
84+
</Callout>
85+
7686
</Step>
7787
<Step>
7888

docs/reference/endpoints/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ focused on:
1111
- Fetching token prices and executing (paper) trades
1212
- Getting agent leaderboard rankings or per-competition results
1313

14-
<Callout type="warning">
14+
<Callout type="warn">
1515

1616
All API requests must include the `Authorization: Bearer <your-api-key>` header with your API key.
1717

0 commit comments

Comments
 (0)