@rosen-bridge/ergo-box-selection

Table of contents

• Introduction
• Installation
• Usage

Introduction

A TypeScript package for selecting Ergo boxes to cover required amounts of assets, built on top of the abstract box selection framework.

Installation

npm:

npm i @rosen-bridge/ergo-box-selection

yarn:

yarn add @rosen-bridge/ergo-box-selection

Usage

Here's a basic example of how to use this package:

import { DummyLogger } from '@rosen-bridge/abstract-logger';
import { ErgoBoxSelection } from '@rosen-bridge/ergo-box-selection';

// Create the selection instance
const selector = new ErgoBoxSelection(new DummyLogger());

// Define required assets
const requiredAssets = {
  nativeToken: 1000000000000n, // 1000 ERG
  tokens: [
    { id: 'token1', value: 100n },
    { id: 'token2', value: 200n },
  ],
};

// Define boxes
const boxes: ErgoBox[] = [
  {
    boxId: 'box1',
    value: 5000000000000n, // 5000 ERG
    tokens: [{ id: 'token1', value: 100n }],
    creationHeight: 100000,
  },
  {
    boxId: 'box2',
    value: 3000000000000n, // 3000 ERG
    tokens: [{ id: 'token2', value: 200n }],
    creationHeight: 100001,
  },
];

// Get covering boxes
const result = await selector.getCoveringBoxes(
  requiredAssets,
  [], // forbidden box IDs
  new Map(), // track map
  boxes.values(),
);

if (result.covered) {
  console.log('Selected boxes:', result.boxes);
  console.log('Additional assets:', result.additionalAssets);
} else {
  console.log('Could not cover requirements');
}

You can also use custom min box value and limit number of tokens per change box by passing them as arguments to the getCoveringBoxes method.

const result = await selector.getCoveringBoxes(
  requiredAssets,
  [], // forbidden box IDs
  new Map(), // track map
  boxes.values(),
  2000000n, // min box value
  3, // max token count
);