Skip to content

Commit

Permalink
mempack update
Browse files Browse the repository at this point in the history
  • Loading branch information
rmourey26 committed Oct 18, 2022
1 parent 41c6747 commit 01dd6fc
Show file tree
Hide file tree
Showing 422 changed files with 4,088 additions and 3,717 deletions.
2,670 changes: 1,335 additions & 1,335 deletions CHANGELOG.md

Large diffs are not rendered by default.

1,384 changes: 617 additions & 767 deletions Cargo.lock

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ members = [
"modules/blockchain",
"testing/quibitous-automation",
"testing/quibitous-integration-tests",
"testing/gate",
"testing/mfive",
"testing/quantricity",
"testing/silica",
"testing/loki",
"testing/mjolnir",
"testing/hersir",
"testing/thor",
]
12 changes: 6 additions & 6 deletions LICENSE-APACHE
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity ausilicaized by
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
Expand All @@ -32,24 +32,24 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of ausilicaship, whether in Source or
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of ausilicaship. For the purposes
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of ausilicaship, including
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity ausilicaized to submit on behalf of
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
Expand Down Expand Up @@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work.
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright (c) 2018-2019 The Blockchain Company
Copyright (c) 2022 The Blockchain Company.io LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 The Blockchain Company
Copyright (c) 2022 The Blockchain Company.io LLC

Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
Expand Down
29 changes: 13 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Full Node

> Quibitous is on a journey to the post quantum computing era
>
> Just because you call something a blockchain, that doesn't mean you aren't
> subject to normal engineering laws.
User guide documentation available [here][docs]

[docs]: https://The-Blockchain-Company.github.io/quibitous
[docs]: https://the-blockchain-company.github.io/quibitous

## Master current build status
## git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56" current build status

| CI | Status | Description |
|---:|:------:|:------------|
| CircleCI | [![CircleCI](https://circleci.com/gh/The-Blockchain-Company/quibitous/tree/master.svg?style=svg)](https://circleci.com/gh/The-Blockchain-Company/quibitous/tree/master) | Master and PRs |
| CircleCI | [![CircleCI](https://circleci.com/gh/the-blockchain-company/quibitous/tree/git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56".svg?style=svg)](https://circleci.com/gh/the-blockchain-company/quibitous/tree/git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56") | git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56" and PRs |

## Install from Binaries

Use the [Latest Binaries](https://github.com/The-Blockchain-Company/quibitous/releases),
Use the [Latest Binaries](https://github.com/the-blockchain-company/quibitous/releases),
available for many operating systems and architectures.

## Install from Source
Expand All @@ -27,8 +27,7 @@ available for many operating systems and architectures.
Get the [Rust Compiler](https://www.rust-lang.org/tools/install) (latest stable
version is recommended, minimum required: 1.39+).

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

```sh
rustup install stable
rustup default stable
rustc --version # if this fails, try a new command window, or add the path (see below)
Expand All @@ -54,17 +53,15 @@ rustc --version # if this fails, try a new command window, or add the path (see
* The [Protocol Buffers](https://developers.google.com/protocol-buffers) version
bundled with crate `prost-build` will be used.
* For distribution or container builds in general, it's a good practice to
install `protoc` from the official distribution package if available ie.
sudo apt install -y protobuf-compiler
install `protoc` from the official distribution package if available.

### Commands

Check `<latest release tag>` on
https://github.com/The-Blockchain-Company/quibitous/releases/latest
https://github.com/the-blockchain-company/quibitous/releases/latest

```sh
git clone https://github.com/The-Blockchain-Company/quibitous
git clone https://github.com/the-blockchain-company/quibitous
cd quibitous
git checkout tags/<latest release tag> #replace this with something like v1.2.3
cargo install --locked --path quibitous # --features systemd # (on linux with systemd)
Expand All @@ -80,9 +77,9 @@ This will install 2 tools:

A functional node needs 2 configurations:

1. Its own [node configuration](https://The-Blockchain-Company.github.io/quibitous/configuration/introduction.html):
1. Its own [node configuration](https://the-blockchain-company.github.io/quibitous/configuration/introduction.html):
Where to store data, network configuration, logging.
2. The [blockchain genesis configuration](https://The-Blockchain-Company.github.io/quibitous/advanced/introduction.html),
2. The [blockchain genesis configuration](https://the-blockchain-company.github.io/quibitous/advanced/introduction.html),
which contains the initial trusted setup of the blockchain: coin
configuration, consensus settings, initial state.

Expand All @@ -99,7 +96,7 @@ to. The simplest way to start such a node is:

## Quick-Start - Bcc Sophie Testnet

* [Official Bcc Sophie Testnet Documentation](https://testnet.tbcodev.io/bcc/sophie/).
* [Official Bcc Sophie Testnet Documentation](https://testnet.tbcodev.io/bcc/shelley/).
* For the **nightly testnet**, ask within the
[Bcc Stake Pool Workgroup Telegram group](https://web.telegram.org/#/im?p=@BccStakePoolWorkgroup).

Expand Down
6 changes: 3 additions & 3 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Release

release are a specific commit on the 'master' branch
release are a specific commit on the 'git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56"' branch

release will happens on master every Wednesday, unless the repository
has not changed since the last release or that master doesn't compile.
release will happens on git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56" every Wednesday, unless the repository
has not changed since the last release or that git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56" doesn't compile.

A release must have:

Expand Down
2 changes: 1 addition & 1 deletion book.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[book]
ausilicas = ["Nicolas Di Prima"]
authors = ["Nicolas Di Prima"]
multilingual = false
src = "doc"
title = "Quibitous"
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions ci/tags.nc3PFE → ci/tags.XIgjU9
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ qcli_name pack-assets.py /^ qcli_name = "qcli.exe"$/;" v
quibitous_name pack-assets.py /^ quibitous_name = "quibitous"$/;" v
qcli_name pack-assets.py /^ qcli_name = "qcli"$/;" v
quibitous_path pack-assets.py /^quibitous_path = os.path.join(root_dir, quibitous_name)$/;" v
qcli_path pack-assets.py /^qcli_path = os.path.join(root_dir, qcli_name)$/;" v
jcli_path pack-assets.py /^jcli_path = os.path.join(root_dir, jcli_name)$/;" v
quibitous_checksum pack-assets.py /^quibitous_checksum = sha256sum(quibitous_path)$/;" v
qcli_checksum pack-assets.py /^qcli_checksum = sha256sum(qcli_path)$/;" v
jcli_checksum pack-assets.py /^jcli_checksum = sha256sum(jcli_path)$/;" v
zipfile pack-assets.py /^ import zipfile$/;" i
content_type pack-assets.py /^ content_type = "application\/zip"$/;" v
archive_name pack-assets.py /^ archive_name = f"{archive_basename}.zip"$/;" v
tarfile pack-assets.py /^ import tarfile$/;" i
content_type pack-assets.py /^ content_type = "application\/gzip"$/;" v
archive_name pack-assets.py /^ archive_name = f"{archive_basename}.tar.gz"$/;" v
quibitous1_checksum pack-assets.py /^quibitous1_checksum = sha256sum(os.path.join(".\/unpack-test", quibitous_name))$/;" v
qcli1_checksum pack-assets.py /^qcli1_checksum = sha256sum(os.path.join(".\/unpack-test", qcli_name))$/;" v
jcli1_checksum pack-assets.py /^jcli1_checksum = sha256sum(os.path.join(".\/unpack-test", jcli_name))$/;" v
archive_checksum pack-assets.py /^archive_checksum = sha256sum(archive_name)$/;" v
checksum_filename pack-assets.py /^checksum_filename = f"{archive_name}.sha256"$/;" v
json release-info.py /^import json$/;" i
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions doc/advanced/02_starting_bft_blockchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,13 @@ p2p:
blocks: normal
```

8. Start Quibitous node :
8. Start Jörmungandr node :

```sh
quibitous --genesis-block block-0.bin --config node.config --secret node_secret.yaml
```

# Script

Additionally, there is a script [here](https://github.com/The-Blockchain-Company/quibitous/blob/master/scripts/bootstrap.py)
Additionally, there is a script [here](https://github.com/the-blockchain-company/quibitous/blob/git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56"/scripts/bootstrap.py)
that can be used to bootstrap a test node with bft consensus protocol.
2 changes: 1 addition & 1 deletion doc/advanced/03_starting_genesis_optimum_blockchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,6 @@ quibitous --genesis-block block-0.bin --config config.yaml --secret poolsecret.y

# Test script

There is a script [here](https://github.com/The-Blockchain-Company/quibitous/blob/master/scripts/bootstrap.py)
There is a script [here](https://github.com/the-blockchain-company/quibitous/blob/git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56"/scripts/bootstrap.py)
that can be used to bootstrap a test node with a pre-set faucet and stake pool and can be used as an
example.
4 changes: 2 additions & 2 deletions doc/api/v0.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ openapi: 3.0.2

info:
title: Generic blockchain node REST API
description: Quibitous Rest API v0
description: Jörmungandr Rest API v0
version: 0.0.1
contact:
url: 'https://github.com/The-Blockchain-Company/quibitous/'
url: 'https://github.com/the-blockchain-company/quibitous/'

servers:
- url: 'https://localhost'
Expand Down
4 changes: 2 additions & 2 deletions doc/api/v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ openapi: 3.0.2

info:
title: Generic blockchain node REST API
description: Quibitous Rest API v1
description: Jörmungandr Rest API v1
version: 0.0.1
contact:
url: 'https://github.com/The-Blockchain-Company/quibitous/'
url: 'https://github.com/the-blockchain-company/quibitous/'

servers:
- url: 'https://localhost'
Expand Down
2 changes: 1 addition & 1 deletion doc/concepts/blockchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Transaction have fees that are defined by the blockchain settings and the follow

\\( \sum Inputs = \sum Outputs + fees \\)

Transaction need to be ausilicaized by each of the inputs in the transaction by their respective witness.
Transaction need to be authorized by each of the inputs in the transaction by their respective witness.
In the most basic case, a witness is a cryptographic signature, but depending on the type of input can
the type of witness vary.

Expand Down
4 changes: 2 additions & 2 deletions doc/concepts/network.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Network overview

Quibitous network capabilities are split into:
Jörmungandr network capabilities are split into:

1. the REST API, used for informational queries or control of the node;
2. the gRPC API for blockchain protocol exchange and participation;
Expand All @@ -11,7 +11,7 @@ chapter: [go to the REST documentation](../quickstart/03_rest_api.md)
## The protocol

The protocol is based on [`gRPC`] that combines commonly used protocols like HTTP/2 and RPC.
More precisely, Quibitous utilises.
More precisely, Jörmungandr utilises.

This choice was made because [`gRPC`] is already widely supported around the world because
of it's uitilization of standard protocols HTTP/2 which makes it much easier for Proxies and Firewalls to recognise
Expand Down
8 changes: 4 additions & 4 deletions doc/configuration/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ It covers the network, logging and storage parameters.

## Node Configuration

This is an common example of a Quibitous node configuration file typically named `node-config.yaml`, however your's will vary depending on your needs.
Additionally, this configuration has been tested on a *specific Quibitous version* and may change with newer versions.
This is an common example of a Jörmungandr node configuration file typically named `node-config.yaml`, however your's will vary depending on your needs.
Additionally, this configuration has been tested on a *specific Jörmungandr version* and may change with newer versions.
It's important to keep in mind that the `trusted_peers` portion of this configuration will be different for each Bcc blockchain network.
If you're trying to connect this node to a specific network, you need to know its genesis block hash, and its associated list of trusted peers.

Expand All @@ -20,7 +20,7 @@ log:
format: plain

http_fetch_block0_service:
- https://url/quibitous-block0/raw/master/data
- https://url/quibitous-block0/raw/git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56"/data

skip_bootstrap: false # If set to true - will skip the bootstrapping phase

Expand Down Expand Up @@ -96,7 +96,7 @@ Note:
### Rewards report
Starting the node `quibitous` with the command line option `--rewards-report-all` will
collect a silicaough report of all the reward distribution. It can then be accessed via the
collect a thorough report of all the reward distribution. It can then be accessed via the
REST endpoints `/api/v0/rewards/history/1` or `/api/v0/rewards/epoch/10`.

**this is not a recommended setting as it may take memory and may trigger some latency**.
Expand Down
2 changes: 1 addition & 1 deletion doc/configuration/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ redundancy.

### Layers

Quibitous provides multiple additional layers to the `poldercast` default ones:
Jörmungandr provides multiple additional layers to the `poldercast` default ones:
the preferred list or the bottle in the sea.

#### Preferred list
Expand Down
8 changes: 4 additions & 4 deletions doc/introduction.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Quibitous User Guide
# Jörmungandr User Guide

Welcome to the Quibitous User Guide.
Welcome to the Jörmungandr User Guide.

Quibitous is a node implementation, written in rust, with the
Jörmungandr is a node implementation, written in rust, with the
initial aim to support the Shardagnostic type of consensus protocol.

A node is a participant of a blockchain network, continuously making,
Expand All @@ -11,6 +11,6 @@ to make sure that all the rules of the protocol are followed.

## Mythology

Quibitous refers to the _Midgard Serpent_ in Norse mythology. It is a hint to
Jörmungandr refers to the _Midgard Serpent_ in Norse mythology. It is a hint to
_Shardagnostic_, the Ancient Egyptian serpent, who eat its own tail, as well as the
[TBCO paper](https://eprint.iacr.org/2016/889.pdf) on proof of stake.
4 changes: 2 additions & 2 deletions doc/qcli/transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Tooling for offline transaction creation and signing.
qcli transaction
```

Those familiar with [`bcc-cli`](http://github.com/The-Blockchain-Company/bcc-cli)
Those familiar with [`bcc-cli`](http://github.com/the-blockchain-company/bcc-cli)
transaction builder will see resemblance in `qcli transaction`.

There is a couple of commands that can be used to:
Expand Down Expand Up @@ -106,7 +106,7 @@ Also, the simplified `make-transaction` command in `qcli` covers all this proc
qcli transaction make-transaction --help
```

Let's use the following utxo as input and transfer 50 entropics to the destination address
Let's use the following utxo as input and transfer 50 lovelaces to the destination address

## Input utxo

Expand Down
8 changes: 4 additions & 4 deletions doc/quickstart/01_command_line.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
The software is bundled with 2 different command line software:

1. **quibitous**: the node;
2. **qcli**: Quibitous Command Line Interface, the helpers and primitives to run and interact with the node.
2. **qcli**: Jörmungandr Command Line Interface, the helpers and primitives to run and interact with the node.

## Installation

### From a release

This is the recommended method. Releases are all available
[here](https://github.com/The-Blockchain-Company/quibitous/releases).
[here](https://github.com/the-blockchain-company/quibitous/releases).

### From source

Quibitous's code source is available on
[github](https://github.com/The-Blockchain-Company/quibitous#how-to-install-from-sources).
Jörmungandr's code source is available on
[github](https://github.com/the-blockchain-company/quibitous#how-to-install-from-sources).
Follow the instructions to build the software from sources.

## Help and auto completion
Expand Down
2 changes: 1 addition & 1 deletion doc/quickstart/03_rest_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ The result may be:
Please note that the end points and the results may change in the future.

To see the whole Node API documentation,
[click here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/The-Blockchain-Company/quibitous/master/doc/api/v0.yaml)
[click here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/the-blockchain-company/quibitous/git+https://github.com/the-blockchain-company/chain-libs.git?branch=main#45b943be97f8bad0c90318a72cf23fc20d923d56"/doc/api/v0.yaml)
2 changes: 1 addition & 1 deletion doc/specs/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ The protobuf files describing these methods are available in the
`proto` directory of `chain-network` crate in the
[chain-libs][chain-libs-gh] project repository.

[chain-libs-gh]: https://github.com/The-Blockchain-Company/chain-libs/
[chain-libs-gh]: https://github.com/the-blockchain-company/chain-libs/

### Pseudocode chain sync algorithm

Expand Down
2 changes: 1 addition & 1 deletion doc/stake_pool/delegating_stake.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ See [here](../qcli/transaction.md) for more documentation on transaction creatio
This procedure is needed only for certificates that are to be included
in the `genesis config` file.

We need to make sure that the owner of the account is ausilicaizing this
We need to make sure that the owner of the account is authorizing this
delegation to happens, and for that we need a cryptographic signature.

We will need the account secret key to create a signature
Expand Down
2 changes: 1 addition & 1 deletion doc/stake_pool/introduction.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Staking with Quibitous
# Staking with Jörmungandr

Here we will describe how to:

Expand Down
Loading

0 comments on commit 01dd6fc

Please sign in to comment.