portfolio-rs

Minimalist toolkit for building rust applications on top of the portfolio protocol.

Installation

[Required] Foundry. Source.

If not installed, run the following:

# First install foundryup
curl -L https://foundry.paradigm.xyz | bash

# Restart terminal or reload `PATH`, then run foundryup
foundryup

Setup

# Install submodule dependencies and generate rust bindings.
./setup.sh

# Update .env with RPC url and private key
cp .env.example .env

Usage

# Run the app
cargo run -- --help

# [Optional] Install locally (breaks terminal output)
cargo install --path . --force

Recompile

If you choose a different portfolio version, or install new dependencies, make sure to recompile and bind the contracts.

# Recompile rust bindings
./compile.sh

Commands

List

Lists the available portfolio pools, including their pool id and TVL.

cargo run -- list

• list - Lists all the pools, including pool id, tokens, and estimated TVL if available.
• info - Prints a pool's state and configuration, if any.
• action - Performs an action on a pool, such as swap, add liquidity, remove liquidity, etc. [Required] Settings in portfolio.toml.