Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lorenzb/libsubmarine
Implementation of a novel practical scheme for submarine commitments
https://github.com/lorenzb/libsubmarine
ethereum python smartcontracts solidity
Last synced: about 2 months ago
JSON representation
Implementation of a novel practical scheme for submarine commitments
- Host: GitHub
- URL: https://github.com/lorenzb/libsubmarine
- Owner: lorenzb
- License: other
- Created: 2018-07-25T23:06:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T01:13:53.000Z (about 2 years ago)
- Last Synced: 2024-08-04T09:06:27.868Z (5 months ago)
- Topics: ethereum, python, smartcontracts, solidity
- Language: Python
- Homepage: https://libsubmarine.org
- Size: 138 KB
- Stars: 222
- Watchers: 8
- Forks: 31
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-network-stuff - **47**星
README
# LibSubmarine
[](https://travis-ci.org/lorenzb/libsubmarine)
``` _
| \
'.|
_- _- _- _-|| _- _- _- _- _- _-
_- _- - __||___ _- _- _- _-
_- _- _- | _ | _- _- _-
_- _- /_) (_) (_\ _- _- _-
_.-' `-._ ________ _-
_..--` `-..' .'
_.-' o/o o/o`-..__.' ~ ~
.-' o|o o|o `.._. // ~ ~
`-._ o|o o|o |||<|||~ ~
`-.__o\o o|o .'-' \\ ~ ~
LGB `-.______________________\_...-``'. ~ ~
`._______'.
```
-------------------
**A work-in-progress implementation of better submarine sends for Ethereum.**
# Submarine Steps
- `A` User
- `B` Commit Address (No Private key)
- `C` Libsubmarine
- `D` Dapp, Application (e.g Auction, DEX, ICO, etc.)
- `MPT` Merkle-Patricia Proof of TxCommit Inclusion on-chain
```
TxCommit (1)
A +-------------------> B
+ +
| | TxUnlock (3)
| | (calls unlock)
| v
+---------------------> C < - - - - - - - - - - - - -+ D
(overload) onSubmarineReveal
TxReveal (2) (query) revealedAndUnlocked(submarineId)
(call reveal + MPT
+ RLP-encoded TxUnlock)
```
----------
# Workflow and API Guide
For a more in-depth discussion of what the workflow / steps from a user's perspective
for a Submarine transaction looks like, refer to WORKFLOW.md.
For an in-depth discussion of how to incorporate LibSubmarine into your existing application, as well as some software architecture notes, see API.md.
-----------
# Contract Unit Tests / Examples / Offchain Components
Install Solc ([Installation guide]( http://solidity.readthedocs.io/en/v0.4.24/installing-solidity.html#binary-packages))
Use pip to install python dependencies (we recommend using a virtualenv with >= python3.6):
```
pip3 install -r requirements.txt
```
Run the tests:
```
python3 test/test_whateverComponent.py
```
The tests are particularly useful to see as a reference, since they basically model an end-users interaction with LibSubmarine from start to finish.
-------------
# Disclaimer
This project is a Work in Progress. It has not undergone a formal security audit from an independent 3rd party (though we would like to have that done).
For a high level discussion around the research of Submarine Sends and some historical implementations, please refer to the blog post: [To Sink Frontrunners, Send in the Submarines](http://hackingdistributed.com/2017/08/28/submarine-sends/).
-----------
## Authors
LibSubmarine's development was started by the *Submarines* group at the [2018 IC3 Ethereum bootcamp](http://www.initc3.org/events/2018-07-12-IC3-Ethereum-Crypto-Boot-Camp.html), but is now an open source project. Anyone is encouraged to contribute.
IC3 Ethereum Bootcamp <3 2018