![\"Spheron\"](\"https://github.com/spheronFdn/sdk/blob/main/.github/assets/spheron-logo.svg\"){kind=logo}
\n \n \n
\n 🧰 SDK for multi-chain storage, powered by Spheron.\n
\n\n\n\n### Upload Example\n\nIn the example below you can see how to create an instance of `SpheronClient` and how to upload a file/directory to the specified protocol.\n\n```js\nimport { SpheronClient, ProtocolEnum } from \"@spheron/storage\";\n\nconst client = new SpheronClient({ token });\nlet currentlyUploaded = 0;\nconst { uploadId, bucketId, protocolLink, dynamicLinks, cid } =\n await client.upload(filePath, {\n protocol: ProtocolEnum.IPFS,\n name,\n onUploadInitiated: (uploadId) => {\n console.log(`Upload with id ${uploadId} started...`);\n },\n onChunkUploaded: (uploadedSize, totalSize) => {\n currentlyUploaded += uploadedSize;\n console.log(`Uploaded ${currentlyUploaded} of ${totalSize} Bytes.`);\n },\n });\n```\n\n- Function `upload` has two parameters `client.upload(filePath, configuration);`\n - `filePath` - the path to the file/directory that will be uploaded\n - `configuration` - an object with parameters:\n - `configuration.name` - represents the name of the bucket on which you are uploading the data.\n - `configuration.protocol` - a protocol on which the data will be uploaded. The supported protocols are [ `ARWEAVE`, `IPFS`, `FILECOIN`].\n - `configuration.onUploadInitiated` - **optional** - callback function `(uploadId: string) => void`. The function will be called once, when the upload is initiated, right before the data is uploaded. The function will be called with one parameter, `uploadId`, which represents the id of the started upload.\n - `configuration.onChunkUploaded` - **optional** - callback function `(uploadedSize: number, totalSize: number) => void`. The function will be called multiple times, depending on the upload size. The function will be called each time a chunk is uploaded, with two parameters. the first one `uploadedSize` represents the size in Bytes for the uploaded chunk. The `totalSize` represents the total size of the upload in Bytes.\n - The response of the upload function is an object with parameters:\n - `uploadId` - the id of the upload\n - `bucketId` - the id of the bucket\n - `protocolLink` - is the protocol link of the upload\n - `dynamicLinks` - are domains that you have setup for your bucket. When you upload new data to the same bucket, the domains will point to the new uploaded data.\n - `cid` - the CID of the uploaded data. Only exists for IPFS and Filecoin protocols.\n\n---\n\n### For more information about the Storage SDK, check out the [DOCS](https://docs.spheron.network/sdk/storage-v2/)\n\n## Access Token\n\nTo create the `token` that is used with the `SpheronClient`, follow the instructions in the [DOCS](https://docs.spheron.network/rest-api/#creating-an-access-token). When you are creating the tokens, please choose **Storage** type in the dashboard.\n\n## Notes\n\nThe package is only meant for Node.js environments and will not work in a browser or frontend apps.\n\n## Learn More\n\nYou can learn more about Spheron and Storage SDK here:\n\n- [Spheron Discord](https://discord.com/invite/ahxuCtm)\n- [Spheron Twitter](https://twitter.com/SpheronFdn)\n","readmeFilename":"README.md"}![](\"https://img.shields.io/static/v1?label=npm&message=v2.0.5&color=green\")
\n ![](\"https://img.shields.io/static/v1?label=license&message=Apache%202.0&color=red\")
\n ![](\"https://img.shields.io/static/v1?label=community&message=discord&color=blue\")
\n ![](\"https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40SpheronFdn\")
\n