0.1.0 • Published 2 years ago

jm-mpl-v2 v0.1.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

Metaplex Program Library

Metaplex smart contracts and SDK.

Metaplex Contracts

NameProgramSDKIntegration Test
Candy MachineProgram Candy MachineSDK Candy Machine
Token VaultProgram Token VaultSDK Token VaultIntegration Token Vault
Token EntanglerProgram Token EntanglerSDK Token Entangler
Token MetadataProgram Token MetadataSDK Token Metadata
AuctionProgram AuctionSDK Auction
Auction HouseProgram Auction HouseSDK Auction House
MetaplexProgram MetaplexSDK Metaplex
NFT-PacksProgram NFT-Packs
GumdropProgram GumdropSDK Gumdrop
Fixed price saleProgram Fixed Price SaleSDK Fixed Price SaleIntegration 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/mp-core@v0.0.1
  • 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

PackageLinkVersion
Candy Machinempl-candy-machineCrate
Token Metadatampl-token-metadataCrate
Token Vaultmpl-token-vaultCrate
Auction Housempl-auction-houseCrate
Testing Utilsmpl-testing-utilsCrate

Npm Packages

PackageLinkVersion
Candy Machinempl-candy-machineNPM
Token Metadatampl-token-metadataNPM
Corempl-coreNPM
Auction Housempl-auction-houseNPM

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.