Migration to v3.0.0

If you’re currently using @sqds/grid v2.x, this guide will help you migrate to v3.0.0. The new version introduces improved error handling, camelCase field naming, new trading features, and better state management.

Overview of Breaking Changes

v3.0.0 introduces several breaking changes that improve the developer experience:

Error handling: Methods now throw GridError instead of returning {success, error} wrappers
camelCase naming: All response/request fields now use camelCase instead of snake_case
Response structure: All responses have a .data object containing the payload
New features: Account state management, trading smart transactions, and passkey accounts

Migration Steps

Update Package Version

Update your package.json and install v3.0.0:

npm install @sqds/grid@3.0.0

Update Error Handling Pattern

Replace all success checks with try/catch blocks. Methods now throw GridError on failure.Before (v2.x):

const response = await gridClient.createAccount({
  email: "user@example.com",
});

if (response.success) {
  console.log("Account created:", response.data.address);
} else {
  console.error("Error:", response.error);
}

After (v3.0.0):

import { GridClient, GridError } from '@sqds/grid';

try {
  const response = await gridClient.createAccount({
    email: "user@example.com",
  });
  console.log("Account created:", response.data.address);
} catch (error) {
  if (error instanceof GridError) {
    console.error("Error:", error.message);
    console.error("Code:", error.code);
    console.error("Status:", error.statusCode);
    console.error("Request ID:", error.lastResponse?.requestId);
  }
}

The GridError class provides structured error information including code, statusCode, details, and lastResponse for debugging.

Update Field Names to camelCase

All response and request fields now use camelCase instead of snake_case.Before (v2.x):

const auth = await gridClient.initAuth({ email: "user@example.com" });
if (auth.success) {
  console.log("OTP sent:", auth.data.otp_sent);
  console.log("Created:", auth.data.created_at);
  console.log("Expires:", auth.data.expires_at);
}

const account = await gridClient.getAccount(address);
if (account.success) {
  console.log("User ID:", account.data.grid_user_id);
  console.log("Time lock:", account.data.policies?.time_lock);
  console.log("Admin:", account.data.policies?.admin_address);
}

After (v3.0.0):

try {
  const auth = await gridClient.initAuth({ email: "user@example.com" });
  console.log("OTP sent:", auth.data.otpSent);
  console.log("Created:", auth.data.createdAt);
  console.log("Expires:", auth.data.expiresAt);

  const account = await gridClient.getAccount(address);
  console.log("User ID:", account.data.gridUserId);
  console.log("Time lock:", account.data.policies?.timeLock);
  console.log("Admin:", account.data.policies?.adminAddress);
} catch (error) {
  console.error("Failed:", error);
}

Complete field name mapping:

Old (snake_case)	New (camelCase)
`otp_sent`	`otpSent`
`otp_id`	`otpId`
`created_at`	`createdAt`
`expires_at`	`expiresAt`
`grid_user_id`	`gridUserId`
`time_lock`	`timeLock`
`admin_address`	`adminAddress`
`transaction_signers`	`transactionSigners`
`spending_limit_signers`	`spendingLimitSigners`
`transaction_signature`	`transactionSignature`
`confirmed_at`	`confirmedAt`

GridError field change:

// Before
error.status_code

// After
error.statusCode

Update Response Access Pattern

Responses now use BaseResponse<T> which wraps data in a .data property along with request metadata in .lastResponse.Before (v2.x):

const balances = await gridClient.getAccountBalances(address);
if (balances.success) {
  balances.data.tokens.forEach((token) => {
    console.log(`${token.symbol}: ${token.amount}`);
  });
}

After (v3.0.0):

try {
  const balances = await gridClient.getAccountBalances(address);

  balances.data.tokens.forEach((token) => {
    console.log(`${token.symbol}: ${token.amount}`);
  });

  console.log("Request ID:", balances.lastResponse?.requestId);
} catch (error) {
  console.error("Failed to fetch balances:", error);
}

The .data property contains your actual response payload. The .lastResponse property contains request metadata (requestId, statusCode, headers) useful for debugging and support.

Update Transaction Signing Flow

Update authentication data access to use camelCase.Before (v2.x):

const spendingLimit = await gridClient.createSpendingLimit(
  address,
  spendingLimitPayload
);

if (spendingLimit.success) {
  const signature = await gridClient.signAndSend({
    sessionSecrets,
    session: authResult.data.authentication,
    transactionPayload: spendingLimit.data,
    address,
  });
}

After (v3.0.0):

try {
  const spendingLimit = await gridClient.createSpendingLimit(
    address,
    spendingLimitPayload
  );

  const signature = await gridClient.signAndSend({
    sessionSecrets,
    session: authResult.data.authentication,
    transactionPayload: spendingLimit.data,
    address,
  });

  console.log("Transaction completed:", signature.data.transactionSignature);
} catch (error) {
  console.error("Transaction failed:", error);
}

Update Type References

Several response types have been updated. The main change is removing the old GridResponse<T> wrapper.Type updates:

// Old types (v2.x)
GridResponse<GetAccountResponse>
GridResponse<CreateAccountResponse>
GridResponse<AccountBalancesData>

// New types (v3.0.0) - use directly
GetAccountResponse
CreateAccountResponse
AccountBalancesResponse

Update your function signatures:

// Before
const handleAccount = async (): Promise<GridResponse<GetAccountResponse>> => {
  return await gridClient.getAccount(address);
};

// After
const handleAccount = async (): Promise<GetAccountResponse> => {
  return await gridClient.getAccount(address);
};

Verify All Changes

Run TypeScript compilation and your test suite:

npm run type-check
npm test

Common errors to look for:

Property 'success' does not exist - Update to try/catch
Property 'xxx_yyy' does not exist - Update to camelCase
Property 'status_code' does not exist on type 'GridError' - Use statusCode

Migration Checklist

AuthenticationData React Native SDK Quickstart

⌘I

​Overview of Breaking Changes

​Migration Steps

​Migration Checklist

Overview of Breaking Changes

Migration Steps

Migration Checklist