protocol-v2

(β˜… 406)

On-chain perpetuals dex with multiple liquidity mechanisms

  • .coderabbit.yaml
  • .eslintrc.js
  • .gitignore
  • .gitmodules
  • .prettierignore
  • .prettierrc.js
  • .verified-build.json
  • Anchor.toml
  • AUDIT.md
  • bun.lock
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • codecov.yml
  • LICENSE
  • package.json
  • README.md
  • SECURITY.md
  • tsconfig.json
  • typedoc.json
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/velocity-exchange/protocol-v2

Downloads the entire project code from GitHub to your computer.

cd protocol-v2

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
yarn

Downloads and installs the libraries listed in package.json.

cd sdk/ && yarn && yarn build && cd ..

Moves into the project folder you just downloaded.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

3. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo test

Type this command into your terminal and run it.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation