-
Notifications
You must be signed in to change notification settings - Fork 529
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # Evaluation | ||
|
|
||
| - **Status:** In Progress | ||
| - **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/swarm-nl.md | ||
| - **Milestone:** 2 | ||
| - **Kusama Identity:** [ESxS4A7GHMLzve4Mbc9t27RpXtVTnV3LtcMTtcnD26jcUHA](https://polkascan.io/pre/kusama/account/ESxS4A7GHMLzve4Mbc9t27RpXtVTnV3LtcMTtcnD26jcUHA) | ||
| - **Previously successfully merged evaluation:** All by semuelle | ||
|
|
||
| | Number | Deliverable | Accepted | Link | Evaluation Notes | | ||
| | ------ | ----------- | :------: | ---- |----------------- | | ||
| | **0a.** | License | <ul><li>[x] </li></ul> | [LICENSE](https://github.com/algorealmInc/SwarmNL/blob/9049b7d0578529a5d86e5d872934b2cc192abe8d/LICENSE) | Apache 2.0 | | ||
| | **0b.** | Documentation | <ul><li>[x] </li></ul> | [Rust docs](https://algorealminc.github.io/SwarmNL/swarm_nl/index.html)| — | | ||
| | **0c.** | Testing and Testing Guide | <ul><li>[x] </li></ul> | [`tests`](https://github.com/algorealmInc/SwarmNL/tree/9049b7d0578529a5d86e5d872934b2cc192abe8d/swarm-nl/src/core/tests), [testing guide](https://algorealminc.github.io/SwarmNL/swarm_nl/testing_guide/index.html) | — | | ||
| | **0d.** | Docker files | <ul><li>[x] </li></ul> | [/examples](https://github.com/algorealmInc/SwarmNL/tree/9049b7d0578529a5d86e5d872934b2cc192abe8d/examples) | Dockerfiles for every example | | ||
| | 1. | Research | <ul><li>[ ] </li></ul> | [Research](https://github.com/algorealmInc/SwarmNL/blob/main/research.md) | This document gives an overview of the design and implementation decisions for fault-tolerance and scaling based on research. | | ||
| | 2. | Scaling (implementation of sharding, data-forwarding and fault-tolerant algorithms to SwarmNL) | <ul><li>[ ] </li></ul> | [Replication module](https://github.com/algorealmInc/SwarmNL/blob/main/swarm-nl/src/core/replication.rs) and [Sharding module](https://github.com/algorealmInc/SwarmNL/blob/main/swarm-nl/src/core/sharding.rs) | These modules contain all of the core parts of the library for fault-tolerance using replication and scaling through sharding and data-forwarding. | | ||
| | 3. | IPFS integration | <ul><li>[x] </li></ul> | [examples/ipfs](https://github.com/algorealmInc/SwarmNL/tree/9049b7d0578529a5d86e5d872934b2cc192abe8d/examples/ipfs) | — | | ||
| | 4. | Extendability of library | <ul><li>[ ] </li></ul> | [HTTP server example](https://github.com/algorealmInc/SwarmNL/tree/main/examples/http-client) | We demonstrate the implementation of SwarmNL's generic interface to POST data to a remote HTTP server (run with Docker: [Dockerfile](https://github.com/algorealmInc/SwarmNL/tree/main/examples/http-client/Dockerfile)). | | ||
|
|
||
|
|
||
| ## General Notes | ||
|
|
||
| - — | ||
|
|
||
| ### `cargo test` output | ||
|
|
||
| ```sh | ||
| Running unittests src/lib.rs (target/debug/deps/swarm_nl-5997663f32b803a3) | ||
|
|
||
| running 6 tests | ||
| test core::tests::node_behaviour::node_custom_setup_works ... ok | ||
| test core::tests::node_behaviour::node_custom_behavior_with_network_id_works ... ok | ||
| test core::tests::node_behaviour::node_custom_behavior_with_network_id_fails - should panic ... ok | ||
| test core::tests::node_behaviour::node_default_behavior_works ... ok | ||
| test core::tests::node_behaviour::node_save_keypair_offline_works_tokio ... ok | ||
| test core::tests::replication::eventual_consistency::new_node_join_and_sync_works ... ok | ||
|
|
||
| test result: ok. 6 passed; 0 failed; 0 ignored; 0 measured; 52 filtered out; finished in 26.14s | ||
| ``` | ||
|
|
||
| ### Eventual Consistency demo output | ||
|
|
||
| ```sh | ||
| Running `target/debug/eventual_consistency_model` | ||
| Dailing /ip4/127.0.0.1/tcp/49193 | ||
| Dailing /ip4/127.0.0.1/tcp/49595 | ||
| Joining replica network | ||
| Replica network successfully joined | ||
| Peer id: 12D3KooWQDpMufFJytG2xQuz7JzfK2vBH2g3XXBJ9v2xY7SegRUk | ||
| We're listening on /ip4/127.0.0.1/tcp/49194 | ||
| Peer id: 12D3KooWQDpMufFJytG2xQuz7JzfK2vBH2g3XXBJ9v2xY7SegRUk | ||
| We're listening on /ip4/192.168.178.21/tcp/49194 | ||
| Peer id: 12D3KooWQDpMufFJytG2xQuz7JzfK2vBH2g3XXBJ9v2xY7SegRUk | ||
| We're listening on /ip4/172.17.0.1/tcp/49194 | ||
| Peer id: 12D3KooWQDpMufFJytG2xQuz7JzfK2vBH2g3XXBJ9v2xY7SegRUk | ||
| We're listening on /ip4/192.168.178.26/tcp/49194 | ||
| Peer id: 12D3KooWQDpMufFJytG2xQuz7JzfK2vBH2g3XXBJ9v2xY7SegRUk | ||
| We're listening on /ip4/127.0.0.1/udp/55092/quic-v1 | ||
| Peer id: 12D3KooWQDpMufFJytG2xQuz7JzfK2vBH2g3XXBJ9v2xY7SegRUk | ||
| We're listening on /ip4/192.168.178.21/udp/55092/quic-v1 | ||
| Peer id: 12D3KooWQDpMufFJytG2xQuz7JzfK2vBH2g3XXBJ9v2xY7SegRUk | ||
| We're listening on /ip4/172.17.0.1/udp/55092/quic-v1 | ||
| Peer id: 12D3KooWQDpMufFJytG2xQuz7JzfK2vBH2g3XXBJ9v2xY7SegRUk | ||
| We're listening on /ip4/192.168.178.26/udp/55092/quic-v1 | ||
|
|
||
| =================== | ||
| Replication Test Menu | ||
| Usage: | ||
| repl <data> - Replicate to peers | ||
| read - Read content from buffer | ||
| exit - Exit the application | ||
| > repl Apples | ||
| Replicating data: Apples | ||
| Replication successful | ||
| > Recieved incoming replica data from 12D3KooWFPuUnCFtbhtWPQk1HSGEiDxzVrQAxYZW5zuv2kGrsam4 | ||
| Recieved incoming replica data from 12D3KooWCHqiBVTsUDy4ZtcV2Ds7rxt2HGuaT5dHTKskw68Y8AWu | ||
| read | ||
| Reading contents from buffer... | ||
| Buffer Data: Oranges | ||
| Buffer Data: Bananas | ||
| ``` |