Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/quic-pro/mvts-contract-interfaces-js

A set of interfaces for working with smart contracts of the routing system.
https://github.com/quic-pro/mvts-contract-interfaces-js

blockchain mvts smartcontracts

Last synced: 4 days ago
JSON representation

A set of interfaces for working with smart contracts of the routing system.

Awesome Lists containing this project

README

        

# @mvts/contract-interfaces-js

A set of interfaces for working with smart contracts of the routing system.

## Installation

Using npm:

```bash
npm install @mvts/contract-interfaces-js
```

Using yarn:

```bash
yarn add @mvts/contract-interfaces-js
```

## Interfaces

Interfaces for working with smart contracts:

| Name | Description |
|------------|------------------------------------------------------------------------------------------|
| Curator | Fully complies with the smart contract. Stores information about the actual root router. |
| Router | Fully compliant with the router smart contract standard. Used to work with any router. |
| RootRouter | Fully complies with the smart contract. The root router of the system. |

Detailed description of smart contracts and their methods: [MVTS Documentation](https://docs.mvts.io/smart-contracts)

For convenience, you can use factories that store the ABI of the corresponding smart contract:

```javascript
const curator = CuratorFactory.connect(address, provider);
const router = RouterFactory.connect(address, provider);
const rootRouter = RootRouterFactory.connect(address, provider);
```

## License

[MIT](LICENSE)