Skip to main content

Installation

Learn how to install and set up the BRDZ SDK in your project.

Prerequisites​

Before installing the BRDZ SDK, ensure you have:

  • Node.js version 18.0 or higher
  • npm version 8.0 or higher (or yarn 1.22+)
  • A modern JavaScript/TypeScript development environment

Install BRDZ SDK​

Using npm​

npm install anantla_sdk@latest

Using yarn​

yarn add anantla_sdk@latest

Using pnpm​

pnpm add anantla_sdk@latest

Verify Installation​

Create a simple test file to verify the SDK is installed correctly:

// test-sdk.js
const brdzSDK = require('anantla_sdk');

// Test SDK import
console.log('SDK modules:', Object.keys(brdzSDK));
console.log('Installation successful!');

Run the test:

node test-sdk.js

Expected output:

SDK modules: [
  'config', 'admin', 'auth', 'twofa', 'bridge', 'cardano',
  'client', 'ekyc', 'fx', 'mcp', 'ntcp', 'plaid', 'stableX',
  'testnet', 'transactions', 'utils', 'visa', 'wallet', 'xrpl',
  'apikey', 'crosschain', 'neon', 'cryptoWallet', 'onchain',
  'twitter', 'privy', 'users'
]
Installation successful!

Import Methods​

ES6/ESM Imports​

import brdzSDK from 'anantla_sdk';

// Access modules
const config = await brdzSDK.config;
const auth = await brdzSDK.auth;
const cryptoWallet = await brdzSDK.cryptoWallet;

CommonJS Require​

const brdzSDK = require('anantla_sdk');

// Access modules
const config = brdzSDK.config;
const auth = brdzSDK.auth;
const mcp = brdzSDK.mcp;

TypeScript Support​

The SDK includes TypeScript definitions:

import brdzSDK from 'anantla_sdk';

// TypeScript will provide full intellisense
const auth = await brdzSDK.auth;
const result: any = await auth.loginUser('email', 'password');

Framework Integration​

React/Next.js​

// utils/brdz-sdk.js
import brdzSDK from 'anantla_sdk';

export const initializeSDK = async () => {
  const config = await brdzSDK.config;
  config.setBaseUrl(process.env.REACT_APP_BRDZ_API_BASE);
  config.setApiKey(process.env.REACT_APP_BRDZ_API_KEY);
  
  return brdzSDK;
};

// React component
import { useEffect, useState } from 'react';
import { initializeSDK } from '../utils/brdz-sdk';

export default function MyComponent() {
  const [sdk, setSdk] = useState(null);
  
  useEffect(() => {
    initializeSDK().then(setSdk);
  }, []);
  
  if (!sdk) return <div>Loading SDK...</div>;
  
  return <div>SDK ready!</div>;
}

Vue.js​

// plugins/brdz-sdk.js
import brdzSDK from 'anantla_sdk';

export default {
  install: async (app) => {
    const config = await brdzSDK.config;
    config.setBaseUrl(process.env.VUE_APP_BRDZ_API_BASE);
    config.setApiKey(process.env.VUE_APP_BRDZ_API_KEY);
    
    app.config.globalProperties.$brdzSDK = brdzSDK;
  }
};

Node.js/Express​

// server.js
const brdzSDK = require('anantla_sdk');

// Initialize SDK
const initSDK = async () => {
  brdzSDK.config.setBaseUrl(process.env.BRDZ_API_BASE);
  brdzSDK.config.setApiKey(process.env.BRDZ_API_KEY);
  
  console.log('BRDZ SDK initialized for server');
};

initSDK();

// Use in routes
app.post('/login', async (req, res) => {
  const { email, password } = req.body;
  
  try {
    const result = await brdzSDK.auth.loginUser(email, password);
    res.json(result);
  } catch (error) {
    res.status(400).json({ error: error.message });
  }
});

Troubleshooting​

Common Issues​

Module not found error:

Error: Cannot find module 'anantla_sdk'

Solution: Run npm install anantla_sdk@latest again

Import/require errors:

SyntaxError: Cannot use import statement outside a module

Solution: Check your package.json has "type": "module" for ESM, or use CommonJS require

API connection errors:

Error: API key is missing

Solution: Configure API key with config.setApiKey() - see API Key Setup

Version Check​

Check your installed SDK version:

npm list anantla_sdk

Always use the latest version for newest features and bug fixes.

Next Steps​

After installation, proceed to:

  1. API Key Setup - Configure authentication
  2. Authentication - Implement user login
  3. Quickstart Tutorial - Build your first integration

Environment Variables​

For production applications, use environment variables:

# .env
BRDZ_API_BASE=https://api.brdz.link/api
BRDZ_API_KEY=your_api_key_here

# Frontend (.env.local)
REACT_APP_BRDZ_API_BASE=https://api.brdz.link/api  
REACT_APP_BRDZ_API_KEY=your_public_api_key

NEXT_PUBLIC_BRDZ_API_KEY=your_public_api_key
VUE_APP_BRDZ_API_KEY=your_public_api_key

Never commit API keys to version control. Use environment variables and .env files added to .gitignore.