Skip to content

Latest commit

 

History

History
83 lines (66 loc) · 5.83 KB

README.md

File metadata and controls

83 lines (66 loc) · 5.83 KB
Raw

Chainlink dYdX Rewards Composite Adapter

The goal of this system is to calculate and publish, via a decentralized network of oracle signers, the DYDX token rewards earned by traders using the dYdX layer 2 exchange. Rewards are stored in a Merkle tree, which contains the cumulative rewards earned by each user since the start of the distribution program.

Configuration

The adapter takes the following environment variables:

Required? Name Description Options Defaults to
✅ PRIVATE_KEY Private key of account used to make special callbacks
✅ ETHEREUM_RPC_URL Ethereum RPC URL node
ETHEREUM_CHAIN_ID The chain id to connect to 1
TREASURY_CLAIM_ADDRESS The address of the treasury's merkle root claim contract 0x95EaBB0248D013b9F59c5D5256CE11b0a8140B54
TRADER_REWARDS_AMOUNT 3835616e18
MARKET_MAKER_REWARDS_AMOUNT 1150685e18
TRADER_SCORE_A The a variable in the formula for individual trading scores.
TRADER_SCORE_B The b variable in the formula for individual trading scores.
TRADER_SCORE_C The c variable in the formula for individual trading scores.

Additional environment variables must be set according to the IPFS adapter. This composite adapter executes the code from the IPFS source adapter. As such the same configuration apply to this adapter. See ../../sources/ipfs/README.md for more details. The IPFS adapter environment variables need to be prefixed with IPFS_.

Running

See the Composite Adapter README for more information on how to get started.

Input Parameters

Required? Name Description Options Defaults to
method The method to call poke poke

Poke Method

Input Params

Required? Name Description Options Defaults to
✅ traderRewardsAmount Maximum rewards distributed each epoch as trading incentives
✅ marketMakerRewardsAmount Maximum rewards distributed each epoch as market maker incentives
✅ ipnsName The fixed IPNS name to which all oracle rewards data is published by dYdX
traderScoreAlpha or traderScoreA Is a parameter used in the calculation of trader rewards
traderScoreB Is a parameter used in the calculation of trader rewards
traderScoreC Is a parameter used in the calculation of trader rewards
✅ callbackAddress
✅ newEpoch
✅ activeRootIpfsCid

Sample Input

{
  "id": "1",
  "data": {
    "traderRewardsAmount": 5e23,
    "marketMakerRewardsAmount": 2e23,
    "ipnsName": "k51qzi5uqu5dlkb9yviadsfl3uxndbkyhf4n97u1t1np5e9f67zwmjz6yk9m9k",
    "traderScoreAlpha": 700000000000000000,
    "newEpoch": 0,
    "activeRootIpfsCid": "bafkreigx6x553cdksm5gj2hh2fkhs2csjnmnny3zxp3tcyzevfj3f3ekli"
  }
}

Sample Output

{
  "jobRunID": "1",
  "result": 1,
  "statusCode": 200,
  "data": {
    "result": 1
  }
}