Installation & Setup - Emblem Vault SDK

Get the Emblem Vault SDK up and running in your project. The SDK supports both Node.js environments and browser usage with multiple installation options.

📦 Installation Methods

NPM Package (Recommended)

Install the SDK as a dependency in your Node.js or modern web project:

terminal

✅ Best for React, Vue, Angular, and Node.js projects

Yarn Package Manager

For projects using Yarn:

terminal

PNPM Package Manager

For projects using PNPM:

terminal

Browser Script (Direct Include)

Include the bundled script directly in HTML pages:

index.html

⚠️ Good for quick prototyping, but NPM is recommended for production

⚙️ Basic Setup

ES Modules (Modern JavaScript)

es-modules.js

CommonJS (Node.js)

commonjs.js

TypeScript Setup

setup.ts

🌍 Environment Configuration

SDK Environment Options

The SDK constructor accepts different environment configurations:

Development/Testing

const sdk = new EmblemVaultSDK('demo');

• Uses demo/testnet endpoints
• Safe for experimentation
• No real assets at risk

Production

const sdk = new EmblemVaultSDK('production');

• Uses mainnet endpoints
• Real assets and transactions
• Requires proper security measures

Custom Environment

custom-config.js

• Custom API endpoints
• Specific chain configurations
• Advanced use cases

🔧 Web3 Integration

Setting up Web3 Provider

Most SDK operations require a Web3 provider for blockchain interactions:

Browser with MetaMask

browser-metamask.js

Node.js with Infura/Alchemy

nodejs-infura.js

Using the SDK's Web3 Helper

sdk-web3-helper.js

🚀 Quick Start Example

Complete Setup Example

complete-setup.js

🛠️ Framework-Specific Setup

React Setup

react-hook.js

Vue.js Setup

vue-composable.js

Next.js Setup

nextjs-api-route.js

🧪 Verification & Testing

Test Your Installation

Run this simple test to verify everything is working:

import EmblemVaultSDK from 'emblem-vault-sdk';

async function testInstallation() {
  console.log('Testing Emblem Vault SDK installation...');

  try {
    // Test 1: SDK initialization
    const sdk = new EmblemVaultSDK('demo');
    console.log('✅ SDK initialization successful');

    // Test 2: Fetch contracts
    const contracts = await sdk.fetchCuratedContracts(false);
    console.log(`✅ Fetched ${contracts.length} curated contracts`);

    // Test 3: Utility functions
    const uploadUrl = sdk.generateUploadUrl();
    console.log('✅ Utility functions working:', !!uploadUrl);

    console.log('🎉 Installation test completed successfully!');
    return true;
  } catch (error) {
    console.error('❌ Installation test failed:', error.message);
    return false;
  }
}

// Run the test
testInstallation();

✅ Installation Checklist

• SDK Installed: Package installed via NPM/Yarn/PNPM
• Import Working: Can import EmblemVaultSDK without errors
• Web3 Provider: Web3 provider available (MetaMask, Infura, etc.)
• Environment Set: Correct environment ('demo' for testing)
• Test Passed: Basic functionality test completes successfully

⚠️ Troubleshooting

Import errors:

Make sure you're using the correct import syntax for your environment (ES6 vs CommonJS)

Web3 not found:

Install web3: npm install web3

MetaMask issues:

Ensure MetaMask is installed and you've connected your wallet