Skip to content

Commit

Permalink
update README (#291)
Browse files Browse the repository at this point in the history
* [Update] Updating tests to credix 0.7.5 update (#279)

* branches update

* [Router] Make all mint/redeem IXs permissioned (except router) (#281)

* Math refactor (#283)

* math improvement

* added back metadata.address

* mod fix

* update solana and uxd-cpi version

---------

Co-authored-by: Vincent Brunet <[email protected]>

* [Credix] Bug Fix: Under-requested rebalancing (#289)

* [Router] Enforce redeem outflow limitations (#288)

* updated readme

* minor

* correct-merging-mistake

---------

Co-authored-by: uxd-vincent <[email protected]>
Co-authored-by: Vincent Brunet <[email protected]>
  • Loading branch information
3 people authored Sep 4, 2023
1 parent 5f383f0 commit 660a5e7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 14 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name:
Soteria Audit
Sec3 Vulnerability Scanning
# Update to match your branch names and requirements
on:
pull_request:
Expand All @@ -17,7 +17,7 @@ jobs:
steps:
- name: Check-out the repository
uses: actions/checkout@v2
- name: Soteria Audit
- name: Sec3 Vulnerability Scanning
continue-on-error: false # set to true if you don't want to fail jobs
uses: silas-x/soteria-action@main
with: # remove if not passing arguments below
Expand Down
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,16 @@

[![Anchor Test](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-anchor-test.yml/badge.svg?branch=main)](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-anchor-test.yml)
[![Lint and Test](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-cargo-lint-test.yml/badge.svg?branch=main)](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-cargo-lint-test.yml)
[![Soteria Audit](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-soteria-audit.yml/badge.svg)](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-soteria-audit.yml)
[![Sec3 Vulnerability Scanning](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-sec3-vulnerability-scanning.yml/badge.svg?branch=main)](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-sec3-vulnerability-scanning.yml)
[![Cargo Audit](https://github.com/UXDProtocol/uxd-program/actions/workflows/ci-cargo-audit.yml/badge.svg?branch=main)](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:

<!-- ### Solana -->

- mainnet-beta `UXD8m9cvwk4RcSxnX2HZ9VudQCEeDH6fRnB4CAP57Dr`

- devnet `55NneSZjuFv6cVDQxYKZ1UF99JoximnzP9aY65fJ4JT9` (Used by CI, this address should be update accordingly in ci files)
- devnet `BLaLouDQKDDf8T9WCgQpzxCBRtcJ4nbqv7fVQeE9PuCY` (Used by CI, this address should be update accordingly in ci files)

## Getting start

Expand All @@ -24,8 +22,6 @@ If you want to learn more about the high level concept of UXDProtocol, the [UXDP
The program (smart contract) is contained in `programs/uxd/`.
Its instructions are in `programs/uxd/src/instructions/`.

The project follows the code org as done in [Jet protocol](https://github.com/jet-lab/jet-v1) codebase.

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).
Expand All @@ -51,8 +47,7 @@ $> npm link @uxd-protocol/uxd-client

## Audits

The Program has been audited by Bramah Systems and Sec3.dev (previously Soteria) three times in the past.
It is currently under continuous audit by Sec3.dev.
The Program has been audited by Bramah Systems and Sec3.

Audit reports are available at <https://docs.uxd.fi/uxdprogram-solana/welcome/audits>.

Expand Down Expand Up @@ -116,15 +111,15 @@ Crates security vulnerability checking [tool](https://github.com/RustSec/rustsec

Runs cargo fmt, clippy, test and test-bpf.

### Soteria audit test - ci-soteria-audit.yml
### Sec3 vulnerabilty scanning test - ci-sec3-vulnerability-scanning.yml

Solana smart contract vulnerability scanning [tool](https://github.com/silas-x/soteria-action), by Soteria.
Solana smart contract vulnerability scanning [tool](https://github.com/silas-x/soteria-action), by Sec3.

## Branches and Tags

Branch off from `main` for new development changes. Pull requests should always target to `main` as well.
Branch off from `develop` for new development changes. Pull requests should always target to `develop` as well.

After passing the continuous audit by Sec3.dev, program would get deployed and merged to `main` and tagged with the version name as `v*.*.*`.
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.

Expand Down
Binary file modified ci_workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 660a5e7

Please sign in to comment.