https://github.com/interledger-deprecated/five-bells-notary
Cryptographic notary
https://github.com/interledger-deprecated/five-bells-notary
Last synced: 5 months ago
JSON representation
Cryptographic notary
- Host: GitHub
- URL: https://github.com/interledger-deprecated/five-bells-notary
- Owner: interledger-deprecated
- License: other
- Created: 2015-09-05T01:23:13.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-07-31T12:23:02.000Z (almost 9 years ago)
- Last Synced: 2025-08-09T06:29:31.909Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 406 KB
- Stars: 6
- Watchers: 4
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Five Bells Notary [![npm][npm-image]][npm-url] [![circle][circle-image]][circle-url] [![codecov][codecov-image]][codecov-url]
[npm-image]: https://img.shields.io/npm/v/five-bells-notary.svg?style=flat
[npm-url]: https://npmjs.org/package/five-bells-connector
[circle-image]: https://circleci.com/gh/interledgerjs/five-bells-notary.svg?style=shield
[circle-url]: https://circleci.com/gh/interledgerjs/five-bells-notary
[codecov-image]: https://codecov.io/gh/interledgerjs/five-bells-notary/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/interledgerjs/five-bells-notary
> Server application that notarizes receipt of [crypto-condition fulfillments](https://github.com/interledgerjs/five-bells-condition) by an expiry date
## What does this do?
A standard Interledger payment relies on connectors to relay transfer data within a time limit. This works fine in most cases, but when participants can agree on some trusted parties we can do better.
In order to decide whether to commit or rollback a transfer, the participants to a transfer may choose to use a witness. Using a witness, we can guarantee atomicity for the transfer, as long as the witness promises only to publish the commit or the rollback message, but not both.
Of course, now the transactional semantics depend on safety and liveness of the witness. In order to minimize the risk of failure, we use not a single witness, but a consensus group of witnesses. (Consensus feature is not implemented yet.)
## Usage
To run with sqlite,
```
NOTARY_DB_SYNC=1 NOTARY_DB_URI=sqlite://:memory: npm start
```
To run with postgres, create a database, then
```
NOTARY_DB_SYNC=1 NOTARY_UNIT_DB_URI=postgres://user:password@host:port/db_name npm start
```
`NOTARY_DB_SYNC` is a test setting that creates the database by running the SQL scripts in `./src/sql`. These scripts are not re-runnable. You must drop the database or set `NOTARY_DB_SYNC=0` after the initial run.
Configuring log level
`NOTARY_LOG_LEVEL` (default: `info`) the allowed levels in order of verbosity are `fatal`, `error`, `warn`, `info`, `debug`, and `trace`