Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danmurphy1217/pos-etf
https://github.com/danmurphy1217/pos-etf
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/danmurphy1217/pos-etf
- Owner: danmurphy1217
- Created: 2021-03-13T03:39:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-19T16:55:29.000Z (over 3 years ago)
- Last Synced: 2024-10-26T22:10:19.050Z (3 months ago)
- Language: Python
- Size: 2.08 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Proof-of-Stake ETF
An ETF built on top of the Algorand Blockchain whose net value represents the top 10 Proof-of-Stake cryptocurrencies in circulation. This project allows you to purchase one diversified coin that represents these ten underlying assets, as opposed to buying the top ten Proof-of-Stake coins individually.
# Getting Started
## Authentication
First, you can connect a current Algorand Address with the following command:
```
python3 main.py signup
```
After, you will be prompted to enter your:
- Address
- Passphrase
- Account Name (if blank, the address is used)
You can also login to an already-connected account by running:
```
python3 main.py login
```
A list of account names will be rendered, and you can select which one to login to.
## Transactions
For this ETF, there are two possible transactions: `Buy` and `Sell`. To buy the ETF coin, you will use the following command:
```
python3 main.py --buy [amount to buy]
```
After entering this command, the information for this transaction will be rendered on the screen. If it is correct, you can hit enter and your transaction will be approved in roughly 30 seconds. If the information is incorrect, you can hit `cntl + c` to cancel.
To sell your ETF coin holdings, use the following command:
```
python3 main.py --sell [amount to sell]
```
The amount to sell must be less than the total holdings of your account. If it is not, an error will be throw, invalidating the transaction. Once you enter this command, the transaction information will be rendered on the screen. If it is correct, you can hit enter and your transaction will be submitted to the Algorand blockchain for confirmation.
## Viewing Holdings
This CLI also provides you with an easy way to view your ETF coin holdings. By using the following command:
```
python3 main.py --view
```
A list of your account names will be rendered. Once you select which one to retrieve data for, the total amount of ETF Coin holdings will be displayed in the terminal window.
