Maker Protocol Technical Docs
  • MakerDAO Technical Docs
  • Getting Started
    • Maker Protocol 101
  • Smart Contract Modules
    • Dai Module
      • Dai - Detailed Documentation
    • Core Module
      • Vat - Detailed Documentation
      • Spot - Detailed Documentation
    • Collateral Module
      • Join - Detailed Documentation
    • Liquidation 2.0 Module
    • System Stabilizer Module
      • Flapper - Detailed Documentation
      • Flopper - Detailed Documentation
      • Vow - Detailed Documentation
    • Oracle Module
      • Oracle Security Module (OSM) - Detailed Documentation
      • Median - Detailed Documentation
    • MKR Module
    • Governance Module
      • Spell - Detailed Documentation
      • Pause - Detailed Documentation
      • Chief - Detailed Documentation
    • Rates Module
      • Pot - Detailed Documentation
      • Jug - Detailed Documentation
    • Proxy Module
      • Proxy Actions - Detailed Documentation
      • Vote Proxy - Detailed Documentation
      • CDP Manager - Detailed Documentation
      • DSR Manager - Detailed Documentation
    • Flash Mint Module
    • Maker Protocol Emergency Shutdown
      • Emergency Shutdown for Partners
      • The Emergency Shutdown Process for Multi-Collateral Dai (MCD)
      • End - Detailed Documentation
      • ESM - Detailed Documentation
  • Glossary
    • MCD Glossaries
    • Smart Contract Annotations
  • Deployment Addresses
    • Maker Protocol Deployments
  • Security
    • Security for the Maker Protocol
  • Building on top of the Maker Protocol
    • Developer Guides and Tutorials
    • The Dai Javascript Library of the Maker Protocol
      • Getting started
      • Configuration
        • Plugins
      • Vault manager
      • Collateral types
      • Dai Savings Rate
      • Currency units
      • System data
      • Advanced
        • Transaction manager
        • DSProxy
        • Events
        • Using multiple accounts
        • Adding a new service
      • Single-Collateral Sai
        • Collateralized Debt Position
        • CDP Service
        • Price Service
        • System Status
        • Tokens
        • Token Conversion
        • Exchange Service
    • Pymaker
  • Keepers
    • The Auctions of the Maker Protocol
    • Auction Keepers
      • Auction Keeper Bot Setup Guide
    • Market Maker Keepers
      • Market Maker Keeper Bot Setup Guide
    • Cage Keeper
    • Simple Arbitrage Keeper
    • Chief Keeper
  • Command-line Interfaces
    • Seth
    • Multi Collateral Dai (MCD) CLI
    • Dai and Collateral Redemption during Emergency Shutdown
    • Emergency Shutdown (ES) CLI
  • Miscellaneous
    • Liquidations 1.2 System (Deprecated)
      • Cat - Detailed Documentation
      • Flipper - Detailed Documentation
    • SCD <> MCD Migration
    • Upgrading to Multi-Collateral Dai Guide
Powered by GitBook
On this page
  • Vaults
  • Dai
  • Dai Savings Rate (DSR)
  • Emergency Shutdown
  • Developer Tools
  • Oasis Exchange
  • Governance
  • Keepers (Automatic CDP/Liquidation/Auction/Arbitraging Functionality)
  • Maker Protocol / Multi Collateral Dai (MCD)
  • Partners
  • Gnosis Multisig Wallet
  • Partner compilations
  • Contribution guidelines
  • License
Export as PDF
  1. Building on top of the Maker Protocol

Developer Guides and Tutorials

PreviousSecurity for the Maker ProtocolNextThe Dai Javascript Library of the Maker Protocol

Last updated 4 years ago

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

Dai

Dai Savings Rate (DSR)

Emergency Shutdown

Developer Tools

Oasis Exchange

Governance

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

Maker Protocol / Multi Collateral Dai (MCD)

Partners

Gnosis Multisig Wallet

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.

Contribution guidelines

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

  • Create a folder with one markdown file using the same name

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

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.

Include all the sections present in this

Use for ensuring a consistent style in the documents. Rules are found in .markdownlint.json root folder.

Use for Math notations.

Maker Vault Integration Guide
Monitoring Collateral Types and Vaults
CDP Manager Guide
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 integration guide
DsrManager documentation
Emergency Shutdown guide
Emergency Shutdown Design Patterns
Test Chain Guide
Introduction to Seth
Working with DSProxy
How to build a Dai.js wallet plugin
Intro to OasisDEX Protocol
How to use Oasis Direct Proxy on OasisDEX Protocol
OasisDEX Market Maker Guide
OasisDEX Market Taker Guide
Vote Proxy Setup: Air-gapped Machine
Keeper Guides Repo
Auctions 101
Auction Keeper Setup Guide
Simple Arbitrage Keeper
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
Setting up real money transfers using Wyre API
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
Upgrading to Multi-Collateral Dai
Exchanges
Wallets
Remittance services
Market Makers
sample guide
markdownlint
Markdown+Math