qPools-contract

This githubs consists of two modules:

qpools-sdk

This is the typescript library that interfaces with the Solana program, written in typescript. You can find more information here

solbond

This is the "smart-contract" / Solana program written in Rust. You can find more information here

Serpius Endpoint

The Serpius Endpoint currently is on version v4.0.0. The file-structure it should delpoy looks like the following.

{
  "network": mainnet | devnet,
  "allocations": [
    {
      "inputToken": {
        "address": PublicKey,  // this is the token mint
        "decimals": number,
        "logoURI": string,
        "name": string,
        "symbol": string
      }, 
      "assets": [
        {
          id: string,
          weight: number,
          protocol: marinade | solend | saber,
          apy_24h: number
        }, 
        ...
      ]
    },
    ...
  ]  
}

One specific example of what the API could return looks as follows:

{
  "network": "mainnet",
  "allocations": [
    {
      "inputToken": {
        "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
        "decimals": 6,
        "logoURI": "https://spl-token-icons.static-assets.ship.capital/icons/101/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v.png",
        "name": "USD Coin",
        "symbol": "USDC"
      }, 
      "assets": [
        {
          "lp": "USDC",
          "weight": 1000,
          "protocol": "solend",
          "apy_24h": 5.65
        },
        {
          "lp": "USDCpo-USDC",
          "weight": 0,
          "protocol": "saber",
          "apy_24h": 5.59
        },
        ...
      ]
    },
    ...
  ]  
}

Github Actions

.github/workflows/publish-sdk.yml includes all the logic on what runs when you trigger a github action. A github action is triggered when pushed to one of the specified branches starting from line 4 of that document (i.e. the main branch is one of them). It then installs Anchor, it installs Solana, compiles the typescript files, and uploads everything into a the npm package (as specified in the qpools-sdk README).

You can see a list of all actions that are run here.

TODO: Move these into the Solbond Folder

Setup instructions

(1) Building and Testing

run anchor build from make sure that you're in qPools-contract/solbond

anchor build

from the same directory run

npm run test:qPools

Debugging:

• "clean-install-npm-packages.sh" installs the dependencies
• Make sure the IDL generated by solbond is equivalent to the IDL saved within the SDK
• Make sure that your solana config is on devnet/localnet
• Make sure your anchor toml is on devnet/localnet

---

(2) Analyze wit Soteria Compiler

docker run -v $PWD/qPools-contract/solbond/:/workspace -it greencorelab/soteria:latest /bin/bash

cargo build-bpf
cd programs/solbond
soteria -analyzeAll .

(2) Setup the Anchor.toml

Create an Anchor.toml inside the solbond folder. Then, paste the following contents in. Make sure to replace all addresses with your respective, local (or devnet) addresses.

[provider]
cluster = "localnet"
wallet = "~/.config/solana/id.json"

[programs.localnet]
solbond = "Bqv9hG1f9e3V4w5BfQu6Sqf2Su8dH8Y7ZJcy7XyZyk4A"
amm = { address = "3f2yCuof5e1MpAC8RNgWVnQuSHpDjUHPGds6jQ1tRphY", idl = "./deps/invariant/target/idl/amm.json" }
staker = { address = "8uGzHXsuncH8aD9RFBYTHpV2eG3nD48FV1eyyghLDtfn", idl = "./deps/invariant/target/idl/staker.json" }

[registry]
url = "https://anchor.projectserum.com"

[[test.genesis]]
address = "3f2yCuof5e1MpAC8RNgWVnQuSHpDjUHPGds6jQ1tRphY"
program = "./deps/invariant/target/deploy/amm.so"

[[test.genesis]]
address = "8uGzHXsuncH8aD9RFBYTHpV2eG3nD48FV1eyyghLDtfn"
program = "./deps/invariant/target/deploy/staker.so"

[scripts]
#test = "/usr/local/bin/node /usr/local/bin/mocha -t 1000000 --require ts-node/register tests/**/*.ts"
test = "/usr/local/bin/node /usr/local/bin/mocha -t 1000000 --require ts-node/register tests/**/solbond-initialize-invariant-pools.ts"

(3) Build and integrate the Invariant Programs (AMM and Staker)

You must get the lib.rs from a previous commit and then run anchor build. David will write instructions if you ping him. Please do if you need this. And please add more instructions on how to use it if you know more haha, or if you find stuff unclear.

(4) Update Addresses

Go inside the following folder, and add the AMM program-address (which you received once you ran anchor build).

• solbond/deps/invariant/sdk/src/network.ts

(5) Deploy the contract

Deploy the contract to devnet

anchor deploy

Now you can initialize the first reserve pool

ANCHOR_WALLET=/Users/davidal/.config/solana/id.json npx ts-node scripts/deploy-qpool-reserve.ts

ANCHOR_WALLET=/Users/davidal/.config/solana/id.json npm run test:solbond-only
ANCHOR_WALLET=/Users/davidal/.config/solana/id.json npm run test:solbondinvariant-only-localnet

Debugging:

• Make sure the IDL generated by solbond is equivalent to the IDL saved within the SDK
• Make sure that your solana config is on devnet/localnet
• Make sure your anchor toml is on devnet/localnet

---

At least one portfolio assignment has to have been done

---

Before running the cranks, or deploy pools, make sure you build and deployed your smart contract ...

---

Whenever an address changes, there's three places where it needs to be changed:

lib.rs
solbond-program.ts
Anchor.toml