porter-finance / v1-core

⛰️ Smart contracts powering the Porter protocol.
https://porter.finance
GNU Affero General Public License v3.0
4 stars 3 forks source link

Documentation updates #256

Closed Namaskar-1F64F closed 2 years ago

Namaskar-1F64F commented 2 years ago
BondFactory
- event BondCreated() variable namings missmatch from interface to actual contract.
  Fixed by sending tokenAmounts

- isBond(): Implemented as actual mapping in the contract. The documentation in the interface states that this is a function instead of the actual mapping
  Fixed by updating natspec

- isTokenAllowListEnabled(): Implemented as a boolean in the contract.
- tokenImplementation(): Implemented as immutable address in the contract.
- isIssuerAllowListEnabled(): Implemented as a boolean in the contract.
  Won't fix as keeping the documentation in the interface is more clear.

Bond
- function initialize(has owner param in interface vs bondOwner in contract)
  Fixed by using bondOwner in interface
- function sweep() has same issue as line above^ 
  Fixed by using sweepingToken in the interface.
- removed accessControl and replaced it with OwnerUpgradable but there are still notes about access control in IBond for the initialize function on L165.
  Updated the natspec

- collateralToken(): Implemented as public address
- convertibleRatio(): Implemented as public uint
- maturity(): Implemented as public uint
- paymentToken(): Implemented as public address
  Won't fix as keeping the documentation in the interface is more clear.

closes #255