sdkbullit v1.0.17

Tutorial for sdkBullit library

🚧 Introduction

The sdkbullit library is a powerful tool for developers that need to handle encryption and storage for files on the web3. It provides a simple and secure way to store and retrieve data by leveraging the LitJsSdk library for encryption and the Web3.storage for file storage.

🏯 Use Cases

This library is great for building applications that:

• Require file encryption before storage
• Use the web3 blockchain for file storage
• Need to retrieve and decrypt files stored on the web3 blockchain

⌛ Installation

To install the sdkbullit library, run the following command in your terminal:

npm i sdkbullit

🕹 Usage

Here is a step-by-step guide on how to use the sdkbullit library:

1. Import the bullitSDK function from the sdkbullit library:

import { SDKBullit } from 'sdkbullit';

2. Initialize bullitSDK with your configuration:

const { uplodeFile, downloadFile } = SDKBullit({
  protocol: 'Lit',
  system: 'Web3',
  token: 'your_web3_storage_token',
  chain: 'your_chain',
  accessControlConditions: 'your_access_control_conditions',
});

The parameters for SDKBullit function are:

• protocol (string): The protocol to be used for encryption.
• system (string): The storage system to be used.
• token (string): Your Web3.storage token.
• chain (string): The blockchain chain you're using.
• accessControlConditions (any): The access control conditions to be used.

3. Use uplodeFile function to encrypt and store files:

const file = //...your file
uplodeFile(file);

The uplodeFile function takes a File object and uploads it to the Web3 storage after encrypting it.

4. Use downloadFile function to retrieve and decrypt files:

const fileID = //...your file id
downloadFile(fileID);

The downloadFile function takes a fileID and retrieves the file from the Web3 storage. It then decrypts the file and returns it.

Remember to replace 'your_web3_storage_token', 'your_chain', and 'your_access_control_conditions' with your actual web3.storage token, the chain you're using, and your access control conditions respectively.