https://github.com/mento-protocol/mento-core-ts

https://github.com/mento-protocol/mento-core-ts

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mento-protocol/mento-core-ts
• Owner: mento-protocol
• License: gpl-3.0
• Created: 2023-01-17T16:57:24.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-13T08:36:53.000Z (5 months ago)
• Last Synced: 2024-10-23T19:16:24.014Z (3 months ago)
• Language: JavaScript
• Size: 37.1 KB
• Stars: 0
• Watchers: 7
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Mento Core TS

This package provides auto-generated typescript types and ethers.js factories for interacting with the Mento Protocol

## What is Mento?

The Mento protocol is a smart contract platform built on the Celo blockchain that enables the creation of stable value digital assets. Stable assets created with Mento can be classified as 'Hybrid stable assets' as they are algorithmic, transparent and backed by a over-collateralized, diversified portfolio of exogenous crypto assets([Mento Reserve](https://reserve.mento.org/)).

## Documentation

- [Protocol Documentation](https://docs.mento.org/mento-protocol/core/overview)

- [Stability Whitepaper](https://celo.org/papers/stability)

## Getting Started

```bash

# Get the latest code

git clone [email protected]:mento-protocol/mento-core-ts.git

# Change directory to the the newly cloned repo

cd mento-core-ts

# Install dev dependencies with yarn

yarn

# Install mento-core submodule dependency with forge

forge install

# Compile the mento-core dependency contracts with forge

forge build

# Generate types

yarn generatetypes

# Build the types

yarn build

```