📁File
Any kind of file can be uploaded to Lighthouse refer to the code example given below. For developers building on other programming languages use the API directly.
Method 1: NodeJS:
import lighthouse from '@lighthouse-web3/sdk'
/**
* This function allows you to upload a file or a folder to Lighthouse.
*
* @param {string} path - The location of your file or folder.
* @param {string} apiKey - Your personal API key for Lighthouse.
* @param {object} dealParameters - Custom parameters for file storage deals(check FVM section).
* @return {object} - Returns details about the uploaded file.
*/
const uploadResponse = await lighthouse.upload(
'/home/cosmos/Desktop/wow.jpg',
'YOUR_API_KEY_HERE'
)
console.log(uploadResponse)
/*Sample response
{
data: {
Name: 'wow.jpg',
Hash: 'QmUHDKv3NNL1mrg4NTW4WwJqetzwZbGNitdjr2G6Z5Xe6s',
Size: '31735'
}
}
*/Method 2: Browser
import React from "react"
import lighthouse from '@lighthouse-web3/sdk'
function App() {
const progressCallback = (progressData) => {
let percentageDone =
100 - (progressData?.total / progressData?.uploaded)?.toFixed(2)
console.log(percentageDone)
}
const uploadFile = async(file) =>{
// Push file to lighthouse node
// Both file and folder are supported by upload function
// Third parameter is for multiple files, if multiple files are to be uploaded at once make it true
// Fourth parameter is the deal parameters, default null
const output = await lighthouse.upload(file, "YOUR_API_KEY", null, progressCallback)
console.log('File Status:', output)
/*
output:
data: {
Name: "filename.txt",
Size: 88000,
Hash: "QmWNmn2gr4ZihNPqaC5oTeePsHvFtkWNpjY3cD6Fd5am1w"
}
Note: Hash in response is CID.
*/
console.log('Visit at https://gateway.lighthouse.storage/ipfs/' + output.data.Hash)
}
return (
<div className="App">
<input onChange={e=>uploadFile(e.target.files)} type="file" />
</div>
)
}
export default Appcurl -X POST -H 'Authorization: Bearer API_KEY' -F 'file=@/mnt/c/Users/ravis/Desktop/unnamed.jpeg' 'https://upload.lighthouse.storage/api/v0/add'The given command can be used to upload a file or directory on Lighthouse
lighthouse-web3 upload <path>
from lighthouseweb3 import Lighthouse
# Initialize Lighthouse with your API token
lh = Lighthouse(token="YOUR_API_KEY")
# Upload a file
source_file_path = "/path/to/your/file.jpg"
upload_response = lh.upload(source=source_file_path)
print(upload_response)
# Sample response
# {
# 'data': {
# 'Name': 'wow.jpg',
# 'Hash': 'QmUHDKv3NNL1mrg4NTW4WwJqetzwZbGNitdjr2G6Z5Xe6s',
# 'Size': '31735'
# }
# }
print(f"File uploaded successfully!")
print(f"CID: {upload_response['data']['Hash']}")
print(f"Name: {upload_response['data']['Name']}")
print(f"Size: {upload_response['data']['Size']} bytes")
print(f"Visit at https://gateway.lighthouse.storage/ipfs/{upload_response['data']['Hash']}")
# Upload a file with a tag
tag = "my-tag"
upload_with_tag = lh.upload(source=source_file_path, tag=tag)
print(f"File uploaded with tag: {tag}")
# Upload a directory
directory_path = "/path/to/your/directory"
upload_dir = lh.upload(source=directory_path)
print(f"Directory uploaded! Root CID: {upload_dir['data']['Hash']}")
# Upload from a file-like object (BufferedReader)
import io
with open(source_file_path, 'rb') as file_obj:
upload_blob = lh.uploadBlob(file_obj, "filename.jpg")
print(f"Blob uploaded! CID: {upload_blob['data']['Hash']}")package main
import (
"context"
"fmt"
"log"
"os"
"github.com/lighthouse-web3/lighthouse-go-sdk/lighthouse"
)
func main() {
client := lighthouse.NewClient(nil,
lighthouse.WithAPIKey(os.Getenv("LIGHTHOUSE_API_KEY")),
)
ctx := context.Background()
// Upload a file
upload, err := client.Storage().UploadFile(ctx, "/path/to/your/file.jpg")
if err != nil {
log.Fatal(err)
}
fmt.Printf("File uploaded successfully!\n")
fmt.Printf("CID: %s\n", upload.Hash)
fmt.Printf("Name: %s\n", upload.Name)
fmt.Printf("Size: %s\n", upload.Size)
}
Last updated
Was this helpful?