rivalz-client

Rivalz File Worker

This is a TypeScript library that provides functionalities for Rivazl Ai

Installation

Before you start, make sure you have Node.js and npm/yarn installed on your machine.

npm install rivalz-client

or

yarn add rivalz-client 

Usage

1. Creates key in Rivalz Dashboard and use it to initialize the RivalzClient class.

After installing the package, Please come in the Rivalz Dashboard to create a encrypted key and secret key.

• Encrypt key used for encrypting the file
• Secret key used for authentication

2. Import and use the RivalzClient class in your TypeScript/JavaScript code:

import RivalzClient from 'rivalz-client';

const rivalzClient = new RivalzClient('your-secret-key');

API:

1 Upload File

rivalzClient.uploadFile(file)

• file: A readable stream of the file to be uploaded.
• Returns a promise that resolves to the IPFS hash of the uploaded file.

2. Upload passport file

rivalzClient.uploadPassport(file)

• file: A readable stream of the file to be uploaded.
• Returns a promise that resolves to the IPFS hash of the uploaded file.

3. Download File and save it to the local file system (Node.js only)

rivalzClient.downloadFile(ipfsHash, savePath)

• ipfsHash: The IPFS hash of the file to be downloaded.
• savePath: The path where the downloaded file will be saved.
• Returns a promise that resolves to the path of the saved file.

4. Download File and return it as buffer

rivalzClient.download(ipfsHash)

• ipfsHash: The IPFS hash of the file to be downloaded.
• Returns a promise that resolves to a buffer containing the downloaded file.

5. Delete File

rivalzClient.deleteFile(ipfsHash)

• ipfsHash: The IPFS hash of the file to be deleted.
• Returns a promise that resolves to the IPFS hash of the deleted file.

License

This project is licensed under the MIT License.

Please replace `'your-secret'`, `file`, `passport`, `ipfsHash`, and `savePath` with actual values when using the `RivalzClient` class.

Example

Example upload file for node.js project:

const RivalzClient = require('rivalz-client');
// import RivalzClient from 'rivalz-client';
const fs = require('fs');
// import fs from 'fs';

const file = fs.createReadStream('file_path');
const rivalzClient = new RivalzClient('your-secret-key');
rivalzClient.uploadFile(file)

Example download file for node.js project:

const RivalzClient = require('rivalz-client');
const rivalzClient = new RivalzClient('your-secret-key');
rivalzClient.downloadFile('ipfs_hash_uploaded', 'save_path')

Dependencies

This project uses the following dependencies:

• axios: For making HTTP requests.
• buffer: For handling binary data.
• @types/node: For TypeScript definitions for Node.js.
• typescript: For writing and compiling TypeScript code.