activeledger/
lib.rs

1/*
2 * MIT License (MIT)
3 * Copyright (c) 2019 Activeledger
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 */
23
24//! # Activeledger Rust SDK
25//!
26//! <img src="https://www.activeledger.io/wp-content/uploads/2018/09/Asset-23.png" alt="Activeledger" width="300"/>
27//!
28//! Activeledger is a powerful distributed ledger technology.
29//! Think about it as a single ledger, which is updated simultaneously in multiple locations.
30//! As the data is written to a ledger, it is approved and confirmed by all other locations.
31//!
32//! ## This Crate
33//!
34//! This crate provides Rust developers the ability to easily integrate their applications
35//! with Activeledger.
36//!
37//! This crate gives you access to the core essentials needed to get started.
38//! * Connection - Connect to an Activeledger node in a network.
39//! * Keys - RSA and EC key generation with data signing abilities.
40//!
41//! Integrating these into this crate makes it much quicker to bootstrap your DLT software.
42//!
43//! ## Additional Activeledger crates
44//! Adhearing to the Rust mentality of keeping things small we have created other crates that can be used in conjunction
45//! with this one to add additional functionality.
46//!
47//! These crates are:
48//! * [active_events](https://github.com/activeledger/SDK-Rust-Events) - For working with server sent events.
49//! * [active_tx](https://github.com/activeledger/SDK-Rust-TxBuilder) - To build transactions without worrying about the JSON.
50//!
51//! ## Links
52//!
53//! [Activeledger](https://activeledger.io)
54//!
55//! [Activeledger Developers portal](https://developers.activeledger.io)
56//!
57//! [Activeledger on GitHub](https://github.com/activeledger/activeledger)
58//!
59//! [Activeledger on NPM](https://www.npmjs.com/package/@activeledger/activeledger)
60//!
61//! [This SDK on GitHub](https://github.com/activeledger/SDK-Rust)
62//!
63//! [Report Issues](https://github.com/activeledger/SDK-Rust/issues)
64
65mod connection;
66pub mod key;
67
68pub use connection::{error, transaction::Transaction, Connection};
activeledger/lib.rs

activeledger/
lib.rs
