flex

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 21 Open GitHub ↗

An embeddable, programmable order book framework

// repository documentation

★ 0 (0 ratings)

<h3 align="center">Verto Flex</h3>

<p align="center">
    An embeddable, programmable order book framework
  </p>
</p>

## Installation

```sh
npm install @verto/flex
```

or

```sh
yarn add @verto/flex
```

## Prerequisites

Your SmartWeave contract state MUST contain the following variables in order for the Verto Components to function properly:

```js
{
  emergencyHaltWallet: "",
  halted: false,
  pairs: [],
  usedTransfers: [],
  invocations: [],
  foreignCalls: []
}
```

## Usage

This framework includes the core functions necessary to give SmartWeave contracts the ability to embed and manage a central limit order book.

### Import

To use the library, you'll need to import its functions

```ts
import {
  AddPair,
  CancelOrder,
  CreateOrder,
  Halt,
  ReadOutbox,
} from "@verto/flex";
```

### Add a pair

```ts
const { newState, result } = await AddPair(state, action);
```