Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/govtechsg/cbdc-purpose-bound-money
The monorepo for the Purpose Bound Money (PBM) smart contracts and websites.
https://github.com/govtechsg/cbdc-purpose-bound-money
blockchain cbdc defi digital-currency digital-money ethereum evm javascript pbm polygon reactjs smart-contracts solidity typescript
Last synced: 4 days ago
JSON representation
The monorepo for the Purpose Bound Money (PBM) smart contracts and websites.
- Host: GitHub
- URL: https://github.com/govtechsg/cbdc-purpose-bound-money
- Owner: GovTechSG
- Created: 2023-10-05T05:39:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-04T16:09:34.000Z (9 months ago)
- Last Synced: 2024-11-09T04:12:30.393Z (about 2 months ago)
- Topics: blockchain, cbdc, defi, digital-currency, digital-money, ethereum, evm, javascript, pbm, polygon, reactjs, smart-contracts, solidity, typescript
- Language: TypeScript
- Homepage: https://pbm.money
- Size: 5.97 MB
- Stars: 3
- Watchers: 8
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Project Orchid:
Purpose Bound Money (PBM)
🔗 Website: pbm.money
## Introduction
The Purpose Bound Money (PBM) proposes a protocol for the use of digital money under specified conditions. As part of a wider pilot in Project Orchid, this version of the protocol releases escrow payments automatically after a specified period. Visit pbm.money for more information on the key features.
## Setup
```bash
yarn install
```
## Packages
This repository is a monorepo of the source files, including the smart contracts, implemented for the PBM protocol.
| Package | Description | Actual Site |
| ---------------- | ---------------------------------------------------------------------- | ----------------------------- |
| `@pbm/contracts` | Smart contracts used for the PBM token | – |
| `@pbm/app` | The Web3 application frontend for interacting with the smart contracts | [Link](https://app.pbm.money) |
| `@pbm/web` | The main website at pbm.money homepage | [Link](https://pbm.money) |
## Getting Started
### Smart Contract Deployments
The following tasks have been implemented using Hardhat for both deploying the smart contracts to the blockchain and verifying them.
| Task Name | Description |
| -------------------- | ----------------------------------------- |
| `deploy:pbm` | Deploy PBM token |
| `deploy:vault` | Deploy PBM vault |
| `dsgd:mint` | Mint underlying asset token (for testing) |
| `verify:pbm` | Verify PBM token |
| `verify:pbm:proxy` | Verify PBM token proxy |
| `verify:vault` | Verify PBM vault |
| `verify:vault:proxy` | Verify PBM vault proxy |
##### Usage
```bash
yarn hardhat --network --
```
### Start Application Frontend
#### Production mode
```bash
yarn build:app && yarn start:app
```
#### Development mode
```bash
yarn start:app:dev
```
### Start Main Website
#### Production mode
```bash
yarn build:web && yarn start:web
```
#### Development mode
```bash
yarn start:web:dev
```
### Run Smart Contract Tests
```bash
yarn test:contracts:coverage
```
### Continuous Integration/Deployment
The CI pipeline is setup to deploy to a staging and production environment based on their branches, `staging` and `main`, respectively.
#### Staging Environment
Please raise an issue on Github to request for access to the staging environment if needed.