Developer Guides and Tutorials

Developers can build a variety of experiences using one or more components of the Maker Protocol. This repo contains guides and tutorials to help you understand various approaches to integrate with the Maker Protocol and our partners by interfacing with smart contracts, SDKs, APIs, and products.

All guides are organized in sections and by proficiency levels within each section.

Vaults

• Maker Vault Integration Guide

• Monitoring Collateral Types and Vaults

• CDP Manager Guide

Dai

• Dai Token

• Dai in Smart Contracts

• Tracking Dai Supply

• How to use Permit Function and Relayers to Pay Gas for Dai Transactions in Dai

Dai Savings Rate (DSR)

• Dai Savings Rate integration guide

• DsrManager documentation

Emergency Shutdown

• Emergency Shutdown guide
• Emergency Shutdown Design Patterns

Developer Tools

• Test Chain Guide
• Introduction to Seth
• Working with DSProxy
• How to build a Dai.js wallet plugin

Oasis Exchange

• Intro to OasisDEX Protocol
• How to use Oasis Direct Proxy on OasisDEX Protocol
• OasisDEX Market Maker Guide
• OasisDEX Market Taker Guide

Governance

• Vote Proxy Setup: Air-gapped Machine

Keepers (Automatic CDP/Liquidation/Auction/Arbitraging Functionality)

• Keeper Guides Repo
• Auctions 101
• Auction Keeper Setup Guide
• Simple Arbitrage Keeper

Maker Protocol / Multi Collateral Dai (MCD)

• Introduction and Overview of Multi-Collateral Dai: MCD101
• Using MCD-CLI to create and close a Vault on Kovan
• Using Seth to create and close a Vault on Kovan
• Upgrading to MCD - overview for different partners
• Add a new collateral type to Maker Protocol - Kovan
• Intro to the Rate mechanism

Partners

• Setting up real money transfers using Wyre API

Gnosis Multisig Wallet

• Migrating Sai to Dai using Gnosis Multisig Wallet UI
• Activating Dai Savings Rate on Dai in Gnosis Multisig Wallet
• Vote Proxy Setup with Gnosis Multisig Wallet
• Add Dai to DSR through DsrManager with Gnosis Multisig

Partner compilations

In order to ensure that integration partners can get up and running quickly, relevant documentation for specific partner types have been compiled in a series of guides.

• Upgrading to Multi-Collateral Dai
• Exchanges
• Wallets
• Remittance services
• Market Makers

Contribution guidelines

We welcome submissions of guides and tutorials that cover new types of integrations! Following these guidelines will help us maintain consistency,

• Include all the sections present in this sample guide
• Create a folder with one markdown file using the same name

• Append a number if a guide needs to be split into multiple parts

• Use markdownlint for ensuring a consistent style in the documents. Rules are found in .markdownlint.json root folder.
• Use Markdown+Math for Math notations.

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.