Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (107 loc) · 4.69 KB

CONTRIBUTING.md

File metadata and controls

124 lines (107 loc) · 4.69 KB

Contributing to Razor Network Datasources

If you wish to propose a new price feed to be added to the datasources used by the protocol, please follow the steps below:

Steps

  1. Start by forking the repository and creating your branch from master.
  2. Add the new job to mainnet/jobs.json and update mainnet/collections.json as needed with the correct jobIDs. (An example for testnet is given below)
  • For example, adding a new ETH/USD job to an existing collection for testnet:
[
  {
    "weight": 1,
    "power": 2,
    "selectorType": 0,
    "name": "ethusd_gemini",
    "selector": "last",
    "url": "https://api.gemini.com/v1/pubticker/ethusd"
  },
  ... ( 8 other entries here) ...,
  {
    "weight": 1,
    "power": 2,
    "selectorType": 0,
    "name": "ethusd_test",
    "selector": "selector[0]",
    "url": "https://www.example.com/"
  }
]

Now to include this new job into an existing collection in testnet/collections.json we need to add the serialized jobID to the desired collection. In this case we are adding ETH/USD job to the existing ethCollectionMedian collection:

[
  {
    "jobIDs": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], // 10 is added here which is the jobId of the new  ethusd_test job
    "aggregationMethod": 2,
    "power": 2,
    "name": "ethCollectionMedian",
    "tolerance": 500000
  },
  ... (other collections here) ...,
]

Note: jobIds are serialized

  • For example, adding a new ETHUSD collection for testnet, here we update the jobs required for the new collection:
[
  ... (10 other entries here) ...,
  {
    "weight": 1,
    "power": 2,
    "selectorType": 0,
    "name": "ethusd_test1",
    "selector": "selector[0]",
    "url": "https://www.example.com/1"
  },
  {
    "weight": 1,
    "power": 2,
    "selectorType": 0,
    "name": "ethusd_test2",
    "selector": "selector[0]",
    "url": "https://www.example.com/2"
  },
  {
    "weight": 1,
    "power": 2,
    "selectorType": 0,
    "name": "ethusd_test3",
    "selector": "selector[0]",
    "url": "https://www.example.com/3"
  },
]

Note: new jobs are always appended to the end of the jobs.json

Now to add these jobs to a new collection, the corresponding testnet/collections.json:

[
     ... (other collections here) ...,
  {
    "jobIDs": [11, 12, 13], // new jobIds added to jobs.json
    "aggregationMethod": 2,
    "power": 2,
    "name": "ETHUSD",
    "tolerance": 500000
  },
]

Parameters for Jobs

Parameter Description Example Value Type
weight The weight parameter designates the significance of each job's output. A higher weight indicates a greater relevance of the data obtained from that particular job. 1 Number
power The power parameter fine-tunes the decimal precision of the job query's results, ensuring both accuracy and consistency in the data procured. 2 Number
selectorType The selectorType parameter determines how the response from the URL should be parsed. Depending on the format of the data source's response, it can be set to JSON(0) or XHTML(1). 0 Number
name The name identifier for the job. "ethusd_gemini" String
selector The selector parameter pinpoints a specific pattern for extracting data from the URL source. "data[0]" String
url The URL where the data will be fetched from. "https://example.com/v1/pubticker/ethusd" String

Parameters for Collections

Parameter Description Example Value Type
jobIDs An array of serialized job IDs that are part of this collection. [1, 2, 3] Array of Numbers
aggregationMethod The aggregationMethod parameter denotes the technique adopted by stakers to consolidate data. It can be either "Median"(1) or "Mean" (2). 2 Number
power The power parameter dictates the extent of decimal shifts applied to the collection's result. 2 Number
name The name identifier for the collection. "ETHUSD" String
tolerance The tolerance parameter outlines the acceptable percentage variance from the value reported by the network. 500000 Number
  1. Execute the test suite using the command npm run test. It's crucial to ensure all tests pass. Additionally, please confirm that your code is properly formatted and aligns with the existing style guide.
  2. Issue a pull request (PR) to the upstream master branch.
  3. The proposed changes will be available for community discussion and review in GitHub discussions. Community members are welcome to provide feedback and votes on the proposal.