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 @@ -8,7 +8,7 @@ This repository contains the Haystack Router SDK and example implementations for

### [@txnlab/haystack-router](./packages/haystack)

TypeScript/JavaScript SDK for [Haystack Order Router](https://txnlab.gitbook.io/haystack-router) - smart order routing and DEX aggregation on Algorand.
TypeScript/JavaScript SDK for [Haystack Order Router](https://txnlab.gitbook.io/haystack-dev) - smart order routing and DEX aggregation on Algorand.

- **Documentation**: [packages/haystack/README.md](./packages/haystack/README.md)
- **npm**: [@txnlab/haystack-router](https://www.npmjs.com/package/@txnlab/haystack-router)
Expand Down Expand Up @@ -160,7 +160,7 @@ Root-level scripts:

- **SDK Documentation**: [packages/haystack/README.md](./packages/haystack/README.md)
- **Examples Guide**: [examples/README.md](./examples/README.md)
- **API Docs**: [https://txnlab.gitbook.io/haystack-router](https://txnlab.gitbook.io/haystack-router)
- **API Docs**: [https://txnlab.gitbook.io/haystack-dev](https://txnlab.gitbook.io/haystack-dev)

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,4 +124,4 @@ The monorepo structure enables a smooth development workflow:

- [GitHub Issues](https://github.com/TxnLab/haystack-js/issues)
- [Discord](https://discord.gg/Ek3dNyzG)
- [Documentation](https://txnlab.gitbook.io/haystack-router)
- [Documentation](https://txnlab.gitbook.io/haystack-dev)
8 changes: 4 additions & 4 deletions packages/haystack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue.svg)](https://www.typescriptlang.org/)

TypeScript/JavaScript SDK for [Haystack Order Router](https://txnlab.gitbook.io/haystack-router) - smart order routing and DEX aggregation on Algorand.
TypeScript/JavaScript SDK for [Haystack Order Router](https://txnlab.gitbook.io/haystack-dev) - smart order routing and DEX aggregation on Algorand.

## Prerequisites

Expand Down Expand Up @@ -94,7 +94,7 @@ const router = new RouterClient({
})
```

By providing your Algorand address as the `referrerAddress` when initializing the client, you can earn 25% of the swap fees generated through your integration. Set the `feeBps` parameter to specify the total fee charged to users (default: 0.15%, max: 3.00%). Learn more about the [Haystack Router Referral Program](https://txnlab.gitbook.io/haystack-router/referral-treasury/referral-program).
By providing your Algorand address as the `referrerAddress` when initializing the client, you can earn 25% of the swap fees generated through your integration. Set the `feeBps` parameter to specify the total fee charged to users (default: 0.15%, max: 3.00%). Learn more about the [Haystack Router Referral Program](https://txnlab.gitbook.io/haystack-dev/haystack-router/referral-program).

### Get a Swap Quote

Expand Down Expand Up @@ -480,7 +480,7 @@ new RouterClient(config: ConfigParams)
| `autoOptIn` | Auto-detect and add required opt-in transactions | `boolean` | `false` |
| `middleware` | Array of middleware for custom asset requirements | `SwapMiddleware[]` | `[]` |

> **Referral Program**: By providing a `referrerAddress`, you can earn 25% of the swap fees generated through your integration. The `feeBps` parameter sets the total fee charged (default: 0.15%). Learn more about the [Haystack Router Referral Program](https://txnlab.gitbook.io/haystack-router/referral-treasury/referral-program).
> **Referral Program**: By providing a `referrerAddress`, you can earn 25% of the swap fees generated through your integration. The `feeBps` parameter sets the total fee charged (default: 0.15%). Learn more about the [Haystack Router Referral Program](https://txnlab.gitbook.io/haystack-dev/haystack-router/referral-program).

#### RouterClient.newQuote()

Expand Down Expand Up @@ -590,7 +590,7 @@ Builder for constructing and executing atomic swap transaction groups, returned

## Documentation

For more information about the Haystack Order Router protocol, visit the [official documentation](https://txnlab.gitbook.io/haystack-router).
For more information about the Haystack Order Router protocol, visit the [official documentation](https://txnlab.gitbook.io/haystack-dev).

## License

Expand Down
Loading