Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Tests
on:
push:
branches:
- main
tags:
- v*
pull_request:

jobs:
Tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
cache: 'npm'
- name: Install dependencies
run: npm install
- name: Run tests
run: npx hardhat test
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
# UsingTellorLayer
[![Tests](https://github.com/tellor-io/UsingTellorLayer/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/tellor-io/UsingTellorLayer/actions/workflows/tests.yml)

Use this package to install the Tellor user contracts and integrate Tellor into your contracts.
# UsingTellorLayer

Once installed this will allow your contracts to inherit the functions from ITellorDataBridge.
Use this package to install the Tellor user contracts and test helper functions, and to integrate Tellor into your contracts.

## How to Use

Use this package with your own npm project.

### Install

```bash
npm install usingtellorlayer
```

### Usage
```solidity
import "usingtellorlayer/contracts/interfaces/ITellorDataBridge.sol";

Expand All @@ -17,7 +26,7 @@ contract PriceContract {
dataBridge = ITellorDataBridge(_dataBridge);
}

function resolveMarket(
function updateOracleData(
OracleAttestationData calldata _attestData,
Validator[] calldata _currentValidatorSet,
Signature[] calldata _sigs
Expand All @@ -32,10 +41,10 @@ contract PriceContract {
```

### Addresses:
Find Tellor contract addresses [here](https://docs.tellor.io/layer-docs/using-tellor-data/integrating-tellor-data#contract-addresses).
Find Tellor contract addresses [here](https://docs.tellor.io/tellor/using-tellor-data/contracts-reference).

## Testing
Open a git bash terminal and run this code:
## Testing this Repo
Open a terminal and run:

```bash
git clone https://github.com/tellor-io/UsingTellorLayer.git
Expand All @@ -46,7 +55,7 @@ npx hardhat test

## Secure Integrations

For secure integrations, refer to the [tellor docs](https://docs.tellor.io/layer-docs/using-tellor-data/integrating-tellor-data#contract-addresses). Also, see example integrations in the [SampleLayerUser repo](https://github.com/tellor-io/SampleLayerUser).
For secure integrations, refer to the [tellor docs](https://docs.tellor.io/tellor/using-tellor-data/integrating-tellor-data). Also, see example integrations in the [SampleLayerUser repo](https://github.com/tellor-io/SampleLayerUser).

## Maintainers
@themandalore
Expand Down
1 change: 0 additions & 1 deletion artifacts/build-info/3d7102a7b74c245b885295d3f9e627a4.json

This file was deleted.

1 change: 1 addition & 0 deletions artifacts/build-info/d05a179e09b13bc0470a724f18837726.json

Large diffs are not rendered by default.

This file was deleted.

198 changes: 0 additions & 198 deletions artifacts/contracts/YoloTellorUser.sol/YoloTellorUser.json

This file was deleted.

4 changes: 4 additions & 0 deletions artifacts/contracts/bridge/ECDSA.sol/ECDSA.dbg.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"_format": "hh-sol-dbg-1",
"buildInfo": "../../../build-info/d05a179e09b13bc0470a724f18837726.json"
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"_format": "hh-sol-artifact-1",
"contractName": "ECDSA",
"sourceName": "contracts/testing/bridge/ECDSA.sol",
"sourceName": "contracts/bridge/ECDSA.sol",
"abi": [
{
"inputs": [],
Expand Down Expand Up @@ -31,8 +31,8 @@
"type": "error"
}
],
"bytecode": "0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220a7d372f3953d1c8a8d037e598383e4dd43055a0d4ba385226c2c76194018693464736f6c63430008130033",
"deployedBytecode": "0x6080604052600080fdfea2646970667358221220a7d372f3953d1c8a8d037e598383e4dd43055a0d4ba385226c2c76194018693464736f6c63430008130033",
"bytecode": "0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea26469706673582212203dec2788d440925c985174c1404cfb0db8f55d003f4be6111c476eea2aa844cb64736f6c63430008130033",
"deployedBytecode": "0x6080604052600080fdfea26469706673582212203dec2788d440925c985174c1404cfb0db8f55d003f4be6111c476eea2aa844cb64736f6c63430008130033",
"linkReferences": {},
"deployedLinkReferences": {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"_format": "hh-sol-dbg-1",
"buildInfo": "../../../build-info/d05a179e09b13bc0470a724f18837726.json"
}
Loading