Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dckc/capfundme

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/dckc/capfundme
Owner: dckc
Created: 2021-03-20T18:52:03.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2021-03-20T18:52:35.000Z (almost 4 years ago)
Last Synced: 2024-10-30T19:46:06.164Z (3 months ago)
Language: JavaScript
Size: 2.51 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Fungible Faucet Dapp

TL;DR:

The Fungible Faucet Dapp sends tokens to a user's wallet when they
click the "Mint Fungible Tokens" button.

Install the [prerequisites](https://agoric.com/documentation/getting-started/before-using-agoric.html). Then in a first terminal in the directory where you want to put your dapp, install the dapp:
```sh
agoric init --dapp-template dapp-fungible-faucet my-fungible-faucet
cd my-fungible-faucet
# Start the Agoric platform
agoric install && agoric start --reset
```

In a second terminal, deploy this contract and the API server
```sh
agoric deploy contract/deploy.js
agoric deploy api/deploy.js
```

In a third terminal,
```sh
# Navigate to the `ui` directory and start a local server
cd ui && yarn start
```
Then navigate to http://127.0.0.1:3000.

The Fungible Faucet Dapp is the simplest [Agoric
Dapp](https://agoric.com/documentation/dapps/). It
demonstrates the three important parts of
a dapp and how they should be connected:
1. the browser UI (the frontend)
2. the API server (the backend)
3. the on-chain contract

This dapp starts a local
blockchain on your computer, and deploys a basic contract to that
blockchain. It does not currently deploy or connect to the Agoric testnet.

This particular dapp UI is written in vanilla JS for simplicity (as
opposed to using a framework).

## Using the Dapp

1. Navigate to http://127.0.0.1:3000.
2. Enter `agoric open` in your terminal
3. A window for your wallet should open.
4. Under "Dapps" in the wallet, enable the FungibleFaucet Dapp:

![Enable Dapp](./readme-assets/enable-dapp.png)

5. Back on the Fungible Faucet page, click the "Mint Fungible Tokens" button.

![Mint Fungible Tokens](./readme-assets/mint-button.png)

6. Go back to your wallet and approve the offer stating that you want
1000 tokens.

![Mint Fungible Tokens](./readme-assets/approve-offer.png)

7. Once the offer has been approved, your wallet makes an offer to Zoe
on your behalf, giving you tokens from the `mintPayments` contract.
You will receive a message that the offer was successful and should
see the tokens in your purses.

![Offer Completed](./readme-assets/offer-completed.png)

![Tokens Received](./readme-assets/tokens-received.png)

To learn more about how to build Agoric Dapps, please see the [Dapp Guide](https://agoric.com/documentation/dapps/).

See the [Dapp Deployment Guide](https://github.com/Agoric/agoric-sdk/wiki/Dapp-Deployment-Guide) for how to deploy this Dapp on a public website, such as https://fungiblefaucet.testnet.agoric.com/