https://github.com/kevinbluer/truffle-plugin-caramel
Adding caramel gooeyness (aka artifact persistence via Pinata's IPFS pinning service) to Truffle.
https://github.com/kevinbluer/truffle-plugin-caramel
artifacts decentralized ipfs pinata pinning storage truffle
Last synced: about 2 months ago
JSON representation
Adding caramel gooeyness (aka artifact persistence via Pinata's IPFS pinning service) to Truffle.
- Host: GitHub
- URL: https://github.com/kevinbluer/truffle-plugin-caramel
- Owner: kevinbluer
- License: mit
- Created: 2020-07-13T21:54:23.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-15T11:17:01.000Z (almost 2 years ago)
- Last Synced: 2025-02-14T05:51:20.582Z (4 months ago)
- Topics: artifacts, decentralized, ipfs, pinata, pinning, storage, truffle
- Language: JavaScript
- Homepage:
- Size: 51.8 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Caramel
Adding caramel gooeyness (aka artifact persistence via [Pinata's](http://pinata.cloud/) IPFS pinning service) to [Truffle](https://www.trufflesuite.com/) 🍬
## Installation
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](https://pinata.cloud/account). Example as follows:
```
PINATA_API_KEY=deadbeef
PINATA_API_SECRET=1234567890
```
## Usage
To run the plugin, simple run the following command from the root of your Truffle project:
```
truffle run caramel
```
The list available commands is currently as follows:
- [upload](#upload)
- [list](#list)
- [unpin](#unpin)
The following uploads your [Truffle artifacts](https://www.trufflesuite.com/docs/truffle/advanced/networks-and-app-deployment#build-artifacts).
```
truffle run caramel upload []
```
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
```