crypt0miester / metaplex-program-library-py

mpl with python libraries

Metaplex Program Library

Metaplex smart contracts and SDK with Python libs.

how to add python libs:

• python>=3.9 is required
• install anchorpy[cli] preferrably with virtualenv
• may require manually fetching/building idl (may not work with ts-idl)
• generate with: anchorpy client-gen ./idl/candy_machine.json ./src --program-id cndy3Z4yapfJBmL3ShUp5exZKqR3z33thTzeNMm2gRZ
• et voilà

Note that there are still some fixes that need to be done at times. i.e. BorshPubkey not being written to the python file.

contracts with python libs:

• candy machine
• auction house (untested)
• token entangler (untested)
• token metadata

Metaplex Contracts

Name	Program	SDK	Integration Test
Candy Machine
Token Vault
Token Entangler
Token Metadata
Auction
Auction House
Metaplex
NFT-Packs
Gumdrop
Fixed price sale

Development

Versioning and Publishing Packages

Smart contract SDK packages are versioned independently since a contract isn't necessarily coupled to other contracts.

We use the following (pre|post)(version|publish) npm scripts to manage related checks, tagging, commiting and pushing the version bump.

• preversion: ensures that the package builds and its tests pass
• postversion: adds and commits the version bump and adds a tag indicating package name and new version, i.e. @metaplex-foundation/[email protected]
• prepublish: ensures that the package builds and its tests pass again (just to be really sure)
• postpublish: pushes the committed change and new tag to github

In order to version and then publish a package just run the following commands from the folder of the package you want to update:

• npm version <patch|minor|major>
• npm publish

As you note if version + publish succeeds the scripts end up pushing those updates to the master branch. Therefore please ensure to be on and up to date master branch before running them. Please don't ever publish from another branch but only from the main one with only PR approved changes merged.

Rust Crates

Package	Link	Version
Candy Machine	mpl-candy-machine
Token Metadata	mpl-token-metadata
Token Vault	mpl-token-vault
Auction House	mpl-auction-house
Testing Utils	mpl-testing-utils

Npm Packages

Package	Link	Version
Candy Machine	mpl-candy-machine
Token Metadata	mpl-token-metadata
Core	mpl-core
Auction House	mpl-auction-house

Reporting security issues

To report a security issue, please follow the guidance on the SECURITY page.

License

The Rust/Cargo programs are licensed under the AGPLv3 license and the JS/TS client libraries are licensed under either the MIT or the Apache licenses.