overlay-market

# Overlay Market

Trade leveraged perpetual futures on 30+ markets (crypto, commodities, indices, social metrics) on BSC.

Overlay markets are synthetic — you trade against a protocol-managed price feed, not an order book. Positions are opened with USDT collateral.

## Transaction signing

This skill produces **unsigned transaction objects** (JSON with `to`, `data`, `value`, `chainId`). Your agent needs a way to sign and broadcast on BSC (chainId 56). A bundled `send.js` script is provided for simple private-key signing, but any signer works.

The recommended setup is a smart contract account with restricted permissions (e.g. Safe + Zodiac Roles), so the agent can only call approved functions. A raw private key in `.env` is provided as a quick-start option for testing.

## Configuration

The `.env` file in the skill root is loaded automatically by all scripts:

```
OVERLAY_PRIVATE_KEY=0xabc...   # optional, needed for send.js and dry-run
BSC_RPC_URL=https://...        # optional, defaults to bsc-dataseed.binance.org
```

`OVERLAY_PRIVATE_KEY` is only required for `send.js` and `--dry-run` simulation. If your agent already has a way to sign and broadcast transactions, you can skip `send.js` entirely and use the unsigned tx JSON output from `build.js`/`unwind.js` directly. Use `--owner <address>` with `unwind.js` instead of relying on the private key.

## External Services

The scripts contact these external endpoints:

- **Overlay APIs** (`api.overlay.market`):
  - `/data/api/markets` — market catalog
  - `/bsc-charts/v1/charts` — OHLC candle data
  - `/bsc-charts/v1/charts/marketsPricesOverview` — current prices & changes
- **Goldsky Subgraph** (`api.goldsky.com`): GraphQL endpoint for position data
- **1inch Proxy** (`1inch-proxy.overlay-market-account.workers.dev`): Cloudflare Workers proxy for OVL→USDT swap quotes (used by `unwind.js`)
- **BSC RPC** (`bsc-dataseed.binance.org` or custom via `BSC_RPC_URL`): on-chain reads and transaction broadcast

## Scripts

###...

# agent-skill

Agent skill for trading on Overlay Protocol.

See [SKILL.md](SKILL.md) for setup, usage, and API reference.