Winter protocol service for the Cardano blockchain. Metadata standard follows the EPCIS stanard.
To see the OpenAPI sepcification, along with other usage details and example, please check documentation overview.
Note: This application should be considered an MVP/PoC.
- Blockfrost
- Cardano wallet mnemonic
- Pinata
- Docker
- Bruno: If testing API endpoints locally.
- Copy
.env.exampleto.envand fill in the required environment variables. - Run
docker compose up --build - Use the Bruno collection from the repository to test out the exposed API endoints.
- The
NETWORKcan be one ofmainnet|preview|preprod. - The
BLOCKFROST_KEYshould be configured depending on the value used forNETWORK.
In order to submit data to IPFS and then mint an NFT on the Cardano blockchain serving as a reference to the data, you should make the following API calls:
POST /ipfs: Here you include the metadata in the EPCIS format that will be uploaded to IPFS. The response will be the IPFS CID.
POST /palmyra/tokenizeCommodity: Here you include the IPFS CID and token name in the body. Note that the token name can only be 32 bytes long. The response will include a job id, which can be used to check that status of the job in the queue.
GET /check/:id: Include the job id as a query parameter to get the status of the job. If there is a SUCCESS status, then the response will also contain a valid Cardano transaction id, which can be used to look up the transaction on the explorer corresponding to the Cardano network type used to run the application. Note that the transaction may not appear immediately, since there will be a delay until it is confirmed to be included inside a block.
To get more in-depth information on how to setup the application and the environment variables, along with how to use the application, please check the following winter-manual.
To see best practices for deployment of the application and dealing with different types of metadata, please check the following best-practices.