cryptosat / cryptosim-tutorial

Tutorial for using the Cryptosim simulator

Cryptosat Tutorial

This repository contains the code for a tutorial demonstrating how to use the Cryptosat API.

Development

Enforcing Node.js and npm versions

To ensure that all developers working on the project use compatible versions of Node.js and npm, check the engines field of your package.json file. This field specifies the minimum required version of Node.js and npm.

to require Node.js version 16.0.0 or later and npm version 8.0.0 or later.

Installation

Before installing the dependencies, please ask for the fontawesome registry and authToken

To install the project dependencies first run:

yarn install

Testing

cd in to the project directory and run:

yarn start

to runs the app in development mode. Open http://localhost:3000 to view it in the browser.

Deployment

To compile the app run:

yarn build

This will create a directory called build in the project which can be served statically over the web. Once the command terminates you can run

yarn global add serve
serve -s build

To view it in a browser.

VIRTUAL ENVIRONMENT

Steps you can follow to create a build environment and build cryptosim:

Install a Linux virtual machine on your computer. You can use VirtualBox or VMware to do this.

Install the latest version of Node.js (currently version 16.19) on the virtual machine. You can download it from the official Node.js website: https://nodejs.org/en/download/

Clone the cryptosim-tutorial repository to your virtual machine using the following command:

git clone https://github.com/cryptosim/tutorial.git Navigate to the tutorial directory using the following command:

    cd tutorial

If you run into a memory error while building, you can try increasing the memory limit for Node.js. You can do this by setting the NODE_OPTIONS environment variable to --max_old_space_size= before running the yarn build command. For example, to set the memory limit to 4GB, you can use the following command:

    NODE_OPTIONS=--max_old_space_size=4096 yarn build

cryptosim-tutorial's Issues

[UI] Selection reorganization

https://cryptosat.monday.com/boards/3903055708/pulses/4929894528

Signature verification fails on the last step of the Signatures tutorial

Signature verification fails at the last step of the Signatures tutorial:
https://simulator.cryptosat.io/#/cryptosat-api/signature

[UI] Automatic resizing of columns

https://cryptosat.monday.com/boards/3903055708/pulses/4929909033

Incorporate Design Changes (from UX Review)

Change "Signature" tutorial title to "Signatures" or "Signing"

Move the terminal frame to the right and the tutorial text to the left.

[python console] Timestamp tutorial provides no output to user

https://sandbox.cryptosat.io/#/cryptosat-api/timestamp

Behavior:
When copy pasting the commands from tutorial to console, there is no output or feedback presented to user

Expected:
The user should understand:

1. What is being consumed (the time stamp)
2. That the signature verification was successful.
   The tutorial should print out the timestamp, and print out "True" after the "verify" function.

I believe this could be achieved either by tweaking the tutorial, or the sdk.

Timestamp page sample report error

When running

key = cryptosat.getPublicSigningKey();
timestamp = binary.int2ab(result.timestamp);
nacl.sign.detached.verify(timestamp, result.signature, key);

It shows:

ReferenceError { "binary is not defined" }

Fix private ballot finalize

https://cryptosat.monday.com/boards/3903055708/pulses/4929859115

[python console] entering a variable name does not print content like regular python console

Behavior:
entering a variable that exists into the terminal returns no content.
Expected:
Once a variable name is entered, it's should be printed as output. strings, ints, dicts, and lists should be presented. Other objects can define how they are presented.

This is a problem because it could look like a malfunction, and correct usage requires unintuitive patterns like (print(type(result)) )

Consistent encryption key formating

https://cryptosat.monday.com/boards/3903055708/pulses/4929865525

[python console] Arrow keys have unexpected behavior

Behavior:
2 presses on the up button are required to show previous command. Cursor is then placed at the beginning of the command line.

Expected Behavior:
1 press on Up button to show the previous command. Subsequent presses go back through the history. Cursor is at the end of the line

Light UI

[UI] Mobile View

https://cryptosat.monday.com/boards/3903055708/pulses/4929951132

Overview text should say "how to use Cryptosat APIs"

The Overview text says:
This tutorial will teach you how to use cryptosim - the cryptosat simulator.
It should instead say
This tutorial will teach you how to use Cryptosat APIs.