https://github.com/Folks-Finance/folks-finance-xchain-contracts

The smart contracts for the Folks Finance Cross-Chain Lending Protocol.
https://github.com/Folks-Finance/folks-finance-xchain-contracts

blockchain cross-chain defi smart-contracts

Last synced: about 2 months ago
JSON representation

The smart contracts for the Folks Finance Cross-Chain Lending Protocol.

• Host: GitHub
• URL: https://github.com/Folks-Finance/folks-finance-xchain-contracts
• Owner: Folks-Finance
• License: other
• Created: 2024-07-03T09:22:35.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-07-12T12:44:56.000Z (2 months ago)
• Last Synced: 2024-07-19T12:51:30.515Z (2 months ago)
• Topics: blockchain, cross-chain, defi, smart-contracts
• Language: TypeScript
• Homepage:
• Size: 251 KB
• Stars: 10
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# folks-finance-xchain-contracts

The smart contracts for the Folks Finance Cross-Chain Lending Protocol.

## Getting Started

The repository uses both Hardhat and Foundry.

To setup:

1. Clone the repo

2. Run `npm install`

3. Run `forge install`

To build:

1. (Optional) run `npm run clean`

2. Run `npm run build`

## Smart Contracts

The smart contracts are split into 4 distinct folders:

- `contracts/bridge` contains all the smart contracts relating to sending messages (data and token) between the spoke chains and hub chain. Unless named specifically, they are deployed both in the spoke chains and hub chain.

- `contracts/hub` contains the smart contracts relating to the core business logic of the protocol. They are deployed only in the hub chain.

- `contracts/oracle` contains the smart contracts relating to the oracle for token price information. They are deployed only in the hub chain.

- `contracts/spoke` contains the smart contracts relating to the user entry point into the protocol. They are deployed only in the spoke chains (the hub chain may also be a spoke chain).

Within each you can also find `test` folder which contains smart contracts used for testing. These are not part of the protocol and won't be deployed.

## Testing

To run all tests `npm run test`.

To run specific tests `npm run test ${PATH_TO_FILE}`.

## License

If there is a license in a sub folder e.g. at `/contracts/oracle` then that applies for all files under it, otherwise refer to the license in the root folder.