Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emmo00/auctioneer
Auction application build with cartesi rollup
https://github.com/emmo00/auctioneer
cartesi rollup rollupapis
Last synced: about 16 hours ago
JSON representation
Auction application build with cartesi rollup
- Host: GitHub
- URL: https://github.com/emmo00/auctioneer
- Owner: Emmo00
- Created: 2024-08-05T18:18:08.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-06T15:43:28.000Z (5 months ago)
- Last Synced: 2024-08-06T22:54:49.019Z (5 months ago)
- Topics: cartesi, rollup, rollupapis
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Auctioneer
simple auction application
A dApp where you can participate and create your own auctions.
For this implementation, A user can create only one active auction at a time.
## Getting Started
Below you'll find instructions on how setting up this dapp locally.
### Prerequisites
Here are some packages you need to have installed on your PC:
* [nodejs](https://nodejs.org/en), [npm](https://docs.npmjs.com/cli/v10/configuring-npm/install), [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable)
* [docker](https://docs.docker.com/get-docker/)
* [cartesi-cli](https://docs.cartesi.io/cartesi-rollups/1.3/development/migration/#install-cartesi-cli)
```sh
npm install -g @cartesi/cli
```
### Installation
1. Clone this repo
```sh
git clone https://github.com/Emmo00/auctioneer.git
```
2. Install NPM packages
```sh
yarn install
```
3. Build and run the dapp via `cartesi-cli`
```sh
cartesi build
```
and
```sh
cartesi run
```
## Usage
Here you can access the examples of dapp communication and resources consume.
There are these resources available on this dapp:
### Advanced handlers
* #### create auction
Creates an auction with the user's address
* #### update bid
Updates the active amount for an auction. this changes the bid amount of an auction to 7/4 of the original amount and sets the active bidder
### Inspect handlers
* #### list auctions
lists all the auctions on the dApp
* #### show auction
Shows the details of an auction. owner, activeAmount and ActiveBidder
## License
MIT License