PROTO-178: Single extension program with compile flags (ScaledUI + No Yield)

.github/setup/action.yaml

@@ -1,20 +1,20 @@
 name: setup
-description: 'Installing tooling and dependencies for running tests'
+description: "Installing tooling and dependencies for running tests"
 inputs:
   node-version:
-    description: 'Node.js version'
+    description: "Node.js version"
     required: false
-    default: '22'
+    default: "22"
   solana-version:
-    description: 'Solana version'
+    description: "Solana version"
     required: false
-    default: '2.1.0'
+    default: "2.1.0"
   anchor-version:
-    description: 'Anchor CLI version'
+    description: "Anchor CLI version"
     required: false
-    default: '0.31.1'
+    default: "0.31.1"
 runs:
-  using: 'composite'
+  using: "composite"
   steps:
     - name: Setup Node
       uses: actions/setup-node@v4
@@ -61,5 +61,5 @@ runs:
       shell: bash
 
     - name: Build programs
-      run: anchor build
-      shell: bash
+      run: make build-programs
+      shell: bash

.github/workflows/anchor.yaml

@@ -15,8 +15,8 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  scaled-ui-ext-tests:
-    runs-on: macos-latest 
+  program-tests:
+    runs-on: macos-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -25,5 +25,5 @@ jobs:
         uses: ./.github/setup
 
       - name: Run tests
-        run: yarn run jest --preset ts-jest --verbose tests/unit/scaled_ui_ext.test.ts
-        shell: bash
+        run: yarn test
+        shell: bash

Anchor.toml

@@ -8,7 +8,8 @@ seeds = false
 skip-lint = false
 
 [programs.localnet]
-scaled_ui_ext = "3C865D264L4NkAm78zfnDzQJJvXuU3fMjRUvRxyPi5da"
+m_ext = "3C865D264L4NkAm78zfnDzQJJvXuU3fMjRUvRxyPi5da"
+ext_swap = "MSwapi3WhNKMUGm9YrxGhypgUEt7wYQH3ZgG32XoWzH"
 
 [registry]
 url = "https://api.apr.dev"

Cargo.toml

@@ -17,8 +17,7 @@ codegen-units = 1
 anchor-lang = "0.31.1"
 anchor-spl = "0.31.1"
 spl-token-2022 = { version = "7.0.0", features = ["no-entrypoint"] }
-solana-program = "=2.1.0"
 solana-security-txt = "1.1.1"
 cfg-if = "1.0"
-earn = { git = "https://github.com/m0-foundation/solana-m", branch = "solana-2.1.0", features = ["no-entrypoint"] }
+earn = { git = "https://github.com/m0-foundation/solana-m", branch = "develop", features = ["no-entrypoint"] }
 

Makefile

@@ -0,0 +1,34 @@
+build-programs:
+	anchor build -p ext_swap
+	anchor build -p m_ext -- --features scaled-ui --no-default-features
+	@mv target/deploy/m_ext.so target/deploy/scaled_ui.so
+	@mv target/idl/m_ext.json target/idl/scaled_ui.json
+	@mv target/types/m_ext.ts target/types/scaled_ui.ts
+	anchor build -p m_ext -- --features no-yield --no-default-features
+	@cp target/deploy/m_ext.so target/deploy/no_yield.so
+	@cp target/idl/m_ext.json target/idl/no_yield.json
+	@cp target/types/m_ext.ts target/types/no_yield.ts
+
+test-programs:
+	@yarn run jest --preset ts-jest --verbose tests/unit/**.test.ts
+	@cargo test
+
+define update-program-id
+	@sed -i '' 's/declare_id!("[^"]*")/declare_id!("$(1)")/' programs/m_ext/src/lib.rs
+endef
+
+build-test-programs:
+	$(call update-program-id,3joDhmLtHLrSBGfeAe1xQiv3gjikes3x8S4N3o6Ld8zB)
+	anchor build -p m_ext
+	@mv target/deploy/m_ext.so tests/programs/ext_a.so
+	$(call update-program-id,HSMnbWEkB7sEQAGSzBPeACNUCXC9FgNeeESLnHtKfoy3)
+	anchor build -p m_ext 
+	@mv target/deploy/m_ext.so tests/programs/ext_b.so
+	$(call update-program-id,81gYpXqg8ZT9gdkFSe35eqiitqBWqVfYwDwVfXuk8Xfw)
+	sed -i '' '/pub ext_token_program: Program<'\''info, Token2022>,/a\'$$'\n''\ pub dummy_account: Program<'\''info, Token2022>,' programs/m_ext/src/instructions/wrap.rs
+	cargo fmt
+	anchor build -p m_ext --skip-lint
+	@mv target/deploy/m_ext.so tests/programs/ext_c.so
+	sed -i '' '/pub dummy_account: Program<'\''info, Token2022>,/d' programs/m_ext/src/instructions/wrap.rs
+	$(call update-program-id,3C865D264L4NkAm78zfnDzQJJvXuU3fMjRUvRxyPi5da)
+	anchor build -p m_ext

README.md

@@ -1,11 +1,16 @@
 # Solana M Extension Programs
-The programs in this repository implement different version of an "M Extension", which is a stablecoin backed by M.
+
+The program (`m_ext`) in this repository implements different versions of an "M Extension", which is a stablecoin backed by $M. The versions have a shared codebase for the majority of the code and use Rust feature flags to implement version-specific logic. The program relies on the underlying yield distribution of the $M token on Solana, which can be found in the [solana-m repository](https://github.com/m0-foundation/solana-m).
 
 ## Extensions
+
 The list of implemented extensions is:
+
+- NoYield - no yield is distributed to extension holders.
 - ScaledUiAmount - yield is distributed to all extension token holders using the Token2022 ScaledUiAmount "rebasing" functionality.
 
 ## Development
+
 The Solana programs in this repository are built using Anchor. The required toolchain is specified in the Anchor.toml file.
 
 Use [`agave-install`](https://docs.anza.xyz/cli/install) to install and initialize the correct Solana CLI & runtime (`2.1.0`).
@@ -14,6 +19,6 @@ Then, use [`avm`](https://www.anchor-lang.com/docs/installation) to install and
 
 Finally, the tests are written in Typescript using the LiteSVM framework. The javascript package manager is `yarn`. Install the required dependencies with `yarn install`.
 
-The programs can then be built with: `anchor build`
+The programs can then be built with: `make build-programs`. This will compile each variant of the `m_ext` program and save the bytecode plus the IDL in the target folder with the name of the extension. Yield features are not compatible with each other and only one can be selected.
 
-The tests can be run with `yarn test`. If editing programs between test runs, be sure to recompile as the test runner doesn't do so automatically, i.e. `anchor build && yarn test`.
+The tests can be run with `make test-programs`. If editing programs between test runs, be sure to recompile as the test runner doesn't do so automatically, i.e. `make build-programs && make test-programs`.

package.json

@@ -1,29 +1,29 @@
 {
-    "scripts": {
-        "lint:fix": "prettier */*.js \"*/**/*{.js,.ts}\" -w",
-        "lint": "prettier */*.js \"*/**/*{.js,.ts}\" --check",
-        "test": "yarn run jest --preset ts-jest --verbose",
-        "build": "anchor build"
-    },
-    "dependencies": {
-        "@coral-xyz/anchor": "^0.31.1",
-        "@m0-foundation/solana-m-sdk": "https://gitpkg.vercel.app/m0-foundation/solana-m/sdk?0991eb829a52f6ba5969fd47d3100ef6871f0a6d&scripts.postinstall=yarn%20build",
-        "@solana-developers/helpers": "^2.7.0",
-        "@solana/spl-token": "^0.4.13",
-        "@solana/web3.js": "^1.98",
-        "anchor-litesvm": "0.1.2",
-        "bn.js": "^5.2.1",
-        "litesvm": "0.2.0"
-    },
-    "devDependencies": {
-        "@types/bn.js": "^5.1.0",
-        "@types/jest": "^29.0.3",
-        "@types/node": "^22.13.13",
-        "jest": "^29.0.3",
-        "nock": "^14.0.2",
-        "prettier": "^2.6.2",
-        "ts-jest": "^29.0.2",
-        "ts-node": "^10.9.2",
-        "typescript": "5"
-    }
+  "scripts": {
+    "lint:fix": "prettier */*.js \"*/**/*{.js,.ts}\" -w",
+    "lint": "prettier */*.js \"*/**/*{.js,.ts}\" --check",
+    "test": "make test-programs",
+    "build": "make build-programs"
+  },
+  "dependencies": {
+    "@coral-xyz/anchor": "^0.31.1",
+    "@m0-foundation/solana-m-sdk": "https://gitpkg.vercel.app/m0-foundation/solana-m/sdk?0991eb829a52f6ba5969fd47d3100ef6871f0a6d&scripts.postinstall=yarn%20build",
+    "@solana-developers/helpers": "^2.7.0",
+    "@solana/spl-token": "^0.4.13",
+    "@solana/web3.js": "^1.98",
+    "anchor-litesvm": "0.1.2",
+    "bn.js": "^5.2.1",
+    "litesvm": "0.2.0"
+  },
+  "devDependencies": {
+    "@types/bn.js": "^5.1.0",
+    "@types/jest": "^29.0.3",
+    "@types/node": "^22.13.13",
+    "jest": "^29.0.3",
+    "nock": "^14.0.2",
+    "prettier": "^2.6.2",
+    "ts-jest": "^29.0.2",
+    "ts-node": "^10.9.2",
+    "typescript": "5"
+  }
 }

programs/scaled_ui_ext/Cargo.toml → programs/ext_swap/Cargo.toml

@@ -1,26 +1,25 @@
 [package]
-name = "scaled_ui_ext"
+name = "ext_swap"
 version = "0.1.0"
 description = "Created with Anchor"
 edition = "2021"
 
 [lib]
 crate-type = ["cdylib", "lib"]
-name = "scaled_ui_ext"
+name = "ext_swap"
 
 [features]
+default = []
+cpi = ["no-entrypoint"]
 no-entrypoint = []
 no-idl = []
 no-log-ix-name = []
-cpi = ["no-entrypoint"]
-default = []
 idl-build = ["anchor-lang/idl-build", "anchor-spl/idl-build"]
 
+
 [dependencies]
 anchor-lang.workspace = true
 anchor-spl.workspace = true
-spl-token-2022.workspace = true
-cfg-if.workspace = true
-solana-security-txt.workspace = true
-solana-program.workspace = true
 earn.workspace = true
+solana-security-txt.workspace = true
+m_ext = {path = "../m_ext", features = ["cpi"]}

programs/ext_swap/src/errors.rs

@@ -0,0 +1,13 @@
+use anchor_lang::prelude::*;
+
+#[error_code]
+pub enum SwapError {
+    #[msg("Extension is not whitelisted")]
+    InvalidExtension,
+    #[msg("Extension is already whitelisted")]
+    AlreadyWhitelisted,
+    #[msg("Index invalid for length of the array")]
+    InvalidIndex,
+    #[msg("Signer is not whitelisted")]
+    UnauthorizedUnwrapper,
+}

programs/ext_swap/src/instructions/initialize.rs

@@ -0,0 +1,34 @@
+use anchor_lang::prelude::*;
+
+use crate::state::{SwapGlobal, GLOBAL_SEED};
+
+#[derive(Accounts)]
+pub struct InitializeGlobal<'info> {
+    #[account(mut)]
+    pub admin: Signer<'info>,
+
+    #[account(
+        init,
+        payer = admin,
+        space = SwapGlobal::size(0,0),
+        seeds = [GLOBAL_SEED],
+        bump,
+    )]
+    pub swap_global: Account<'info, SwapGlobal>,
+
+    pub system_program: Program<'info, System>,
+}
+
+impl InitializeGlobal<'_> {
+    pub fn handler(ctx: Context<Self>, m_mint: Pubkey) -> Result<()> {
+        ctx.accounts.swap_global.set_inner(SwapGlobal {
+            bump: ctx.bumps.swap_global,
+            admin: ctx.accounts.admin.key(),
+            m_mint: m_mint,
+            whitelisted_unwrappers: vec![],
+            whitelisted_extensions: vec![],
+        });
+
+        Ok(())
+    }
+}

programs/ext_swap/src/instructions/mod.rs

@@ -0,0 +1,11 @@
+pub mod initialize;
+pub mod swap;
+pub mod unwrap;
+pub mod whitelist;
+pub mod wrap;
+
+pub use initialize::*;
+pub use swap::*;
+pub use unwrap::*;
+pub use whitelist::*;
+pub use wrap::*;