Integration Guides

Step 1: Install and Initialize SDK

npm install @vault-protocol/sdk ethers

import { VaultProtocolSDK } from '@vault-protocol/sdk';
import { ethers } from 'ethers';

// Connect wallet
const provider = new ethers.providers.Web3Provider(window.ethereum);
await provider.send("eth_requestAccounts", []);
const signer = provider.getSigner();

// Initialize SDK
const sdk = new VaultProtocolSDK({
  provider,
  signer,
  network: 'opbnb',
  apiUrl: 'https://api.vaultprotocol.ai',
  litNetwork: 'datil-test',
});

Step 2: Configure Vault Settings

const vaultConfig = {
  name: "My Crypto Inheritance Vault",
  releaseType: "DEADMAN", // or "SCHEDULED", "HYBRID"
  checkInPeriod: 90 * 24 * 60 * 60, // 90 days in seconds
  recipients: [
    "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb", // Beneficiary 1
    "0x1234567890abcdef1234567890abcdef12345678"  // Beneficiary 2
  ],
  encrypted: true,
  metadata: {
    description: "Emergency wallet recovery for family",
    tags: ["inheritance", "emergency", "family"]
  }
};

Tip: Use DEADMAN for emergency recovery, SCHEDULED for time-locked releases, HYBRID for both conditions.

Step 3: Create Vault

try {
  const vault = await sdk.vaultManager.createVault(vaultConfig);

  console.log('✓ Vault created successfully!');
  console.log('Vault ID:', vault.id);
  console.log('Transaction Hash:', vault.transactionHash);
  console.log('Created At:', new Date(vault.createdAt * 1000));

  // Store vault ID for future reference
  localStorage.setItem('vaultId', vault.id);

} catch (error) {
  console.error('Vault creation failed:', error.message);
}

Step 4: Upload Encrypted Content

// Prepare sensitive content (e.g., seed phrase)
const seedPhrase = "word1 word2 word3 ... word24";

// Upload with encryption
const contentCID = await sdk.vaultManager.uploadContent(vault.id, {
  data: seedPhrase,
  encrypted: true,
  storageLocation: 'arweave', // Permanent storage
  contentType: 'text/plain',
  metadata: {
    walletType: 'BIP39',
    description: 'Main wallet seed phrase',
    createdAt: Date.now()
  }
});

console.log('✓ Content uploaded and encrypted');
console.log('Content CID:', contentCID);

// For JSON data (wallet configurations, private keys, etc.)
const walletConfig = {
  mainWallet: { address: '0x...', privateKey: 'encrypted...' },
  subWallets: [...]
};

const jsonCID = await sdk.vaultManager.uploadContent(vault.id, {
  data: JSON.stringify(walletConfig, null, 2),
  encrypted: true,
  storageLocation: 'arweave',
  contentType: 'application/json'
});

Step 5: Set Up Deadman Switch

await sdk.timeManager.configureDeadmanSwitch(
  vault.id,
  90 * 24 * 60 * 60,  // Check-in period: 90 days
  7 * 24 * 60 * 60    // Grace period: 7 days after trigger
);

// Perform initial check-in
await sdk.timeManager.checkIn(vault.id);

console.log('✓ Deadman switch configured');
console.log('Next check-in due: 90 days from now');

Arweave (Permanent Storage)

// Best for: Seed phrases, private keys, critical documents
const arweaveCID = await sdk.vaultManager.uploadContent(vaultId, {
  data: seedPhrase,
  encrypted: true,
  storageLocation: 'arweave',
  contentType: 'text/plain'
});

// Pros: Permanent, immutable, one-time fee
// Cons: Higher upfront cost (~$0.50-5 per MB)

IPFS (Temporary Storage)

// Best for: Metadata, non-critical data, frequent updates
const ipfsCID = await sdk.vaultManager.uploadContent(vaultId, {
  data: vaultMetadata,
  encrypted: false,
  storageLocation: 'ipfs',
  contentType: 'application/json'
});

// Pros: Fast, cheap, easy updates
// Cons: Requires pinning, not permanent by default
// Recommendation: Use with Pinata or Infura pinning service

Ceramic (Dynamic Data)

// Best for: Vault metadata, beneficiary lists, check-in logs
const ceramicStreamId = await sdk.vaultManager.uploadContent(vaultId, {
  data: {
    beneficiaries: [...],
    checkInHistory: [...],
    lastUpdated: Date.now()
  },
  encrypted: false,
  storageLocation: 'ceramic',
  contentType: 'application/json'
});

// Pros: Mutable, version-controlled, decentralized
// Cons: Requires DID authentication, slightly slower

Choose the Right Network

Batch Operations

// ❌ Bad: Multiple transactions
for (const vaultId of vaultIds) {
  await sdk.timeManager.checkIn(vaultId); // Separate tx for each
}

// ✅ Good: Single batched transaction
await sdk.timeManager.batchCheckIn(vaultIds); // One tx for all

// Gas savings: ~60% for 5+ vaults

Use VaultFactory

// ❌ Bad: Direct deployment (~500K gas)
const vault = await vaultContract.deploy(...);

// ✅ Good: Factory pattern (~50K gas, 90% savings)
const vault = await vaultFactory.deployVault(...);

Off-Chain Data Storage

// ❌ Bad: Store large data on-chain
await vaultManager.setContent(vaultId, largeJSONString);
// Cost: ~$50-500 on Ethereum

// ✅ Good: Store CID only
const cid = await uploadToArweave(largeJSONString);
await vaultManager.setContentCID(vaultId, cid);
// Cost: ~$0.50-5 one-time + minimal gas