Skip to content

DEVELOPER_SETUP.md

Latest commit

 

History

History
108 lines (69 loc) · 3.08 KB

DEVELOPER_SETUP.md

File metadata and controls

108 lines (69 loc) · 3.08 KB

Developer setup

See architecture overview https://docs.rpch.net/docs/tutorial-basics/Architecture-overview

The following step orchestrates all the components (except for entry & exit nodes) locally and use the remote entry and exit nodes.

Running RPCh locally

Build locally

Ensure that node v18 is used

nvm use 18

Run Postgres database for the “discovery platform”

  1. Install Postgres

    docker run --name postgres -e POSTGRES_HOST_AUTH_METHOD=trust -p 5432:5432 -d postgres

  2. Verify Connect to the postgres server and create a database of name "gnosisvpnjs"

    createdb -U postgres -h 127.0.0.1 gnosisvpnjs

Start the discovery platform

cd apps/discovery-platform/; DEBUG=rpch:discovery-platform:* ADMIN_SECRET=topsecret PORT=3020 URL="http://127.0.0.1:3020" PGHOST=localhost PGPORT=5432 PGDATABASE=gnosisvpnjs PGUSER=postgres PGPASSWORD=postgres yarn start

Populate table with remote entry and exit nodes

  1. Download the sql file that contains metadata of entry and exits nodes to NODES_SQL_FILEPATH and run in a new terminal tab

    export NODES_SQL_FILEPATH=~/Downloads/rpch-test/nodes.sql

  2. Populate the database with the downloaded file.

    psql -U postgres -h 127.0.0.1 -d gnosisvpnjs < $NODES_SQL_FILEPATH

    This command should return COPY 25

  3. Check that the registered_nodes table has been populated as expected. . Connect to the database, then run commands in postgres

    psql -U postgres -h 127.0.0.1 -d gnosisvpnjs

    1. List all the tables. 20+ rows should be returned.

      \d

    2. Check 25 entries are in the registered_nodes table

      select * from registered_nodes ;

    3. Check 0 pairing between entry and exit nodes

      select * from zero_hop_pairings ;

  4. In the same session, populate user in the db

    select * from users ;
insert into users (id, name) values (gen_random_uuid(), 'loadtest');
insert into clients (id, user_id, external_token) values (gen_random_uuid(), (select id from users), 'loadtesting-secret');
select * from clients ;

  5. Now there should be 150 pairing between entry and exit nodes

    select * from zero_hop_pairings ;

Start the availability monitor

In a new terminal tab, run

cd apps/availability-monitor/; DEBUG=rpch:availability-monitor:* PORT=9080 PGHOST=localhost PGPORT=5432 PGDATABASE=gnosisvpnjs PGUSER=postgres PGPASSWORD=postgres yarn start

Run RPC server

In a new terminal tab, run

cd apps/rpc-server/; DEBUG=* FORCE_ZERO_HOP=true PORT=45740 DISCOVERY_PLATFORM_API_ENDPOINT="http://127.0.0.1:3020" CLIENT=loadtesting-secret DATABASE_URL=postgres://postgres:postgres@127.0.0.1:5432/rpch_dp yarn start | tee ~/Downloads/rpch-test/test.log