Skip to content

Use gRPC client in ts sdk docs and examples (BFP-4993) #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NidaKarim merged 1 commit into from
Aug 31, 2026
Merged

Use gRPC client in ts sdk docs and examples (BFP-4993) #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions ts/sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import {
BluefinRequestSigner,
makeSigner,
} from "@bluefin-exchange/pro-sdk";
import { SuiJsonRpcClient } from "@mysten/sui/jsonRpc";
import { SuiGrpcClient } from "@mysten/sui/grpc";
import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
import { hexToBytes } from "@noble/hashes/utils.js";

Expand All @@ -51,13 +51,17 @@ const signer = new BluefinRequestSigner(makeSigner(wallet, false));
const client = new BluefinProSdk(
signer,
"mainnet", // or "testnet" for staging, "devnet" for development
new SuiJsonRpcClient({ url: "https://fullnode.mainnet.sui.io:443", network: "mainnet" })
new SuiGrpcClient({ network: "mainnet", baseUrl: "https://fullnode.mainnet.sui.io:443" })
);

// Initialize the SDK (authenticates and loads exchange configuration)
await client.initialize();
```

> The SDK accepts any `@mysten/sui` client implementing the Core API. Use
> `SuiGrpcClient` — Sui's JSON-RPC interface is deprecated. If you are upgrading from
> `SuiJsonRpcClient`, swapping the client is the only change required.

### 2. Get Market Data

```typescript
Expand Down
8 changes: 4 additions & 4 deletions ts/sdk/docs/batch-claim-rewards-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {
makeSigner,
BatchClaimParams
} from "@bluefin-exchange/pro-sdk";
import { SuiJsonRpcClient } from "@mysten/sui/jsonRpc";
import { SuiGrpcClient } from "@mysten/sui/grpc";
import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
Comment on lines +24 to 25

// Create wallet from private key or mnemonic
Expand All @@ -34,7 +34,7 @@ const signer = new BluefinRequestSigner(makeSigner(wallet, false));
const sdk = new BluefinProSdk(
signer,
"mainnet", // or "testnet" for staging
new SuiJsonRpcClient({ url: "https://fullnode.mainnet.sui.io:443", network: "mainnet" })
new SuiGrpcClient({ network: "mainnet", baseUrl: "https://fullnode.mainnet.sui.io:443" })
);

await sdk.initialize();
Expand Down Expand Up @@ -130,7 +130,7 @@ import {
makeSigner,
BatchClaimParams
} from "@bluefin-exchange/pro-sdk";
import { SuiJsonRpcClient } from "@mysten/sui/jsonRpc";
import { SuiGrpcClient } from "@mysten/sui/grpc";
import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
import { hexToBytes } from "@noble/hashes/utils.js";

Expand All @@ -141,7 +141,7 @@ async function claimRewards() {
const sdk = new BluefinProSdk(
signer,
"mainnet",
new SuiJsonRpcClient({ url: "https://fullnode.mainnet.sui.io:443", network: "mainnet" })
new SuiGrpcClient({ network: "mainnet", baseUrl: "https://fullnode.mainnet.sui.io:443" })
);
await sdk.initialize();

Expand Down
6 changes: 3 additions & 3 deletions ts/sdk/example.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import {
} from "./index.js";

import { hexToBytes } from "@noble/hashes/utils.js";
import { SuiJsonRpcClient } from "@mysten/sui/jsonRpc";
import { SuiGrpcClient } from "@mysten/sui/grpc";
import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";

// Configure logging
Expand Down Expand Up @@ -114,7 +114,7 @@ async function main() {
const client = new BluefinProSdk(
bfSigner,
"testnet",
new SuiJsonRpcClient({ url: "https://fullnode.testnet.sui.io:443", network: "testnet" })
new SuiGrpcClient({ network: "testnet", baseUrl: "https://fullnode.testnet.sui.io:443" })
);
await client.initialize();

Expand All @@ -123,7 +123,7 @@ async function main() {
// const clientWithTimeOffset = new BluefinProSdk(
// bfSigner,
// "testnet",
// new SuiJsonRpcClient({ url: "https://fullnode.testnet.sui.io:443", network: "testnet" }),
// new SuiGrpcClient({ network: "testnet", baseUrl: "https://fullnode.testnet.sui.io:443" }),
// { currentTimeMs: customTime }
// );
// await clientWithTimeOffset.initialize();
Expand Down
14 changes: 7 additions & 7 deletions ts/sdk/src/request-signer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import {
} from '@mysten/sui/cryptography';
import type {
DryRunTransactionBlockResponse,
SuiClient,
SuiTransactionBlockResponse,
} from '@firefly-exchange/library-sui';
import type { ClientWithCoreApi } from '@mysten/sui/client';
import type { Transaction as TransactionBlock } from '@mysten/sui/transactions';
import {
LoginRequest,
Expand Down Expand Up @@ -47,17 +47,17 @@ export interface IBluefinSigner extends ISigner {
signLoginRequest: (request: LoginRequest) => Promise<string>;
signTx: (
txb: TransactionBlock,
suiClient: SuiClient,
suiClient: ClientWithCoreApi,
) => Promise<SignatureWithBytes>;
executeSponsoredTx: (
txBytes: string,
userSignature: string,
sponsorSignature: string,
suiClient: SuiClient,
suiClient: ClientWithCoreApi,
) => Promise<DryRunTransactionBlockResponse | SuiTransactionBlockResponse>;
executeTx: (
txb: TransactionBlock,
suiClient: SuiClient,
suiClient: ClientWithCoreApi,
) => Promise<DryRunTransactionBlockResponse | SuiTransactionBlockResponse>;
}

Expand Down Expand Up @@ -402,7 +402,7 @@ export class BluefinRequestSigner implements IBluefinSigner {
return signedMessageSerialized.signature;
}

async signTx(txb: TransactionBlock, suiClient: SuiClient) {
async signTx(txb: TransactionBlock, suiClient: ClientWithCoreApi) {
const SuiBlocks = await loadSuiBlocks();
return await SuiBlocks.buildAndSignTxBlock(
txb,
Expand All @@ -416,7 +416,7 @@ export class BluefinRequestSigner implements IBluefinSigner {
txBytes: string,
userSignature: string,
sponsorSignature: string,
suiClient: SuiClient,
suiClient: ClientWithCoreApi,
) {
const SuiBlocks = await loadSuiBlocks();
return SuiBlocks.executeSponsoredTxBlock(
Expand All @@ -427,7 +427,7 @@ export class BluefinRequestSigner implements IBluefinSigner {
);
}

async executeTx(txb: TransactionBlock, suiClient: SuiClient) {
async executeTx(txb: TransactionBlock, suiClient: ClientWithCoreApi) {
const SuiBlocks = await loadSuiBlocks();
return SuiBlocks.execCall(
txb,
Expand Down
2 changes: 1 addition & 1 deletion ts/sdk/src/sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -902,7 +902,7 @@ export class BluefinProSdk {
const { RewardsDistributorInteractor } =
await loadRewardsDistributorInteractor();
const interactor = new RewardsDistributorInteractor(
this.suiClient as any,
this.suiClient,
data as any,
signer,
this.bfSigner.isUIWallet(),
Expand Down
Loading