UNS Simulator

UNS.network simulation tool.

Description

Project resulting from the collaboration between Space Elephant and Polytech Nantes within the context of a transversal project.

This project concerns the modelling of the UNS blockchain with the aim of predicting the state of the blockchain in function of given parameters. The aim is to be able to model what would happen if we changed the parameters of the blockchain and thus prevent various problems and detect potential side effects.

Requirements

To run the software, you need 3 configuration files described in these files:

• Milestone.json : How to write the milestone config file
• Scenario.json: How to write a scenario file
• Network.json: How to write a network file

Usage

$ npm install -g uns-simulator
$ uns-simulator COMMAND
running command...
$ uns-simulator (-v|--version|version)
uns-simulator/1.3.2 linux-x64 node-v16.1.0
$ uns-simulator --help [COMMAND]
USAGE
  $ uns-simulator COMMAND
...

Commands

• uns-simulator autocomplete [SHELL]
• uns-simulator execute
• uns-simulator help [COMMAND]

uns-simulator autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ uns-simulator autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ uns-simulator autocomplete
  $ uns-simulator autocomplete bash
  $ uns-simulator autocomplete zsh
  $ uns-simulator autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

uns-simulator execute

Execute a scenario

USAGE
  $ uns-simulator execute

OPTIONS
  -f, --format=log|json|csv                                                 [default: log] Choose the output format
  -h, --help                                                                show CLI help
  -m, --modules=coinRepartition|delegatesStats|nodeStats|transactionsStats  Choose the modules to import
  -n, --network=network                                                     (required) The network file path
  -r, --realtime                                                            Use realtime network data
  -s, --scenario=scenario                                                   (required) The scenario file path
  -t, --milestones=milestones                                               The milestones file path
  --all-modules                                                             Import all modules

EXAMPLES
  $ uns-simulator execute -s myFirstScenario.json -n networkData.json -t milestones.json --all-modules -f json
  $ uns-simulator execute --scenario myFirstScenario.json --network networkData.json --realtime --all-modules
  $ uns-simulator execute --scenario myFirstScenario.json --network realtimeNetworkData.json networkData.json 
  --all-modules

See code: dist/commands/execute.ts

uns-simulator help [COMMAND]

display help for uns-simulator

USAGE
  $ uns-simulator help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

Contributors

Students :

• Maxence Dominici
• Étienne Lécrivain

Company contact :

• Guillaume Nicolas

School contact :

• Marc Gelgon

License

MIT © Space Elephant SAS