@bitflowlabs/core-sdk 2.4.0 → 2.4.2

package/README.md

@@ -1,14 +1,16 @@
 # Bitflow SDK
 
-Bitflow SDK is a powerful and easy-to-use library for interacting with the Bitflow Protocol. It provides a set of tools to seamlessly integrate Bitflow functionality into your applications. Currently, the SDK is available by request only. If you are interested in integrating with the BitFlow SDK please reach out to the team on [Discord](https://discord.gg/DY4yNyHyhT).
+Bitflow SDK is a powerful and easy-to-use library for interacting with the Bitflow Protocol. It provides a set of tools to seamlessly integrate Bitflow functionality into your applications.
+
+All Bitflow API endpoints are **publicly accessible without an API key**. Unauthenticated requests are subject to a default rate limit of **500 requests per minute per IP**.
+
+If your integration requires higher limits, see the [Rate Limit Request](#rate-limit-request) section to email **help@bitflow.finance** with a pre-filled form. You can also reach the team on [Discord](https://discord.gg/DY4yNyHyhT).
 
 # Table of Contents
 
-- [Bitflow SDK](#@bitflowlabs/core-sdk)
-- [Table of Contents](#table-of-contents)
 - [Installation](#installation)
-- [Configuration](#configuration)
 - [Usage](#usage)
+  - [Environment Variables](#environment-variables)
 - [Available Functions](#available-functions)
   - [Get Available Tokens](#get-available-tokens)
   - [Get Possible Swaps](#get-possible-swaps)
@@ -19,6 +21,7 @@ Bitflow SDK is a powerful and easy-to-use library for interacting with the Bitfl
   - [Executing Swap (uses `@stacks/connect`)](#executing-swap-uses-stacksconnect)
 - [Types](#types)
 - [Troubleshooting](#troubleshooting)
+- [Rate Limit Request](#rate-limit-request)
 - [License](#license)
 
 # Installation
@@ -29,29 +32,6 @@ Install the Bitflow SDK using npm:
 npm install @bitflowlabs/core-sdk
 ```
 
-**Latest Stable Version is 2.4.0**
-
-# Configuration
-
-Before using the Bitflow SDK, you need to set up your environment variables. Create a `.env` file in your project root with the following variables:
-
-```bash
-# will be provided by Bitflow
-BITFLOW_API_HOST=https://example-api-host.com
-# will be provided by Bitflow
-BITFLOW_API_KEY=<your_api_key_here>
-# your provider address
-BITFLOW_PROVIDER_ADDRESS=<your_provider_address_here>
-# will be provided by Bitflow or can be your own Stacks Node
-READONLY_CALL_API_HOST=https://example-readonly-api.com
-# will be provided by Bitflow or can be your own Stacks Node
-READONLY_CALL_API_KEY=<your_readonly_api_key_here>
-# will be provided by Bitflow
-KEEPER_API_HOST=https://example-keeper-api.com
-# will be provided by Bitflow 
-KEEPER_API_KEY=<your_keeper_api_key_here>
-```
-
 # Usage
 
 Here's a step-by-step guide to implement the Bitflow SDK in your project:
@@ -64,20 +44,48 @@ import { BitflowSDK } from '@bitflowlabs/core-sdk';
 
 2. Initialize the SDK:
 
+If no parameters are provided, the SDK will use the environment variables. See the [Environment Variables](#environment-variables) section for more details.
+
 ```ts
-// if no parameters are provided, the SDK will try to use the environment variables
+// API keys are optional — omit them to use the default public rate limits.
 const bitflow = new BitflowSDK({
-  BITFLOW_API_HOST: string,
-  BITFLOW_API_KEY: string,
+  BITFLOW_API_HOST: 'https://bitflowsdk-api-test-7owjsmt8.uk.gateway.dev',
+  // optional: BITFLOW_API_KEY: string,
   BITFLOW_PROVIDER_ADDRESS: string,
-  READONLY_CALL_API_HOST: string,
-  READONLY_CALL_API_KEY: string,
-  KEEPER_API_HOST: string,
-  KEEPER_API_KEY: string
+  READONLY_CALL_API_HOST: 'https://node.bitflowapis.finance',
+  // optional: READONLY_CALL_API_KEY: string,
+  KEEPER_API_HOST: 'https://bitflow-keeper-test-7owjsmt8.uc.gateway.dev',
+  // optional: KEEPER_API_KEY: string,
 });
 ```
 
-3. Use the SDK methods to interact with the Bitflow Protocol. Here are some common operations:
+3. Use the SDK methods to interact with the Bitflow Protocol. See the [Available Functions](#available-functions) section for more details.
+
+## Environment Variables
+
+If no options are provided when initializing the SDK, it will use the environment variables.
+
+Create a `.env` file in your project root with the following variables:
+
+```bash
+# Bitflow Core API — publicly accessible, no key required
+BITFLOW_API_HOST=https://bitflowsdk-api-test-7owjsmt8.uk.gateway.dev
+# Optional: API key for higher rate limits (see Rate Limit Request section below)
+BITFLOW_API_KEY=<your_api_key_here>
+
+# Your provider address
+BITFLOW_PROVIDER_ADDRESS=<your_provider_address_here>
+
+# Stacks Node — publicly accessible, no key required
+READONLY_CALL_API_HOST=https://node.bitflowapis.finance
+# Optional: API key for higher rate limits
+READONLY_CALL_API_KEY=<your_readonly_api_key_here>
+
+# Keeper API — publicly accessible, no key required
+KEEPER_API_HOST=https://bitflow-keeper-test-7owjsmt8.uc.gateway.dev
+# Optional: API key for higher rate limits
+KEEPER_API_KEY=<your_keeper_api_key_here>
+```
 
 # Available Functions
 
@@ -152,7 +160,7 @@ const swapParams = await bitflow.getSwapParams(
   senderAddress,
   slippageTolerance
 );
-console.log(swapParams);
+console.log(swapParams); // Use this parameters to build your swap transaction
 ```
 
 ## Executing Swap (uses `@stacks/connect`)
@@ -212,6 +220,25 @@ If you encounter any issues while using the Bitflow SDK, please check the follow
 2. Make sure you have the latest version of the SDK installed.
 3. Check that you're using a valid Stacks address for the senderAddress parameter.
 
+# Rate Limit Request
+
+If your integration needs more than **500 requests per minute per IP**, click the link below to open a pre-filled email in your mail client:
+
+**[Request higher rate limits](mailto:help@bitflow.finance?subject=API%20Rate%20Limit%20Increase%20Request%20-%20%5BYour%20Project%20Name%5D&body=Hi%20Bitflow%20team%2C%0D%0A%0D%0AI%27m%20integrating%20the%20Bitflow%20SDK%20and%20would%20like%20to%20request%20an%20API%20key%20with%20increased%20rate%20limits.%0D%0A%0D%0AProject%20%2F%20Application%20name%3A%20%5Be.g.%20MyDeFi%20App%5D%0D%0ABrief%20description%3A%20%5BWhat%20your%20app%20does%20and%20how%20it%20uses%20the%20Bitflow%20API%5D%0D%0AWebsite%20%2F%20repo%20%28if%20public%29%3A%20%5BURL%20or%20N%2FA%5D%0D%0A%0D%0AAPIs%20I%20need%20higher%20limits%20for%20%28delete%20as%20applicable%29%3A%0D%0A-%20Bitflow%20Core%20API%20%28bitflow-sdk-api-gateway-7owjsmt8.uc.gateway.dev%29%0D%0A-%20Keeper%20API%20%28bitflow-keeper-7owjsmt8.uc.gateway.dev%29%0D%0A-%20Stacks%20Node%20%28node.bitflowapis.finance%29%0D%0A%0D%0AExpected%20request%20volume%3A%20%5Be.g.%20~2%2C000%20requests%2Fminute%20during%20peak%20hours%5D%0D%0A%0D%0AUse%20case%3A%20%5Be.g.%20Server-side%20data%20aggregation%2C%20real-time%20price%20feeds%20for%20N%20users%5D%0D%0A%0D%0AContact%20name%3A%20%5BYour%20name%5D%0D%0ADiscord%20handle%20%28optional%29%3A%20%5Be.g.%20%40yourhandle%5D%0D%0A%0D%0AThanks!)**
+
+> If the link doesn't open your mail client, email **help@bitflow.finance** with the subject `API Rate Limit Increase Request` and include the following:
+
+- **Project / Application name** — e.g. MyDeFi App
+- **Brief description** — What your app does and how it uses the Bitflow API
+- **Website / repo (if public)** — URL or N/A
+- **APIs you need higher limits for** — Core API, Keeper API, Stacks Node (or all)
+- **Expected request volume** — e.g. ~2,000 requests/minute during peak hours
+- **Use case** — e.g. Server-side data aggregation, real-time price feeds for N users
+- **Contact name**
+- **Discord handle** (optional)
+
+We aim to respond within 2 business days. For urgent requests, reach out on [Discord](https://discord.gg/DY4yNyHyhT).
+
 # License
 
 This project is licensed under the MIT License - see the LICENSE file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitflowlabs/core-sdk",
-  "version": "2.4.0",
+  "version": "2.4.2",
   "description": "SDK for interacting with Bitflow Protocol",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",