Skip to content

Commit

Permalink
1.0 update README.md, add setup.py
Browse files Browse the repository at this point in the history
  • Loading branch information
PaTara43 committed Sep 30, 2022
1 parent 11b634d commit f4f7630
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,23 @@
https://crust.network/
https://apps.crust.network/
https://wiki.crust.network/en
https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frpc-shadow.crust.network%2F#/explorer

This is a simple tool to upload your files to a Crust network.

## Setup

#### For Rocky Testnet
- create an account on [Crust Rocky Testnet](https://apps.crust.network/?rpc=wss%3A%2F%2Frpc-rocky.crust.network#/explorer)
- ask for tokens in [faucet](https://discord.gg/d6XuBXCqxU)

### Installation:
```bash
git clone https://github.com/PaTara43/crust-file-uploader/
cd crust-file-uploader
pip3 istall .
pip3 install .
```

## Features

The module is divided into `UploaderMainnet`, `UploaderShadow` and `Web3Gateway`

`Web3Gateway` allows you to upload files to IPFS via Web3-authenticate gateway.
The module is divided into `Mainnet` and `Shadow`

`UploaderMainnet` provides Crust interaction functionality to check user balance, calculate file storage price, placing
`Mainnet` provides Crust interaction functionality to check user balance, calculate file storage price, placing
file storage order, add tokens to renewal pool and checking replicas count.

`UploaderShadow` allows you to perform `xstorage` extrinsic in Crust Shadow network (Not possible yet due to wasm issue)
`Shadow` allows you to perform `Xstorage` extrinsic in Crust Shadow network.
13 changes: 13 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!/usr/bin/env python3

from setuptools import setup

setup(name='crust-file-uploader',
version='1.0.0',
description='A simple python tool to upload files to Crust Network',
author='Pavel Tarasov',
author_email='[email protected]',
url='https://github.com/PaTara43/crust-file-uploader',
packages=['crust_file_uploader'],
install_requires=['substrate-interface>=1.3.2,<2'],
)

0 comments on commit f4f7630

Please sign in to comment.