Adding caramel gooeyness (aka artifact persistence via Pinata's IPFS pinning service) to Truffle 🍬
Begin by adding to your Truffle project via the following:
npm i truffle-plugin-caramel
Add the following to your truffle-config.json:
plugins: [
"truffle-plugin-caramel"
]
Finally, create a .env file in the project's root directory with your Pinata API key (PINATA_API_KEY) and secret (PINATA_API_SECRET). These can be found under your account page. Example as follows:
PINATA_API_KEY=deadbeef
PINATA_API_SECRET=1234567890
To run the plugin, simple run the following command from the root of your Truffle project:
truffle run caramel <command>
The list available commands is currently as follows:
The following uploads your Truffle artifacts.
truffle run caramel upload [<path>]
Options:
- path - Specifies the path (either to a directory or a file) that you would like to explicitly upload. If omitted, it will default to uploading your Truffle artifacts.
The following retrieves a list of all your pins currently pinned on Pinata.
truffle run caramel list
The following unpins an ipfs hash currently pinned by Pinata.
truffle run caramel unpin <ipfs-hash>