Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metaplex-foundation/mpl-bubblegum
Create and manage Metaplex compressed NFTs
https://github.com/metaplex-foundation/mpl-bubblegum
Last synced: about 1 month ago
JSON representation
Create and manage Metaplex compressed NFTs
- Host: GitHub
- URL: https://github.com/metaplex-foundation/mpl-bubblegum
- Owner: metaplex-foundation
- License: other
- Created: 2023-06-09T16:19:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-15T22:26:07.000Z (3 months ago)
- Last Synced: 2024-09-16T00:16:01.442Z (3 months ago)
- Language: Rust
- Homepage: https://developers.metaplex.com/bubblegum
- Size: 1.69 MB
- Stars: 65
- Watchers: 4
- Forks: 37
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - metaplex-foundation/mpl-bubblegum - Create and manage Metaplex compressed NFTs (Rust)
- solana-awesome - Link
README
Metaplex Bubblegum
Create and manage compressed NFTs on Solana. Compressed NFTs make it possible to scale the creation of NFTs to new orders of magnitude by rethinking the way we store data on-chain.
## Getting Started
The packages below can be use to interact with Bubblegum program.
### TypeScript
```sh
npm install @metaplex-foundation/mpl-bubblegum
```
[See typedoc documentation](https://mpl-bubblegum-js-docs.vercel.app/).
### Rust
```sh
cargo add mpl-bubblegum
```
[See crate documentation](https://docs.rs/mpl-bubblegum/latest/mpl_bubblegum/).
## Documentation
Developer documentation for Bubblegum can be found [here](https://developers.metaplex.com/bubblegum).
## Building
From the root directory of the repository:
- Install the required packges:
```sh
pnpm install
```
- Build the program:
```sh
pnpm programs:build
```
This will create the program binary at `/programs/.bin`
## Testing
Bubblegum includes two set of tests: BPF and TypeScript.
### BPF
From the root directory of the repository:
```sh
pnpm programs:test
```
### TypeScript
From the root directory of the repository:
```sh
pnpm validator
```
This will start a local validator using [Amman](https://github.com/metaplex-foundation/amman).
After starting the validator, go to the folder `/clients/js` and run:
```sh
pnpm install
```
This will install the required packages for the tests. Then, run:
```sh
pnpm build && pnpm test
```
## Security
To report a security issue, please follow the guidance on our [bug bounty program](https://www.metaplex.com/bounty-program) page.
## License
The Rust/Cargo programs are licensed under the
"Apache-style" [Metaplex(TM) NFT Open Source License](https://github.com/metaplex-foundation/mpl-token-metadata/blob/master/LICENSE) and the JS/TS client libraries are licensed
under either the [MIT](https://www.mit.edu/~amini/LICENSE.md) or the [Apache](https://www.apache.org/licenses/LICENSE-2.0.txt) licenses.
## Contributing
Check out the [Contributing Guide](./CONTRIBUTING.md) the learn more about how to contribute to this project.