Skip to main content



To get started using Jackal in the browser, you'll need a few things!


Setting Up

To get started, make sure you start your project using Vite. If you have an existing React app for example, re-init the project using Vite.

Updating Vite Config

// In vite.config.js:
import nodePolyfills from 'vite-plugin-node-stdlib-browser'

export default defineConfig({
plugins: [

Connecting Your Wallet

const chainConfig = { // mainnet chain config
chainId: 'jackal-1',
chainName: 'Jackal',
rpc: '',
rest: '',
bip44: {
coinType: 118
coinType: 118,
stakeCurrency: {
coinDenom: 'JKL',
coinMinimalDenom: 'ujkl',
coinDecimals: 6
bech32Config: {
bech32PrefixAccAddr: 'jkl',
bech32PrefixAccPub: 'jklpub',
bech32PrefixValAddr: 'jklvaloper',
bech32PrefixValPub: 'jklvaloperpub',
bech32PrefixConsAddr: 'jklvalcons',
bech32PrefixConsPub: 'jklvalconspub'
currencies: [
coinDenom: 'JKL',
coinMinimalDenom: 'ujkl',
coinDecimals: 6
feeCurrencies: [
coinDenom: 'JKL',
coinMinimalDenom: 'ujkl',
coinDecimals: 6,
gasPriceStep: {
low: 0.002,
average: 0.002,
high: 0.02
features: []

const walletConfig = {
selectedWallet: 'keplr',
signerChain: 'jackal-1',
enabledChains: ['jackal-1'],
queryAddr: '',
txAddr: '',
chainConfig: chainConfig

// Hooking up the wallet to your app
const wallet = await WalletHandler.trackWallet(walletConfig)

Buying Storage Space

Every account that wishes to use the Jackal Protocol to store data needs to have a paid account. This means giving the protocol $8/month/tb. We can do this with Jackal.js!

const storage = await StorageHandler.trackStorage(wallet)

// (Wallet address, duration in hours (min 720),
// space in bytes (min 1000000000)
await storage.buyStorage(WALLET_ADDRESS, 720, 1000000000000)

Creating a Folder

const fileIo = await FileIo.trackIo(wallet)

const listOfFolders = ["folder_name", ...]
// you can create as many folders as you would like this way

// The first time a user connects, they must init the system
const storage = await StorageHandler.trackStorage(wallet)
const msg = storage.makeStorageInitMsg()
await fileIo.generateInitialDirs(msg, listOfFolders)

// after the first time, this code can be used instead. this will only create new folders if they don't already exist
const newFolderCount = await fileIo.verifyFoldersExist(listOfFolders)

Uploading a File

const fileIo = await FileIo.trackIo(wallet)

const parentFolderPath = PARENT_FOLDER_NAME // replace this with your own path
const fileName = FILE_NAME // replace this with your own file name

const handler = await FileUploadHandler.trackFile(FILE_OBJECT, parentFolderPath)

const parent = await fileIo.downloadFolder(parentFolderPath)

const uploadList = {
fileName: {
data: null,
exists: false,
handler: handler,
key: fileName,
uploadable: await handler.getForUpload()

await fileIo.staggeredUploadFiles(uploadList, parent, {counter: 0, complete: 0})

Downloading a File

const fileIo = await FileIo.trackIo(wallet)

const file = await fileIo.downloadFile(
rawPath: FILE_PATH
isFolder: false
track: 0

const fileData = file.receiveBacon()
// do what you want with the File object returned by receiveBacon