Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GalaxySciTech committed Sep 21, 2024
1 parent afe096a commit 2f342a4
Showing 1 changed file with 55 additions and 3 deletions.
58 changes: 55 additions & 3 deletions contracts/validator/contract_v2/migrate/test/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,59 @@
set RPC_URL and PRIVETE_KEY in .env
Here's a `README.md` file that outlines the steps you've provided:

PRIVETE_KEY pls use masternode privatekey
```markdown
# Project Setup and Testing

run node scripts/testMainWorkFlow.js
This repository contains scripts for testing various workflows in a development environment. The steps below will guide you through setting up the environment, installing dependencies, and running tests.

## Prerequisites

- **Node.js**: Ensure that you have Node.js version 20 installed.
- **Yarn**: Yarn is used for managing dependencies.

## Environment Setup

1. **Create a `.env` file** in the root of your project directory. This file will contain the following environment variables:

```env
RPC_URL=<Your Devnet RPC URL>
M1_PRIVETE_KEY=<Masternode 1 Private Key>
M2_PRIVETE_KEY=<Masternode 2 Private Key>
M3_PRIVETE_KEY=<Masternode 3 Private Key>
M4_PRIVETE_KEY=<Masternode 4 Private Key>
M5_PRIVETE_KEY=<Masternode 5 Private Key>
```

Replace the placeholders with the appropriate values.

## Installation

1. **Install dependencies** by running the following command:

```bash
yarn
```

This will install all the required packages for the project.

## Running Tests

### Test Main Workflow

To test the main workflow, execute the following command:

```bash
node scripts/testMainWorkFlow.js
```

### Test KYC Invalid Flow

To test the KYC invalid flow, execute the following command:

```bash
node scripts/testKycInvalidFlow.js
```

## Notes

- Ensure that the `.env` file is correctly configured with the required RPC URL and masternode private keys before running the tests.
- If any issues arise during the testing process, double-check the environment variables and dependency installation.

0 comments on commit 2f342a4

Please sign in to comment.