From 32b86f6cd52b9bff382269c3b84321be26a78efb Mon Sep 17 00:00:00 2001 From: Doug Richar Date: Wed, 14 Jan 2026 18:47:09 -0500 Subject: [PATCH 1/2] docs: update gitbook links to haystack-router Update all documentation links to the new Haystack Router Gitbook URL now that the documentation has been migrated. - Update links from deflex-api to haystack-router - Remove "coming soon" note from root README --- README.md | 4 ++-- examples/README.md | 2 +- packages/haystack/README.md | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 91d9b6c..e676956 100644 --- a/README.md +++ b/README.md @@ -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/deflex-api) - smart order routing and DEX aggregation on Algorand. +TypeScript/JavaScript SDK for [Haystack Order Router](https://txnlab.gitbook.io/haystack-router) - 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) @@ -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/deflex-api](https://txnlab.gitbook.io/deflex-api) _(Haystack Router documentation coming soon)_ +- **API Docs**: [https://txnlab.gitbook.io/haystack-router](https://txnlab.gitbook.io/haystack-router) ## Contributing diff --git a/examples/README.md b/examples/README.md index d02361b..d115fa8 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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/deflex-api) +- [Documentation](https://txnlab.gitbook.io/haystack-router) diff --git a/packages/haystack/README.md b/packages/haystack/README.md index d820d45..70852e7 100644 --- a/packages/haystack/README.md +++ b/packages/haystack/README.md @@ -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/deflex-api) - smart order routing and DEX aggregation on Algorand. +TypeScript/JavaScript SDK for [Haystack Order Router](https://txnlab.gitbook.io/haystack-router) - smart order routing and DEX aggregation on Algorand. ## Prerequisites @@ -83,7 +83,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/deflex-api/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-router/referral-treasury/referral-program). ### Get a Swap Quote @@ -381,7 +381,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/deflex-api/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-router/referral-treasury/referral-program). #### RouterClient.newQuote() @@ -485,7 +485,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/deflex-api). +For more information about the Haystack Order Router protocol, visit the [official documentation](https://txnlab.gitbook.io/haystack-router). ## License From 87ae5c80ef9ec2f7feea7673813398bad9281491 Mon Sep 17 00:00:00 2001 From: Doug Richar Date: Wed, 14 Jan 2026 18:49:37 -0500 Subject: [PATCH 2/2] fix(examples): update remaining Deflex references to Haystack Router Update environment variable names and HTML titles in example apps to match the rebranded Haystack Router naming. - Rename DEFLEX_API_KEY to HAYSTACK_ROUTER_API_KEY in .env.example files - Rename VITE_DEFLEX_API_KEY to VITE_HAYSTACK_ROUTER_API_KEY - Update HTML titles from "Deflex SDK" to "Haystack Router SDK" --- examples/node-cli/.env.example | 4 ++-- examples/react-query/.env.example | 2 +- examples/react-query/index.html | 2 +- examples/react/.env.example | 2 +- examples/react/index.html | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/node-cli/.env.example b/examples/node-cli/.env.example index 38eda86..07d4013 100644 --- a/examples/node-cli/.env.example +++ b/examples/node-cli/.env.example @@ -1,5 +1,5 @@ -# Deflex API Configuration -DEFLEX_API_KEY=your-api-key-here +# Haystack Router API Configuration +HAYSTACK_ROUTER_API_KEY=your-api-key-here # Algorand Account Mnemonic (25 words) # WARNING: Never commit this file with your real mnemonic! diff --git a/examples/react-query/.env.example b/examples/react-query/.env.example index 095c301..8d70cba 100644 --- a/examples/react-query/.env.example +++ b/examples/react-query/.env.example @@ -1 +1 @@ -VITE_DEFLEX_API_KEY=your-api-key-here +VITE_HAYSTACK_ROUTER_API_KEY=your-api-key-here diff --git a/examples/react-query/index.html b/examples/react-query/index.html index 4a3476e..a68d9a5 100644 --- a/examples/react-query/index.html +++ b/examples/react-query/index.html @@ -3,7 +3,7 @@ - Deflex SDK - React Query Example + Haystack Router SDK - React Query Example
diff --git a/examples/react/.env.example b/examples/react/.env.example index 095c301..8d70cba 100644 --- a/examples/react/.env.example +++ b/examples/react/.env.example @@ -1 +1 @@ -VITE_DEFLEX_API_KEY=your-api-key-here +VITE_HAYSTACK_ROUTER_API_KEY=your-api-key-here diff --git a/examples/react/index.html b/examples/react/index.html index 23ef062..817f7a3 100644 --- a/examples/react/index.html +++ b/examples/react/index.html @@ -3,7 +3,7 @@ - Deflex SDK - React Example + Haystack Router SDK - React Example