valence_core 0.1.2

Core module used across plug-ins for A-Block Valence nodes
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

<div id="top"></div>

<!-- PROJECT LOGO -->
<br />

<div align="center">
    <div style="height: 50px; width: 100%"></div>

  <a>
    <img src="https://github.com/ABlockOfficial/valence_core/blob/main/assets/hero.svg" alt="Logo" width="320px">
  </a>

  <div style="height: 50px; width: 100%"></div>

  <h3>valence_core</h3>

<img src="https://img.shields.io/github/actions/workflow/status/ABlockOfficial/valence_core/.github/workflows/rust.yml?branch=main" alt="Pipeline Status" style="display:inline-block"/>
<img src="https://img.shields.io/crates/v/valence_core" />


  <p align="center">
    The core library used by all <a href="https://github.com/ABlockOfficial/Valence">Valence</a> nodes and their plug-ins
    <br />
    <br />
    <a href="https://a-block.io"><strong>Official documentation »</strong></a>
    <br />
    <br />
  </p>
</div>

<!-- GETTING STARTED -->

## 🎉 Plug-ins Using valence_core

Here you can find awesome plug-ins already using `valence_core` to boost their Valence nodes:

- **[valence_market](https://github.com/ABlockOfficial/valence_market)**: Build a web3 marketplace in seconds

If you'd like to have your plug-in added to the list, please open a PR and we'll be happy to take a look!

<p align="left">(<a href="#top">back to top</a>)</p>

..

## How to Use

`valence_core` is designed to be used as a core crate for Valence functionality that is common across all node types and plug-ins. It is not designed to be used as a standalone crate, and will not compile as such.

..

### 🔧 Installation

If you have `cargo-add` installed, you can simply run the following command:

```sh
cargo add valence_core
```

Otherwise, add the following to your `Cargo.toml` file:

```toml
[dependencies]
valence_core = "0.1.2"
```

<p align="left">(<a href="#top">back to top</a>)</p>

..

### 🏎️ Use in Plug-ins

The `valence_core` library exposes a few common methods and functionalities that are useful if you're either using plug-ins or writing your own. This core functionality includes:

- **api:** The module here contains most of the `struct`s and `enum`s that are used to communicate between nodes and plug-ins. This includes the `JsonReply`, `ApiErrorResponse` and `APIResponseStatus` structs, as well as functions for JSON serialisation and Warp API replies.

- **db:** The module here contains all the common code associated with data storage. This includes the `KvStoreConnection` trait, which ensures consistent interfacing with data handlers across the Valence ecosystem

- **crypto:** The module here ensures consistency in the handling of cryptography across the Valence ecosystem. If you want to do anything with cryptography in your plug-in, you should use the functions here.

<p align="left">(<a href="#top">back to top</a>)</p>

..

### Further Work

- [x] Add tests
- [x] Consider abstraction structure for API and DB handling
- [ ] Add traces

<p align="left">(<a href="#top">back to top</a>)</p>

..