Skip to content

Conversation

@0xhaaz
Copy link

@0xhaaz 0xhaaz commented Jul 7, 2025

Relates to:

#123

Background

This PR improves the onboarding process by adding clear instructions to the README about where users can obtain required API keys and setup values. The updated documentation aims to make getting started easier and more intuitive for new users.

What does this PR do?

  • Updates the Safe wallet example README with clear, concise .env setup instructions.
  • Adds direct links for users to obtain:
    • OpenAI API Key
    • Wallet Private Key (MetaMask or another provider)
    • RPC Provider URL (Alchemy, Infura, QuickNode)
  • Removes redundancy and clarifies the setup steps.

Testing

  • Reviewed the updated README in the GitHub UI to confirm formatting and link correctness.
  • Verified each link points to the intended service.
  • Confirmed that the setup instructions are clear and unambiguous.

This is a documentation-only change; no screenshots or transaction links are needed.

Docs

My changes require a change to the project documentation.
I have updated the documentation accordingly.

Checklist

  • I have tested this change as described above.
  • I updated the README to include the clarified instructions.
  • I have added a changset for the specific package by running pnpm change:add from the typescript directory if a release is required.
<div align="center">
<img src="https://github.com/user-attachments/assets/5fc7f121-259c-492c-8bca-f15fe7eb830c" alt="GOAT" width="100px" height="auto" style="object-fit: contain;">
</div>

# Using Safe wallets
## 🚀 Quickstart

This example demonstrates how to use GOAT with **[Safe wallets](https://safe.global/)**.

You can use this example with any other agent framework, protocols, and chains of your choice.

## Setup

1. Clone the repository:
```bash
git clone https://github.com/goat-sdk/goat.git && cd goat
```

2. Run the following commands from the `typescript` directory:
```bash
cd typescript
pnpm install
pnpm build
```

3. Go to the example directory:
```bash
cd examples/by-wallet/safe
```

4. Copy the `.env.template` and create your own `.env` file:
```bash
cp .env.template .env
```

5. Open the new `.env` file and fill in your values as shown below:

```
OPENAI_API_KEY=your-openai-api-key
WALLET_PRIVATE_KEY=your-wallet-private-key
RPC_PROVIDER_URL=https://your-provider-url
```

**Where to get these values:**
- **OPENAI_API_KEY:** [Get from OpenAI](https://platform.openai.com/signup)
- **WALLET_PRIVATE_KEY:** Export from [MetaMask](https://metamask.io/) or your preferred wallet provider.  
  **Important:** Keep this private and never share it. Store it securely and only use it in safe environments.
- **RPC_PROVIDER_URL:** Get a free Ethereum node endpoint from  
  [Alchemy](https://www.alchemy.com/), [Infura](https://infura.io/), or [QuickNode](https://www.quicknode.com/).  
  Sign up, create a project, and copy your HTTP RPC URL for the desired network (mainnet or testnet).

> **Never share your private keys or API keys publicly. Store them securely.**

## Usage

1. Run the interactive CLI:
```bash
pnpm ts-node index.ts
```

<footer>
<br/>
<br/>
<div>
  <img src="https://github.com/user-attachments/assets/59fa5ddc-9d47-4d41-a51a-64f6798f94bd" alt="GOAT" width="100%" height="auto" style="object-fit: contain; max-width: 800px;">

<div>
</footer>

Added additional basic instructions on were to pull api keys, for ease of use.
@changeset-bot
Copy link

changeset-bot bot commented Jul 7, 2025

⚠️ No Changeset found

Latest commit: f35ef4b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant