-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: ag-admin readme: goal, 1st step
- Loading branch information
Showing
1 changed file
with
24 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,31 @@ | ||
| # Fungible Faucet Dapp | ||
| # Ag Admin - Administrative processes with Agoric (WIP) | ||
|
|
||
| TL;DR: | ||
| ## Ping Plugin | ||
|
|
||
| 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 checkout the latest `beta` release for the sdk: | ||
| ```sh | ||
| cd agoric-sdk | ||
| git checkout beta | ||
| yarn && yarn build | ||
| ``` | ||
|
|
||
| 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 --dapp-branch beta my-fungible-faucet | ||
| cd my-fungible-faucet | ||
| # Start the Agoric platform | ||
| agoric install && agoric start --reset | ||
| # We first did the usual start to an Agoric dApp... | ||
| # git clone | ||
| # agoric install | ||
| ag-admin$ agoric deploy api/deploy.js --allow-unsafe-plugins | ||
| ? Enable unsafe (unconfined) plugins for this deployment? Type 'yes' if you are sure: yes | ||
| Open CapTP connection to ws://127.0.0.1:8000/private/captp...o | ||
| agoric: deploy: running /home/connolly/projects/agoric/ag-admin/api/deploy.js | ||
| agoric: deploy: Deploy script will run with Node.js ESM | ||
| agoric: deploy: Installing unsafe plugin "/home/connolly/projects/agoric/ag-admin/api/src/plugin-sheets.js" | ||
| agoric: deploy: Loading plugin "/home/connolly/projects/agoric/ag-admin/_agstate/agoric-servers/dev/plugins/_home_connolly_projects_agoric_ag-admin_api_src_plugin-sheets.js" | ||
| { sheetsPlugin: Object [Alleged: stableForwarder] {} } | ||
| { answer: 'GS: Watson, come quickly!' } | ||
| ``` | ||
|
|
||
| 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: | ||
|
|
||
|  | ||
|
|
||
| 5. Back on the Fungible Faucet page, click the "Mint Fungible Tokens" button. | ||
|
|
||
|  | ||
|
|
||
| 6. Go back to your wallet and approve the offer stating that you want | ||
| 1000 tokens. | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
|  | ||
| ## Request 1 BLD (TODO) | ||
|
|
||
| To learn more about how to build Agoric Dapps, please see the [Dapp Guide](https://agoric.com/documentation/dapps/). | ||
| Goal: reify the [Request 1 BLD](https://github.com/Agoric/validator-profiles/wiki/Request-1-BLD) process as Zoe smart contract(s). on devnet? | ||
|
|
||
| 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/ | ||
| - ag-solo plug-ins for external | ||
| - inputs: | ||
| - [ ] - Discord API for finding `authorizedRequests()` | ||
| - [ ] Tendermint RPC, i.e. https GET on `searchBySender()` | ||
| - Outputs: | ||
| - [ ] Google sheet with status | ||
| - [ ] something to prompt the (human) signer? |