Aconomy Contracts

Aconomy is a decentralized NFT Marketplace for illiquid real-world asset classes to leverage all the monetary benfits that gets unlocked when the assets are brought on-chain in the form of PiNFTs.

PiNFTs are special kind of NFTs which possess underlying value in the form of ERC20 tokens(stable coins).

PiNFT
  =
Asset NFT
  +
Underlying Value (ERC20 tokens)

Features

• Mint asset NFT
• Add ERC 20 tokens(PiNFT)
• Redeem/burn PiNFTs
• Sell/Auction PiNFTs
• Buy/Bid on PiNFTs
• Swap PiNFTs
• Pools
• TBD (coming many more)

Aconomy Pool Protocol

Any one create Pool and attest lender and borrower to that pool so that they borrower can request loan and other lenders in the pool can fill the loan, if they wish.

Features

Create Pool: Anyone can create their pool on top of Aconomy PoolRegistry Contract using the below function.

    function createPool(
        uint32 _paymentCycleDuration,
        uint32 _paymentDefaultDuration,
        uint32 _loanExpirationTime,
        uint16 _poolFeePercent,
        uint16 _apr,
        string calldata _uri,
        bool _requireLenderAttestation,
        bool _requireBorrowerAttestation
    ) 

It will emit a poolCreated event that will return the PoolId and PoolAddress for the Pool.

Add Lender/Borrower: Pool Owner can add lender and borrower for their Pool using the below function.

For Lender

    function addlender(
        uint256 _poolId,
        address _lenderAddress,
        uint256 _expirationTime
    ) 

For Borrower

    function addBorrower(
        uint256 _poolId,
        address _borrowerAddress,
        uint256 _expirationTime
    ) 

Request Loan: Attested Borrower can make requests for loan in the Pool.

    function loanRequest(
        address _lendingToken,
        uint256 _poolId,
        uint256 _principal,
        uint32 _duration,
        uint16 _APR,
        address _receiver
    ) public returns (uint256 loanId_)

Returns the Loan ID generated.

Accept Loan: Attested Lenders can accept the loans requested in that pool .

    function AcceptLoan(uint256 _loanId)
        external
        returns (
            uint256 amountToAconomy,
            uint256 amountToPool,
            uint256 amountToBorrower
        )

Returns:
uint256 amountToAconomy - The aconomy protocol charge.
uint256 amountToPool - The amount that will go to the Pool owner.
uint256 amountToBorrower - The remaining amount will go to the borrower.

View current amount to repay for Borrower: Borrower can check their current amount to repay to loan for healthy credit status.

    function viewInstallmentAmount(uint256 _loanId)
        public
        view
        returns (uint256)

View current amount to repay for Borrower: Borrower can check their Full amount to be repaid towards the loan after calculating the interest till that moment.

    function viewFullRepayAmount(uint256 _loanId)
        public
        view
        returns (uint256)

Repay Loan: Borrower should repay their accepted loan per installments .

    function repayYourLoan(uint256 _loanId) external

Repay Full Loan: Borrower can Fully repay their accepted loan .

    function repayFullLoan(uint256 _loanId) external

FundingPool functions

Supply to Pool: Attested Lenders can bid for supply to pool after checking the APR and other information of that pool address. This function is called in deployPool contract in the address that is returned during createPool.

    function supplyToPool(
        uint256 _poolId,
        address _ERC20Address,
        uint256 _amount,
        uint32 _maxLoanDuration,
        uint16 _interestRate,
        uint256 _expiration
    ) external 

The function will emit a event that will return a BidId:

 event SupplyToPool(
        address indexed lender,
        uint256 indexed poolId,
        uint256 BidId,
        address indexed ERC20Token,
        uint256 tokenAmount
    );

Accept Bid: Pool Owner can accept the bid for getting funding in that pool .

    function AcceptBid(
        uint256 _poolId,
        address _ERC20Address,
        uint256 _bidId,
        address _lender,
        address _receiver
    ) external

It will emit a event which has the payment to do per cycle.

event AcceptedBid(
        address reciever,
        uint256 BidId,
        uint256 PoolId,
        uint256 Amount,
        uint256 paymentCycleAmount
    )

View current amount to repay for Pool Owner: Pool Owner can check their current amount to repay to the funding given to their pool, for healthy credit status.

    function viewInstallmentAmount(
        uint256 _poolId,
        address _ERC20Address,
        uint256 _bidId,
        address _lender
    ) public view returns (uint256)

View Full amount to repay for Pool Owner: Pool Owner can check their full amount to repay to the funding given to their pool, for healthy credit status.

    function viewFullRepayAmount(
        uint256 _poolId,
        address _ERC20Address,
        uint256 _bidId,
        address _lender
    ) public view returns (uint256)

Repay Funding amount per cycle: Pool Owner should repay their accepted loan per cycle .

    function RepayInstallment(
        uint256 _poolId,
        address _ERC20Address,
        uint256 _bidId,
        address _lender
    ) external

Repay Funding amount Full: Pool Owner can repay the full amount .

    function RepayFullAmount(
        uint256 _poolId,
        address _ERC20Address,
        uint256 _bidId,
        address _lender
    ) external

Withdraw Bid: Lender can withdraw their bid after expiration time is over .

    function Withdraw(
        uint256 _poolId,
        address _ERC20Address,
        uint256 _bidId,
        address _lender
    ) external

Installation

• Clone the repository

• Install the dependancies

  npm install

Compile Contracts

• Run the truffle compilation

  truffle compile --all

Test Contracts

Truffle Tests

• Run the local truffle develpment environment and run the test cases within the environment

  truffle develop
  test

Foundry Tests

• Run the following commands to compile contracts and run tests

  forge build
  forge test

Deploy contracts to the BSC testnet

• Create a .env file, store a metamask private key and bscscan api(To verify contracts after deployment).

• the .env stucture should be as follows:

  PK=<Private Key>
  BSC_API=<API key>
  FEE_ADDRESS=<Fee Receiving Address>

• Then run the truffle migration command

  truffle migrate --reset --network bscTestnet