This is a repository for generating and managing a BRC721 collection
Use at your own risk, still under development
- Generate Collection Manifest
- Generate Reveal Manifest
- Generate Inscription Manifest(s) // only one for now
- Validate Manifests
- Utility to convert private keys from base 58 encoded Compressed WIF to hex
- Fork repository
- Add env variables
- see env variables section
- Install dependencies
npm i
- run scripts (as declared in
package.json
)
Converts a key, as exported from a wallet (ie. Electrum) from base-58 encoded compressed Wallet Import Format (WIF) to hex
Generates a collection manifest file
Generates a reveal manifest. If one exists, it will increment content.weight
Generates an inscription manifest. Currently overwrites the existing one
Validates all existing manifest files, according to their respective schema. There are some additional rules that should be verifiable, but aren't current being validated, since they rely on transaction data, and this repo focuses exclusively on generating manifests.
Use a service like https://unisat.io/inscribe
To use this project, relevant information must be set in a .env
file
- create a
.env
file in the project root, see.env.example
.env
is .gitignored for safety reasons
BRC_721_PAYMENT_ADDRESS
BRC_721_SIGNER_PUBLIC_KEY
BRC_721_PRIVATE_KEY
- need to match
BRC_721_SIGNER_PUBLIC_KEY
- need to match
BRC_721_COLLECTION_INSCRIPTION_ID
BRC_721_COLLECTION_NAME
BRC_721_COLLECTION_SYMBOL
BRC_721_MAX_SUPPLY
BRC_721_MAX_PER_ADDRESS
BRC_721_METADATA_URL
BRC_721_INSCRIPTION_PRICE
MIT