KAIROS LOAN

NFT as collateral lending protocol. Contracts repository

Docs

Documentation has been moved to the kairos book.

Install

npm i

Kairos uses foundry as development framework, install it to use this repository.

Test

forge test

Test architecture

In the test/Commons folder are helpers and not actual tests. TestCommons has general helpers. An example of the contract deployment can be found in SetUp. Loggers exposes methods to look into structs. Contracts testing external methods inherit from External that exposes the kairos contract diamond. Contracts testing internal methods inherit from Internal that itself contains all internal methods normally found in multiple facets in the same contract by extending BigKairos.

."something".sol reference

• .h as "header" for function selectors getters
• .s as "script"
• .t as "test"

Deploying

.env vars expected :

• GOERLI_URL
• DEPLOYER_KEY

Developing

Imports style policy

first import external dependencies (such as the ones from open zeppelin)
leave a blank line then import interfaces (if they are from this repo)
leave another blank line
finally import local code files

Adding a facet

• implement
• test
• natspec
• interface
• create its function selector getters
• add it to contracts creator's createContracts()
• add it to contracts creator's getFacetCuts()
• add it to deployFunc's facetNames
• add it to IKairos
• add it to BigKairos
• add it to the docs