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

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,

  • 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.