@web-stablecoin/protocol v1.0.1

Web Stablecoin Protocol

The web stablecoin protocol stabilizes cryptocurrencies using smart contracts.

You can view the contract code in the contracts folder. Documentation coming soon!

Usage

This repository contains the source code for the web system and examples to jumpstart development. The contract ABIs are accessible through the @web-stablecoin/protocol NPM package.

Installation

This project uses Node.js and assumes you have it installed.

Add @web-stablecoin/protocol to your project with npm or yarn:

npm install @web-stablecoin/protocol --save

Example

Below is a code snippet that shows how to import the contract ABI and call a contract method using ethers.

/**
 * This example gets the total supply of the USD token by
 * calling the `totalSupply` method on the ERC20 contract at
 * <address>.
 */
import UsdABI from "@web-stablecoin/protocol/artifacts/contracts/tokens/Usd.sol/USD.json";
import { Contract } from "ethers";

const USD_ERC20_ADDRESS = "<address>";

const usdErc20 = new Contract(
  USD_ERC20_ADDRESS,
  UsdABI.abi,
  library.getSigner()
);
const totalSupply = await usdErc20.totalSupply();
console.log("Total supply:", totalSupply);

Development

See the developer guide for details.

Deployment

See the deployment guide for details.

Administration

See the administration guide for details.

Contract Addresses

Goerli Testnet

TODO