npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sdkbullit

v1.0.17

Published

A library for file encryption and storage on the web3

Downloads

5

Readme

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';
  1. 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.
  1. 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.

  1. 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.