Skip to content

docs(examples): clarify facilitator signer roles #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Bortlesboat wants to merge 1 commit into from
Closed

docs(examples): clarify facilitator signer roles #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/go/facilitator/basic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ EVM_PRIVATE_KEY=<your-evm-private-key>
SVM_PRIVATE_KEY=<your-svm-private-key>
```

**⚠️ Security Note:** The facilitator private key needs ETH/SOL for gas fees. Use a dedicated testnet account.
**⚠️ Security Note:** The facilitator private key needs ETH/SOL for gas fees. Use a dedicated facilitator account for settlement, and keep it separate from your seller `payTo` wallet and buyer test wallets.

2. Install dependencies and run:

Expand Down
10 changes: 6 additions & 4 deletions examples/python/facilitator/basic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ FastAPI-based facilitator service that verifies and settles payments on-chain fo

- Python 3.10+ (install via [pyenv](https://github.com/pyenv/pyenv) or [uv](https://docs.astral.sh/uv/))
- uv package manager (install via [uv installation](https://docs.astral.sh/uv/getting-started/installation/))
- EVM private key with Base Sepolia ETH for transaction fees
- SVM private key with Solana Devnet SOL for transaction fees
- Dedicated EVM facilitator private key with Base Sepolia ETH for transaction fees
- Dedicated SVM facilitator private key with Solana Devnet SOL for transaction fees

## Setup

Expand All @@ -19,11 +19,13 @@ cp .env-local .env

and fill required environment variables:

- `EVM_PRIVATE_KEY` - Ethereum private key (hex with 0x prefix)
- `SVM_PRIVATE_KEY` - Solana private key (base58 encoded)
- `EVM_PRIVATE_KEY` - Ethereum facilitator private key (hex with 0x prefix)
- `SVM_PRIVATE_KEY` - Solana facilitator private key (base58 encoded)
- `PORT` - Server port (optional, defaults to 4022)
- `EVM_RPC_URL` - Custom EVM RPC URL (optional, defaults to Base Sepolia)

**⚠️ Security Note:** The facilitator key is the signer used to settle payments on-chain. Keep it separate from your seller `payTo` wallet and buyer test wallets, and make sure it is funded only for facilitator gas/fees.

2. Install dependencies:

```bash
Expand Down
10 changes: 6 additions & 4 deletions examples/typescript/facilitator/basic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Express.js facilitator service that verifies and settles payments on-chain for t

- Node.js v20+ (install via [nvm](https://github.com/nvm-sh/nvm))
- pnpm v10 (install via [pnpm.io/installation](https://pnpm.io/installation))
- EVM private key with Base Sepolia ETH for transaction fees
- SVM private key with Solana Devnet SOL for transaction fees
- Dedicated EVM facilitator private key with Base Sepolia ETH for transaction fees
- Dedicated SVM facilitator private key with Solana Devnet SOL for transaction fees

## Setup

Expand All @@ -19,10 +19,12 @@ cp .env-local .env

and fill required environment variables:

- `EVM_PRIVATE_KEY` - Ethereum private key
- `SVM_PRIVATE_KEY` - Solana private key
- `EVM_PRIVATE_KEY` - Ethereum facilitator private key
- `SVM_PRIVATE_KEY` - Solana facilitator private key
- `PORT` - Server port (optional, defaults to 4022)

**⚠️ Security Note:** The facilitator key is the signer used to settle payments on-chain. Keep it separate from your seller `payTo` wallet and buyer test wallets, and make sure it is funded only for facilitator gas/fees.

2. Install and build all packages from the typescript examples root:

```bash
Expand Down
Loading