Skip to content

Commit

Permalink
Up version
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelmanzanera committed Oct 3, 2022
1 parent 3ce43b5 commit f7b9873
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 8 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Welcome to the Archethic Node source repository ! This software enables you to build the first transaction chain and next generation of blockchain focused on scalability and human oriented.

Archethic features:

- Fast transaction processing (> 1M tps)
- Lower energy consumption than other blockchain
- Designed with a high level of security (ARCH consensus supporting 90% of maliciousness)
Expand All @@ -20,6 +21,7 @@ We are focusing on the best quality.
The source code can change to respect the best quality of reading and regarding best practices.

Current implemented features:

- Adaptive cryptography: different elliptic curves and software implementation
- TransactionChain: Transaction structure and transaction generation
- Smart Contract: interpreter coded with Elixir DSL through Meta-programming and AST
Expand All @@ -30,7 +32,7 @@ Current implemented features:
- Beacon chain: Track new transactions and node readiness
- Self-Repair: Self-healing mechanism allowing to resynchronize missing transactions
- Node shared secrets renewal: Integration of authorized validation nodes using heuristic constraints
- P2P transfers
- P2P transfers
- Transaction explorer
- Custom Binary protocol leveraging Binary Pattern Matching and BitVectors
- NFT creation and transfers
Expand All @@ -40,50 +42,61 @@ Current implemented features:
## Development Roadmap

### Short term

These are the features will be implemented very soon (already in the pipe of the core team)
- Yubikey integration for node enrollment and key management

- Programmable money: Provide code & condition inside an UTXO to be executed when it's consumed
- Smart Contract fee model
- Provide exception on the smart contract inherit constraints
- Network coordinates aggregation from the BeaconChain

### Mid-Long term:

These are the feature which will be implemented after the short term roadmap but which are important:

- OnChain Governance & Decentralized Code Source and Hot Release Upgrades
- SGX integration for enclaving the node shared secrets
- Smart Contract Builder / Generator
- Smart UTXO: Provide code inside an UTXO to be executed when it's consumed
- Network coordinates aggregation from the BeaconChain
- On-chain time management through BeaconChain to ensure clock synchronisation
- Yubikey integration for node enrollment and key management

## Installation

Requirements:
- Libsodium: for the ed25519 to Curve25519 conversion

- Libsodium: for the ed25519 to Curve25519 conversion
- OpenSSL 1.11
- Erlang OTP 24
- Elixir 1.12
- GMP (https://gmplib.org/)

Platforms supported:

- Linux (Ubuntu 18.04)
- Mac OS X

## Development

At first, get dependencies:

```bash
mix deps.get
```

Install the static assets

```
cd assets ; npm install; cd -
```

To start a single node:

```bash
iex -S mix
```

To clean the data

```bash
make clean
```
Expand All @@ -95,38 +108,42 @@ To start multiple nodes, you can leverage: `docker-compose`
Requires working `docker-compose`

Build the image:

```bash
docker build -t archethic-node .
```

To start testnet:

```bash
docker-compose up
```

To run benchmarks:

```bash
docker-compose up bench
```

To run the playbooks to validate non regression:

```bash
docker-compose up validate
```

## Contribution

Thank you for considering to help out with the source code.
Thank you for considering to help out with the source code.
We welcome contributions from anyone and are grateful for even the smallest of improvement.

Please to follow this workflow:

1. Fork it!
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request


## Licence

AGPL
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ defmodule Archethic.MixProject do
def project do
[
app: :archethic,
version: "0.23.1",
version: "0.24.0",
build_path: "_build",
config_path: "config/config.exs",
deps_path: "deps",
Expand Down

0 comments on commit f7b9873

Please sign in to comment.