https://github.com/uxdprotocol/uxd-program
Implementation of a program that manages on chain accounts to mint and redeem Redeemables tokens (UXD), hedged by a delta neutral position on underlying DEXes.
https://github.com/uxdprotocol/uxd-program
blockchain cryptocurrency defi finance solana solana-program spl-token stablecoin
Last synced: about 1 month ago
JSON representation
Implementation of a program that manages on chain accounts to mint and redeem Redeemables tokens (UXD), hedged by a delta neutral position on underlying DEXes.
- Host: GitHub
- URL: https://github.com/uxdprotocol/uxd-program
- Owner: UXDProtocol
- License: other
- Created: 2021-06-09T15:09:54.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T01:51:39.000Z (about 1 year ago)
- Last Synced: 2024-09-18T05:34:39.914Z (about 1 year ago)
- Topics: blockchain, cryptocurrency, defi, finance, solana, solana-program, spl-token, stablecoin
- Language: Rust
- Homepage: https://uxd.fi/
- Size: 13.6 MB
- Stars: 21
- Watchers: 1
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# UXD-Program
[](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-anchor-test.yml)
[](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-cargo-lint-test.yml)
[](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-sec3-vulnerability-scanning.yml)
[](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-cargo-audit.yml)
The actual deployed state of each contract should live in a protected master branch. The latest master should always reflect the code deployed to all relevant chains
It currently sits at:
- mainnet-beta `UXD8m9cvwk4RcSxnX2HZ9VudQCEeDH6fRnB4CAP57Dr`
- devnet `BLaLouDQKDDf8T9WCgQpzxCBRtcJ4nbqv7fVQeE9PuCY` (Used by CI, this address should be update accordingly in ci files)
## Getting start
If you want to learn more about the high level concept of UXDProtocol, the [UXDProtocol Git book](https://docs.uxd.fi/uxdprotocol/) is available.
## Codebase org
The program (smart contract) is contained in `programs/uxd/`.
Its instructions are in `programs/uxd/src/instructions/`.
The project uses `Anchor` for safety, maintainability and readability.
This program contains 2 set of instructions, one permissionned and one permissionless. Permissionned instruction are called by [our DAO](https://governance.uxd.fi/dao/UXP).
Please refer to the [UXDProgram Git book](https://docs.uxd.fi/uxdprogram-solana/welcome/purpose-and-philosophy) for the program architecture.
## Interaction with UXD Client
[UXD Client](https://github.com/UXDProtocol/uxd-client) is the open source typescript client of UXD Program.
Each version of program is expected to pair with a specific version of the client, so any enhancement to the program that change the IDL must have a corresponding update on the client as well.
To run the integration test with a specific client, please specify the version of `@uxd-protocol/uxd-client` in the `package.json` file.
To test locally with local client modification, `npm link` can be used as described below:
```Zsh
# on the client directory
$> npm link
# then run cmd below on the program directory to link the locally build package instead of the fetched one
$> npm link @uxd-protocol/uxd-client
```
## Audits
The Program has been audited by Bramah Systems and Sec3.
Audit reports are available at .
## Running tests
### Rust unit tests
```Zsh
$> cargo test && cargo build-bpf && cargo test-bpf
```
### E2E Tests
Run the test :
```Zsh
$> ./scripts/reset_program_id.sh # Optional, will reset the program ID in all files where it's needed to start with a clean slate
$> anchor test # Will build, deploy and run the tests
```
If you want to re-run the tests with the already deployed program (without registering changes to the rust code), you can run :
```Zsh
$> anchor test --skip-build --skip-deploy
```
If you made changes to the Rust code, you have to re-run the lengthy :
```Zsh
$> anchor test
```
Loop theses as many time as you want, and if you want a clean slate, just reset the program_id with the script (`./script/reset_program_id.sh`).
## Testing strategy with CI
Four workflow would be kick started for PR branches merging to `main`.
### Anchor test - ci-anchor-test.yml
E2E test.
There are a few script in the test folder with following the `test_ci_*.ts`, these are related to the github workflow.
The CI strategy for E2E :
- use the ci-resident-program (call ./scripts/swap_ci_resident_program.sh)
- use it's upgrade authority stored in `target/deploy/ci-resident-upgrade-authority.json` for deployment
- upgrade program
- start `test_ci_setup.ts`, to setup controller and all depositories on the resident program, no mint/redeem testing is involved on this test suite, global settings like supply cap and insurance fund should be tested here.
- then starts test suites in series for each depositories.
- here is the job dependencies
Note that it don't do concurrent run of this workflow, as they test some internal state of the program and would collide.
### Cargo audit test - ci-cargo-audit.yml
Crates security vulnerability checking [tool](https://github.com/RustSec/rustsec/tree/main/cargo-audit), by RustSec.
### Cargo lint test - ci-lint-test.yml
Runs cargo fmt, clippy, test and test-bpf.
### Sec3 vulnerabilty scanning test - ci-sec3-vulnerability-scanning.yml
Solana smart contract vulnerability scanning [tool](https://github.com/silas-x/soteria-action), by Sec3.
## Branches and Tags
Branch off from `develop` for new development changes. Pull requests should always target to `develop` as well.
The program binary should be built from `develop` and merged to `main` after successful deployment and tagged with the version name as `v*.*.*`.
Check the [Releases](https://github.com/UXDProtocol/uxd-program/releases) for previous deployed program on mainnet.
## Deployment and Program Upgrades
By default the program builds with the `development` feature, and the ProgramID for devnet.
Building for mainnet uses `anchor build -- --no-default-features --features production`
The program upgrade are done through our [DAO](https://governance.uxd.fi/dao/UXP).
It required to build for release then to prepare a buffer with :
```Zsh
$> solana program write-buffer ./target/deploy/uxd.so
# anchor verify -p uxd //TODO
$> solana program set-buffer-authority --new-buffer-authority CzZySsi1dRHMitTtNe2P12w3ja2XmfcGgqJBS8ytBhhY
```
## Licensing
The license for UXD Program is the Business Source License 1.1 (`BUSL-1.1`), see [`LICENSE`](./LICENSE).