Prerequisites:

To work with this project you will need to have the following softwares installed

• NodeJS
• ReactJS
• Brownie
• yarn

And if you plan to run your own chainlink node then take a look at its github repo to install and also you can visit its official docs on running a chainlink node.

How to use:

To use the project, clone the project by running this command:

git clone https://github.com/hussain18/PliantChain.git

Server

To start server run the following commands:

cd server
npm install
yarn install
npm start   

Front-End

To start front-end run:

cd frontEnd
npm install
npm start   

Note: the above commands are only for first time, after that you can go to respective directory and ren npm start to server or front-end

Define a bridge

To use chainlink external adaptor defined in server you need to create a chainlink bridge to add you external adopter to a chainlink node in which your chainlink jobs is defined.

Chainlink External Adaptor

• Example Input:

  {
      "orgAddress": "0xsampleaccountaddress1122333",
      "senderAddress": "0xsampleaccountaddress1122333",
      "receiverAddress": "0xsampleaccountaddress1122333",
      "jwtToken": "eyJhbGciOiJIUzsomjwttokenajasj1231"
  }

• Example Output:

  {
      "allInSystem": 11,
      "isProject": 2,
      "senderAuthority": 2,
      "receiverAuthority": 3,
  }

Chainlink Job Definitions

To learn how to create direct request job refer to chainlink docs on how to do it.

Job definition for our contract are as follow:

Pliant-Chian_Adapter JOB

    type = "directrequest"
    schemaVersion = 1
    name = "Pliant-Chian_Adapter"
    contractAddress = "YOUR_ORACLE_ADDRESS"
    maxTaskDuration = "0s"
    observationSource = """
        decode_log   [type=ethabidecodelog
                    abi="OracleRequest(bytes32 indexed specId, address requester, bytes32 requestId, uint256 payment, address callbackAddr, bytes4 callbackFunctionId, uint256 cancelExpiration, uint256 dataVersion, bytes data)"
                    data="$(jobRun.logData)"
                    topics="$(jobRun.logTopics)"]

        decode_cbor  [type=cborparse data="$(decode_log.data)"]
        fetch        [type=bridge name="test_pliant-chain_adaptor" requestData="{\\"id\\":$(jobSpec.externalJobID),\\"data\\":{\\"orgAddress\\": $(decode_cbor.orgAddress),\\"senderAddress\\":$(decode_cbor.senderAddress),\\"receiverAddress\\": $(decode_cbor.receiverAddress),\\"jwtToken\\": $(decode_cbor.jwtToken)}}"]
        parse        [type=jsonparse path="$(decode_cbor.jsonPath)" data="$(fetch)"]
        encode_data  [type=ethabiencode abi="(uint256 value)" data="{ \\"value\\": $(parse) }"]
        encode_tx    [type=ethabiencode
                    abi="fulfillOracleRequest(bytes32 requestId, uint256 payment, address callbackAddress, bytes4 callbackFunctionId, uint256 expiration, bytes32 data)"
                    data="{\\"requestId\\": $(decode_log.requestId), \\"payment\\": $(decode_log.payment), \\"callbackAddress\\": $(decode_log.callbackAddr), \\"callbackFunctionId\\": $(decode_log.callbackFunctionId), \\"expiration\\": $(decode_log.cancelExpiration), \\"data\\": $(encode_data)}"
                    ]
        submit_tx    [type=ethtx to="YOUR_ORACLE_ADDRESS" data="$(encode_tx)"]

        decode_log -> decode_cbor -> fetch -> parse -> encode_data -> encode_tx -> submit_tx
"""

Deploying Smart Contracts

You can deploy and test contracts using scripts in brownie OR you can do the same using remix IDE.

you only need to deploy ExternalAPIConsumer.sol and PLT.sol form contracts folder and follow the following steps to make transaction:

1. Approve PLT token
2. Fund ExternalAPIConsumer.sol with LINK token (Fee for each request is 0.1 LINK. Since four requests are done to make transaction, fund the contract with minimum 0.4 LINK tokens).
3. Call makeTransaction() in ExternalAPIConsumer.sol

And you have made a transaction...