Official Xcrow SDK for Node

Helping developers securely escrow funds on Solana through a simple, secure, and reliable interface.

Installing

npm install @xcrowdev/node

# Or yarn
yarn add @xcrowdev/node

Usage

Deposit

import { Xcrow } from '@xcrowdev/node';

// Create a xcrow instace
const xcrow = new Xcrow({
  apiKey: process.env.API_KEY,
  applicationId: process.env.APPLICATION_ID,
});

// Call a function to deposit
const deposit = await xcrow.deposit({
  payer: 'PUBLIC ADDRESS',
  strategy: 'blockhash',
  priorityFeeLevel: 'Medium',
  token: {
    mintAddress: 'So11111111111111111111111111111111111111112',
    amount: 0.01,
  },
  network: 'mainnet',
});

// Sign the transaction, this action can be made by wallet like phantom or solflare
const signedTransaction = await signTransaction(
  deposit.serializedTransaction,
);


// Finally execute the transaction
await xcrow.execute({
  vaultId: deposit.vaultId,
  transactionId: deposit.transactionId,
  signedTransaction,
});

Withdraw

import { Xcrow } from '@xcrowdev/node';

// Create a xcrow instace
const xcrow = new Xcrow({
  apiKey: process.env.API_KEY,
  applicationId: process.env.APPLICATION_ID,
});

// the Vault Id received from the deposit
const vaultId = 'VAULT_ID';

// Call a function to withdraw
const withdraw = await xcrow.withdraw({
  vaultId,
  payer: 'PUBLIC ADDRESS',
  strategy: 'blockhash',
  priorityFeeLevel: 'Medium',
  token: {
    mintAddress: 'So11111111111111111111111111111111111111112',
    amount: 0.01,
  },
  network: 'mainnet',
});

// Sign the transaction, this action can be made by wallet like phantom or solflare
const signedTransaction = await signTransaction(
  deposit.serializedTransaction,
);

// Finally execute the transaction
await xcrow.execute({
  vaultId: deposit.vaultId,
  transactionId: deposit.transactionId,
  signedTransaction,
});

Errors

| Error Class | Description | |---------------------------|------------------------| | InsufficientFundsError | Insufficient funds | | TokenNotFoundError | Token not found | | TransactionExpiredError | Transaction expired | | MissingApiKeyError | Missing API key | | MissingApplicationIdError | Missing application ID | | UnknownError | Unknown error |