README.md

Pods is a decentralized non-custodial options protocol on Ethereum. Read this article if you want to learn more!.

---

Full Documentation at pods-finance.gitbook

Table of Contents

• Documentation
• Compile
• Contracts
• Development
• Enviroment
• Testing
• Maintainers
• Contributing
• License

Documentation

Check out our full documentation at pods-finance.gitbook

Compile

$ yarn compile

Contracts

Checkout our full addresses list here

Enviroment

Our development environment consists of the following:

• Open Zeppelin Contracts - external contracts dependency
• Buidler - Development Framework
• Ethers plugins for Buidler
• Waffle (using Mocha/Chai) - unit testing
• Solhint - linter
• Prettier-solidity-plugin - formatter
• Solidity - Version ^0.6.8

Development

Lint

To lint all packages:

$ yarn lint

Prettier

To run prettier on all packages:

$ yarn prettier

Testing

yarn test

Contributing

We highly encourage participation from the community to help shape the development of Pods. If you are interested in contributing or have any questions, ping us on Twitter or Discord;

We use Yarn as a dependency manager and Buidler as a development environment for compiling, testing, and deploying our contracts. The contracts were written in Solidity v0.6.8.

Maintainers

• Guilherme Viana @ggviana [email protected]

• Robson Silva @Robsonsjre [email protected]

License

MIT