Skip to content

Update ts/sdk README with comprehensive documentation and fix example bug#253

Merged
shahzaib-sheikh merged 5 commits intomainfrom
copilot/update-readme-file-ts-sdk
Feb 12, 2026
Merged

Update ts/sdk README with comprehensive documentation and fix example bug#253
shahzaib-sheikh merged 5 commits intomainfrom
copilot/update-readme-file-ts-sdk

Conversation

Copy link
Contributor

Copilot AI commented Feb 12, 2026

The TypeScript SDK README contained incorrect package names, missing usage examples, and lacked documentation for key SDK features.

Changes

README.md (ts/sdk)

  • Fixed package name: @bluefin/api-client@bluefin-exchange/pro-sdk
  • Added quick start with SDK initialization and authentication
  • Added examples for:
    • Market data retrieval (tickers, orderbooks, trades)
    • Order placement with complete parameter documentation
    • Account information queries
    • WebSocket streams (market and account data)
    • Advanced features (deposits, withdrawals, leverage management, rewards)
  • Documented environment configuration (mainnet/testnet/devnet)
  • Added build and development instructions

example.ts

  • Fixed method call: suiWallet.toSuiAddress()suiWallet.getPublicKey().toSuiAddress()

Example Usage

import { BluefinProSdk, BluefinRequestSigner, makeSigner } from "@bluefin-exchange/pro-sdk";
import { SuiClient, Ed25519Keypair } from "@firefly-exchange/library-sui";

const wallet = Ed25519Keypair.fromSecretKey(hexToBytes("YOUR_KEY"));
const signer = new BluefinRequestSigner(makeSigner(wallet, false));
const client = new BluefinProSdk(
  signer,
  "mainnet",
  new SuiClient({ url: "https://fullnode.mainnet.sui.io:443" })
);

await client.initialize();

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 3 commits February 12, 2026 14:32
Co-authored-by: shahzaib-sheikh <13495703+shahzaib-sheikh@users.noreply.github.com>
Co-authored-by: shahzaib-sheikh <13495703+shahzaib-sheikh@users.noreply.github.com>
Co-authored-by: shahzaib-sheikh <13495703+shahzaib-sheikh@users.noreply.github.com>
Copilot AI changed the title [WIP] Update outdated readme file in ts/sdk folder Update ts/sdk README with comprehensive documentation and fix example bug Feb 12, 2026
@shahzaib-sheikh shahzaib-sheikh marked this pull request as ready for review February 12, 2026 14:39
@shahzaib-sheikh shahzaib-sheikh merged commit f1e4305 into main Feb 12, 2026
6 checks passed
@shahzaib-sheikh shahzaib-sheikh deleted the copilot/update-readme-file-ts-sdk branch February 12, 2026 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants