https://github.com/dlc-link/stacks-chainlink-documentation

This repo holds updated details for setting up a Chainlink on Stacks node
https://github.com/dlc-link/stacks-chainlink-documentation

Last synced: 4 days ago
JSON representation

This repo holds updated details for setting up a Chainlink on Stacks node

• Host: GitHub
• URL: https://github.com/dlc-link/stacks-chainlink-documentation
• Owner: DLC-link
• Created: 2022-04-05T11:04:44.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-06-08T15:12:23.000Z (over 2 years ago)
• Last Synced: 2023-03-06T15:08:39.114Z (over 1 year ago)
• Language: JavaScript
• Size: 25.4 KB
• Stars: 8
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Chainlink on Stacks

Thanks to the team at [TinTash](https://bitbucket.org/tintash/), this project is based heavily on their initial work on [Chainlink integration onto Stacks](https://bitbucket.org/tintash/chainlink-integration/src/master/)

Using [Chainlink](https://chain.link) DRM (Direct Request Model) Oracles on [Stacks](https://stacks.org).

To enable chainlink oracle usage on stacks we have deployed a Chainlink Node with it's related smart contracts:

```

oracle:         ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.oracle

stxlink-token:  ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.stxlink-token

```

To test the system you can use the deployed `direct-request` contract. `contract-call.js` has code that calls

this contract to fetch ETH/USD price. After a successful call you can extract the data from the contract by calling the `read-data-value` function to get the response that is stored in the `data-value` variable in the contract:

```

curl -X POST https://stacks-node-api.testnet.stacks.co/v2/contracts/call-read/ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM/direct-request/read-data-value \

--header 'Content-Type: application/json' \

--data-raw '{

"sender": "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM",

"arguments":[] }'

```

This will give the response in the form of hex. You can decode it to string.

## Examples

Well commented example codes for both a consumer contract and the usage of it are available in this repository under `src/`.

## Writing a consumer contract

To utilize the oracle you need to write your own consumer contract. An example contract is available in this

repository (`direct-request.clar`).

You will need to implement the traits `.oracle-callback-trait.oracle-callback` and `.stxlink-transfer-trait.stxlink-transfer-trait`.

## Getting STXLINK tokens

To call the oracle contract you will need to have STXLINK tokens. To get these go to the [STXLINK Faucet](https://stx-link-faucet.dlc.link/) page and input a valid STX address.