757a3ee0cc
* Use ghcr.io container registry * Update base image urls |
||
|---|---|---|
| .github | ||
| 3rdparty | ||
| anchor-tests | ||
| bin | ||
| cd | ||
| docs | ||
| lib | ||
| migrations | ||
| programs | ||
| py | ||
| ts/client | ||
| .dockerignore | ||
| .env.sample | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitignore | ||
| .gitmodules | ||
| .mocharc.json | ||
| .prettierignore | ||
| Anchor.toml | ||
| CHANGELOG.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| DEVELOPING.md | ||
| Dockerfile | ||
| HOW-TO-RELEASE.md | ||
| LICENSE | ||
| Procfile | ||
| Program | ||
| README.md | ||
| RELEASING.md | ||
| SECURITY.md | ||
| fix-npm-tag.sh | ||
| fly.toml | ||
| idl-fixup.sh | ||
| mango_v4.json | ||
| package.json | ||
| release-to-devnet.sh | ||
| run-anchor-tests.sh | ||
| tsconfig.cjs.json | ||
| tsconfig.esm.json | ||
| tsconfig.json | ||
| tsconfig.types.json | ||
| update-local-idl.sh | ||
| yarn.lock | ||
README.md
work in progress
License
See the LICENSE file.
The majority of this repo is MIT licensed, but some parts needed for compiling the solana program are under GPL.
All GPL code is gated behind the enable-gpl feature. If you use the mango-v4
crate as a dependency with the client or cpi features, you use only MIT
parts of it.
The intention is for you to be able to depend on the mango-v4 crate for
building closed-source tools and integrations, including other solana programs
that call into the mango program.
But deriving a solana program with similar functionality to the mango program from this codebase would require the changes and improvements to stay publicly available under GPL.
Development
See DEVELOPING.md
Dependencies
- rust version 1.65.0
- solana-cli 1.14.9
- npm 8.1.2
- node v16.13.1
Submodules
After cloning this repo you'll need to init and update its git submodules.
Consider setting the git option submodule.recurse=true.
Deployments
- devnet: 4MangoMjqJ2firMokCjjGgoK8d4MXcrgL7XJaL3w6fVg
- mainnet-beta: 4MangoMjqJ2firMokCjjGgoK8d4MXcrgL7XJaL3w6fVg
- primary mango group on mainnet-beta: 78b8f4cGCwmZ9ysPFMWLaLTkkaYnUjwMJYStWe5RTSSX
Release
Here are steps followed while performing a program deployment to mainnet-beta
- review diff of last deployed tag to mainnet-beta, e.g. https://github.com/blockworks-foundation/mango-v4/compare/program-v0.4.0..dev, pay special attention to account layout changes, backward compatibility of newly introduced account fields, etc.
- deploy to mainnet-beta
- update changelog with deploy timestamp and tx
- add a git tag e.g.
program-v0.0.1, should match the version the program has - reset
mainto currently deployed tag - notify other contributors for bringing in changes from new release by merging
maininto their branch, e.g.ts-clientanddeploy-mm - notify other contributors for appropriately handling offchain services e.g. scrapers, market makers, etc.
- bump program version in
Cargo.tomlon dev branch for next release
Here are steps followed while performing a npm package release note: the UI currently uses code directly from github, pointing to the ts-client branch
- use
yarn publishto release a new package, ensure compatibility with program release to mainnet-beta - fix the tag auto added by yarn to match our internal convention, see script
fix-npm-tag.sh, tags should look like this e.g.npm-v0.0.1, note: the npm package version/tag should not necessarily match the latest program deployment