Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This is a pnpm workspace monorepo. All packages and examples share dependencies

### Prerequisites

- **Haystack Router API Key** - An API key is included for free tier usage (60 requests/min). For production rate limits, request a key: see [Getting a key](https://txnlab.gitbook.io/haystack-dev/getting-started/api-keys#getting-a-key) for what to send us. Don't use the router for prices: use the [Haystack API](https://txnlab.gitbook.io/haystack-dev/haystack-api/assets#prices).
- **Haystack Router API Key** - An API key is included for free tier usage (30 requests/min per IP). For production rate limits, request a key: see [Getting a key](https://txnlab.gitbook.io/haystack-dev/getting-started/api-keys#getting-a-key) for what to send us. Don't use the router for prices: use the [Haystack API](https://txnlab.gitbook.io/haystack-dev/haystack-api/assets#prices).
- algosdk 3.0.0 or later (peer dependency)
- Node.js `^22.22.2 || >=24.15`
- pnpm 10.20.0 or later
Expand Down Expand Up @@ -106,7 +106,7 @@ const { activeAddress, transactionSigner } = useWallet()

// Initialize client
const router = new RouterClient({
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
})

// Get quote
Expand Down
18 changes: 9 additions & 9 deletions packages/haystack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ TypeScript/JavaScript SDK for [Haystack Order Router](https://txnlab.gitbook.io/

## Prerequisites

- **Haystack Router API Key** - A free tier key is included below for development and testing (60 requests/min). For production rate limits, request a dedicated key: see [Getting a key](https://txnlab.gitbook.io/haystack-dev/getting-started/api-keys#getting-a-key) for what to send us.
- **Haystack Router API Key** - A free tier key is included below for development and testing (30 requests/min per IP). For production rate limits, request a dedicated key: see [Getting a key](https://txnlab.gitbook.io/haystack-dev/getting-started/api-keys#getting-a-key) for what to send us.
- algosdk 3.0.0 or later

> [!CAUTION]
Expand All @@ -20,7 +20,7 @@ TypeScript/JavaScript SDK for [Haystack Order Router](https://txnlab.gitbook.io/

| Tier | Key | Rate Limit | Use Case |
| --- | --- | --- | --- |
| **Free** | `hay_pk_4zhj33wahuxfplteyif5xpcgnm` | 60 requests/min | Development, testing, low-volume integrations |
| **Free** | `hay_pk_4zhj33wahuxfplteyif5xpcgnm` | 30 requests/min per IP | Development, testing, low-volume integrations |
| **Production** | Email [support@txnlab.dev](mailto:support@txnlab.dev) with the details in [Getting a key](https://txnlab.gitbook.io/haystack-dev/getting-started/api-keys#getting-a-key) | Higher limits | Production applications |

The previous free key, `1b72df7e-1131-4449-8ce1-29b79dd3f51e`, is deprecated: its limit falls to 10 requests/min between December 1, 2026 and March 1, 2027, and it stops working on April 1, 2027.
Expand All @@ -45,7 +45,7 @@ const { activeAddress, transactionSigner } = useWallet()

// Initialize the client
const router = new RouterClient({
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
})

// Get a quote
Expand Down Expand Up @@ -77,12 +77,12 @@ import { RouterClient } from '@txnlab/haystack-router'

// Basic initialization
const router = new RouterClient({
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
})

// Custom Algod configuration
const router = new RouterClient({
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
algodUri: 'https://mainnet-api.4160.nodely.dev/',
algodToken: '',
algodPort: 443,
Expand All @@ -91,7 +91,7 @@ const router = new RouterClient({

// Earn fees with the referral program
const router = new RouterClient({
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
referrerAddress: 'YOUR_ALGORAND_ADDRESS', // Earns 25% of swap fees
feeBps: 15, // 0.15% fee (max: 300 = 3%)
})
Expand Down Expand Up @@ -367,7 +367,7 @@ const myAsset = new MyAssetMiddleware({

// Pass middleware to RouterClient
const router = new RouterClient({
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
middleware: [myAsset], // Middleware is applied automatically
})

Expand Down Expand Up @@ -395,7 +395,7 @@ const autoOptOut = new AutoOptOutMiddleware({
})

const router = new RouterClient({
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
middleware: [autoOptOut],
})

Expand All @@ -416,7 +416,7 @@ If you're not using `autoOptIn: true`, you can manually check if opt-in is neede

```typescript
const router = new RouterClient({
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
autoOptIn: false, // Default if not provided
})

Expand Down
4 changes: 2 additions & 2 deletions packages/haystack/src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ import type {
* @example
* ```typescript
* const router = new RouterClient({
* apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
* apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
* })
* ```
*
* @example
* ```typescript
* const router = new RouterClient({
* apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
* apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
* apiBaseUrl: 'https://hayrouter.txnlab.dev',
* algodUri: 'https://mainnet-api.4160.nodely.dev/',
* algodToken: '',
Expand Down
2 changes: 1 addition & 1 deletion packages/haystack/src/middleware.ts
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ export interface AutoOptOutConfig {
* })
*
* const router = new RouterClient({
* apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (60 requests/min)
* apiKey: 'hay_pk_4zhj33wahuxfplteyif5xpcgnm', // Free tier (30 requests/min)
* middleware: [autoOptOut],
* })
*
Expand Down
Loading