portfolio-management-platform

Setup

Install dependencies:

npm install

Create account on Moralis and create new app. You will need to get MORALIS_API_KEY from there.

Create account on Ngrok and install it.

# macOS
brew install ngrok/ngrok/ngrok

# Linux
curl -s https://ngrok-agent.s3.amazonaws.com/ngrok.asc | sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null && echo "deb https://ngrok-agent.s3.amazonaws.com buster main" | sudo tee /etc/apt/sources.list.d/ngrok.list && sudo apt update && sudo apt install ngrok

Next step requires to add authtoken via ngrok configuration (you can find it on your account):

ngrok config add-authtoken <token>

Now start ngrok and get https webhook url from there for NGROK_WEBHOOK_URL (you'll need to have it running during app operating).

npm run ngrok

Create .env (public values, used by client) and .env.local (secret values, used by API) files in root directory with templates below and fill all missing values (ask core team for values):

# .env file

PUBLIC_PROJECT_ID=
PUBLIC_METADATA_NAME=emeth
PUBLIC_METADATA_DESCRIPTION=emeth
PUBLIC_EMETH_CONTRACT_ADDRESS=0x075FbeB3802AfdCDe6DDEB1d807E4805ed719eca
PUBLIC_EMETH_CONTRACT_ADDRESS_SEPOLIA=0xfC11321e66Cb526c4a9c14295Fff03FC3FC637F2

PW_BASE_URL=http://localhost:5173

# .env.local file

SURREALDB_URL=
SURREALDB_USER=
SURREALDB_PASS=
SURREALDB_NS=
SURREALDB_DB=

ACCESS_TOKEN_SECRET=
REFRESH_TOKEN_SECRET=

UNISWAP_SUBGRAPH_URL=https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3
UNIV3_OPTIMIST_SUBGRAPH_URL=https://api.thegraph.com/subgraphs/name/graph-buildersdao/univ3-optimism

# Generated from your personal account.
MORALIS_API_KEY=
# Every time you run `npm run ngrok`, it will generated new one url,
# so you need to update it here accordingly.
NGROK_WEBHOOK_URL=https://1111-11-111-11-111.ngrok-free.app/webhook/
# Get static domain from ngrok website and paste it here - should look alike `weak-horse-badly.ngrok-free.app`
NGROK_STATIC_DOMAIN=

PUBLIC_EMETH_CONTRACT_ADDRESS=
PUBLIC_EMETH_CONTRACT_ADDRESS_SEPOLIA=

Install podman:

# macOS
brew install podman

# Linux
sudo apt-get update
sudo apt-get -y install podman

Install surreal:

# macOS
brew install surrealdb/tap/surreal

# Linux
curl -sSf https://install.surrealdb.com | sh

Generate ssl cert and key:

openssl req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout ssl/private.pem -out ssl/certificate.pem

Run

Firstly, you need to run database:

./scripts/database-setup.sh

After that, you need to provision db:

./scripts/database-provision.sh

Run ngrok tunnel (and copy https url to .env.local into NGROK_WEBHOOK_URL):

npm run ngrok

Last step is run the app (in dev mode):

npm run dev

Build & serve

Firstly, run ngrok tunnel (and copy https url to .env.local into NGROK_WEBHOOK_URL):

npm run ngrok

Export all variables from .env and .env.local files to your shell.

Start database and provision it with data (as above) - production build require database up and running.

Build production mode:

npm run build

Serve production mode:

npm run serve

Test

Setup

You need to install extra dependencies (like browser drivers):

npm run test.e2e.setup

Run

Verify e2e environment variables (starting with PW_ prefix) in .env and .env.local files. Check on what destination tests will be run against (PW_BASE_URL). In case of running against local environment, you need to run the whole local setup before (as above).

Run e2e scenarios:

npm run test.e2e

After every run you can serve report to your browser:

npm run test.e2e.report

For debugging purposes, you can run UI version:

npm run test.e2e.ui

Wallet

Development setup

You need to install Metamask extension in your browser and create dev wallet account. After that, please add Sepolia from test networks.

As a next step, import created tokens from fixtures/tokens.surql file:

0x054E1324CF61fe915cca47C48625C07400F1B587 # GLM
0xD418937d10c9CeC9d20736b2701E506867fFD85f # USDC
0x9D16475f4d36dD8FC5fE41F74c9F44c7EcCd0709 # USDT

After that, please add second rich wallet account to your Metamask wallet (ask one of the core members to get private key).

As next step, you need to install SubWallet extension in your browser and create new wallet account.

Please select EVM network account, turn off all enabled networks and turn on Sepolia network.