@lighthouse-web3/sdk
v0.4.4TypeScript
NPM package and CLI tool to interact with lighthouse protocol
1.0K/weekUpdated 2 weeks agoMITUnpacked: 163.0 KB
Published by nandit123
npm install @lighthouse-web3/sdkLighthouse 
Lighthouse is a permanent decentralized file storage protocol that allows the ability to pay once and store forever. While traditionally, users need to repeatedly keep track and pay for their storage after every fixed amount of time, Lighthouse manages this for them and makes sure that user files are stored forever. The aim is to move users from a rent-based cost model where they are renting their own files on cloud storage to a permanent ownership model. It is built on top of IPFS, Filecoin, and Polygon. It uses the existing miner network and storage capacity of the filecoin network.
Installation
``bash`
npm install -g @lighthouse-web3/sdk
CLI Usage
`bashWallet management
lighthouse-web3 create-wallet # Create a new wallet
lighthouse-web3 import-wallet --key
lighthouse-web3 wallet-forget # Remove previously saved wallet
lighthouse-web3 reset-password # Change password of your wallet
lighthouse-web3 wallet # Returns wallet public address
API Key management
lighthouse-web3 api-key --new # Generate a new API key
lighthouse-web3 api-key --import
Storage and uploads
lighthouse-web3 upload
lighthouse-web3 upload-encrypted
lighthouse-web3 decrypt-file
Data usage and balance
lighthouse-web3 balance # Get your data usage
File and deal status
lighthouse-web3 deal-status
File management
lighthouse-web3 get-uploads # Get details of files uploaded
lighthouse-web3 delete-file
Sharing and access control
lighthouse-web3 share-file
lighthouse-web3 revoke-access
IPNS (InterPlanetary Naming System)
lighthouse-web3 ipns --generate-key # Generate IPNS Key
lighthouse-web3 ipns --publish --cid
lighthouse-web3 ipns --list # List all IPNS keys
lighthouse-web3 ipns --remove
Proof of Data Segment Inclusion (PODSI)
lighthouse-web3 podsi
`
NodeJs Example
javascript
import lighthouse from '@lighthouse-web3/sdk'// Create wallet
const wallet = await lighthouse.createWallet('Password for wallet encryption')
// Get wallet balance
const balance = await lighthouse.getBalance(wallet.data.publicKey)
// Upload File
const uploadResponse = await lighthouse.upload(
'/home/cosmos/Desktop/wow.jpg',
'YOUR_API_KEY'
)
> Refer GitBook
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
This project is tested with BrowserStack.
License
``