supersorbet / protocolink-logics

Protocol integrator of Protocolink

@protocolink/logics

An SDK that build protocol logics for Protocolink

How to contribute?

Initial Setup

1. Fork this repository.
2. Set up your development environment and install the required dependencies.

Contribution Steps

1. Create a New Logic:

• Add a new folder under src/logics named after the protocol (protocolId), using Hyphenation format.
• Create a new logic file under src/logics/{protocolId}, named with the action name (logicId). Prefix it with logic. and use Hyphenation format. The file name should be logic.{logicId}.ts.

2. Implement the Logic:

• Implement the Logic class in the logic file using PascalCase. Append Logic to the action name.
• Extend the core.Logic class.
• Implement the following interfaces based on the requirements:
  • core.LogicTokenListInterface: The tokens list function.
  • core.LogicOracleInterface: The quotation function.
  • core.LogicBuilderInterface: The txdata encode function for interacting with contracts.

Example:

class LogicExampleLogic
  extends core.Logic
  implements core.LogicTokenListInterface, core.LogicOracleInterface, core.LogicBuilderInterface {
  // Your implementation here
}

3. Reference Examples:

• Explore reference examples for different categories:
  • Lending: Aave V3, Compound V3
  • Swap: Uniswap V3, ParaSwap V5
  • FlashLoan: Aave V3, Balancer V2
• More: GO

4. Unit Testing:

• Write tests that won't fail based on block number increments.
• Test files are in the same path as the logic files, named logic.{logicId}.test.ts.
• Write tests for functions like getTokenList() and build() as needed.

5. Integration Testing:

• Write tests that interact with the Router contract in real time.
• Test files are in test/logics/{protocolId}/, named {logicId}.test.ts.
• Utilize Logic's quotation functions to generate Logic Data for contract interactions.
• Verify transaction success and expected changes in user asset balances.

6. Submit a Pull Request (PR):

• Use the PR template for PR content. Fill in the template and submit the PR.
• Enable "Allow edits by maintainers" when creating the PR.
• If your PR isn't merged promptly, feel free to ask for assistance on our Discord.

Get Involved and Learn More

• Discord: Join Our Community

CLI

• Install the required dependencies

  yarn install

• Generate protocol's abi TypeScript classes

  # - abi files: src/{protocol}/abis/*.json
  # - contracts dir: src/{protocol}/contracts
  yarn cli typechain

• Run protocol's tests

  yarn cli test

• Run protocol's script

  yarn cli script

Hardhat e2e testing

yarn hardhat test [test file]

Install

Install the package via npm:

npm install --save-dev @protocolink/logics

or yarn:

yarn add --dev @protocolink/logics