Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pinatacloud/pinata-lit-protocol-template
A template that can be used for encrypting and uploading files to IPFS with Pinata, as well as decrypting them.
https://github.com/pinatacloud/pinata-lit-protocol-template
Last synced: 17 days ago
JSON representation
A template that can be used for encrypting and uploading files to IPFS with Pinata, as well as decrypting them.
- Host: GitHub
- URL: https://github.com/pinatacloud/pinata-lit-protocol-template
- Owner: PinataCloud
- Created: 2023-11-01T14:49:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-02T03:10:49.000Z (about 1 year ago)
- Last Synced: 2024-11-30T16:04:55.450Z (23 days ago)
- Language: TypeScript
- Homepage: https://pinata-lit-protocol-template.vercel.app
- Size: 1.4 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Getting Started
This is the TypeScript + Tailwind CSS boilerplate Pinata starter template + the Lit Protocol SDK to enable encrypted file sharing.
You can edit the `pages/index.js` file and the API route file `pages/api/files` to see the Pinata functionality and extend it or make changes.
## Encryption
All the encryption pieces are located in the `index.tsx` file under the `uploadFile()` function. The most important part to take note of is the `accs` array which determines who can unlock the files. it will look something like this:
```javascript
const accs = [
{
contractAddress: '',
standardContractType: '',
chain: 'ethereum',
method: 'eth_getBalance',
parameters: [':userAddress', 'latest'],
returnValueTest: {
comparator: '>=',
value: '0',
},
},
];
```
With its current implementation the only thing required to decrypt the file is to have a balance greater than 0. This is just a proof of concept and can be changed to whatever you want. For more info on different access controls check out the [Lit Protocol Documentation](https://developer.litprotocol.com/v3/sdk/access-control/evm/basic-examples).
### Environment Variables
This project makes use of both public and private environment variables. The private environment variables are used to protect sensitive data like your Pinata API keys. The public environment variables are convenient central variable housing.
Read more about [how environment variables work with Next.js here](https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables).
There is a `.env.sample` file you can copy and rename to `.env.local` for use in your project. Be sure to fill out the environment variable values in the `.env.local` file with your actual values.
It should look something like this:
```
PINATA_JWT=
NEXT_PUBLIC_GATEWAY_URL=
```
You can find out how to create your Pinata JWT [here](https://docs.pinata.cloud/docs/api-keys) and your Gateway URL [here](https://docs.pinata.cloud/docs/gateways-page). The Gateway URL format should be `https://mygateway.mypinata.cloud`.
### Learn More
For more information about building apps with Pinata and IPFS, check out the following resources:
- [Pinata Docs](https://docs.pinata.cloud)
- [Pinata Tutorials](https://medium.com/pinata)
- [Quick Start Recipes](https://docs.pinata.cloud/recipes)