@xo-cash/engine

XO Engine

⚠️ This project is in early development phase. Use it only if you understand what you are doing and accept the risks. Do not use funds you are not willing to lose. Minor version bumps may introduce breaking changes

Installation

npm install @xo-cash/engine

Basic Setup

import { Engine } from '@xo-cash/engine';
import { createElectrumClient } from '@electrum-cash/network';

// Create an Electrum client for blockchain connectivity
const client = await createElectrumClient({
    // client configuration
});

// Initialize the engine with wallet seed and storage options
const engine = await Engine.create('your-wallet-seed', client, {
    databasePath: './',
    databaseFilename: 'XO',
    defaultTemplateHubUrl: 'https://template-hub.example.com',
});

// Import a template
const templateIdentifier = await engine.importTemplate(templateJson);

// List available starting actions for a template
const startingActions = await engine.listStartingActions(templateIdentifier);

// Create an invitation for a specific action
const invitation = await engine.createInvitation({
    templateIdentifier,
    actionIdentifier: 'action-id',
});

Links

• Repository
• Issues

License

MIT