Skip to content

Quickstart: Transmitter #2770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 46 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
dd0fa2b
added simple screenshot
dev-dist Jun 26, 2025
a068188
added transmitter config sample
dev-dist Jun 26, 2025
3761462
moved transmitter into quickstarts folder
dev-dist Jun 26, 2025
52cdf80
migrate transmitter quickstart guide
dev-dist Jun 26, 2025
a75fdc6
added data streams to products enum
dev-dist Jun 26, 2025
4d4edc2
minor nits
dev-dist Jun 26, 2025
67d96eb
minor nit
dev-dist Jun 26, 2025
5a65ab0
nit
dev-dist Jun 26, 2025
7bc27ec
update image
dev-dist Jun 27, 2025
562dc69
feedback
dev-dist Jun 27, 2025
a9950de
link
dev-dist Jun 27, 2025
ab7a1ee
clarified requirements
dev-dist Jun 27, 2025
a6a2d30
provided reference in configuration callout
dev-dist Jun 27, 2025
e81ad4d
update
dev-dist Jun 27, 2025
2b5a84f
minor nits
dev-dist Jun 27, 2025
3068b17
tip->disclaimer
dev-dist Jun 27, 2025
6b38971
overview and high level architecture setting
dev-dist Jun 27, 2025
778bbbc
nit
dev-dist Jun 27, 2025
594a71b
update tip placement
dev-dist Jun 27, 2025
e8cfcb1
title case
dev-dist Jun 27, 2025
6903103
updated env with correct values
dev-dist Jun 27, 2025
151512e
tiny nit
dev-dist Jun 27, 2025
a8a80b0
added sample log output
dev-dist Jun 27, 2025
ad0fa12
foundry steps placeholder update and transmitter standardarization
dev-dist Jun 27, 2025
997f2c9
better installation steps and sample management
dev-dist Jun 27, 2025
6700817
nit
dev-dist Jun 27, 2025
3206e4d
updated sample with datastreamsfeed.sol
dev-dist Jun 30, 2025
7420960
updated instructions with verified foundry deployment
dev-dist Jun 30, 2025
d63f861
removed datastreamsfeed.sol (no remix instructions)
dev-dist Jun 30, 2025
5876c68
updated, reformatted, and reoredered quickstart re: new config, contr…
dev-dist Jul 1, 2025
5f9da44
arbitrum sepolia -> avalanche fuji
dev-dist Jul 1, 2025
f6bdc75
fix error link
dev-dist Jul 1, 2025
b694b42
updated contract deployment steps based on avax testing
dev-dist Jul 1, 2025
29230b6
updated guide with new link funded verifier step
dev-dist Jul 1, 2025
a486f81
updated with notes from successful fresh run through
dev-dist Jul 1, 2025
b491fdc
architecture steps clarification
dev-dist Jul 1, 2025
412256f
renamed temp repo
dev-dist Jul 1, 2025
150eabf
added transmitter reference in overview + sidebar/resources link
dev-dist Jul 2, 2025
43dd41a
clarified link is withdrawn from contract allownance, not wallet
dev-dist Jul 2, 2025
9d42ab0
removed quickstart from sidebar, bad experience
dev-dist Jul 2, 2025
5816b2e
minor nits and grammar
dev-dist Jul 2, 2025
8058ec0
more minor fixes and linking
dev-dist Jul 2, 2025
62e47b5
sentence case title
dev-dist Jul 2, 2025
6e020c9
updated example config file name to match latest change
dev-dist Jul 3, 2025
eb65a75
Merge branch 'main' into qs-transmitter
dev-dist Jul 3, 2025
92d2028
on-chain->onchain, off-chain -> offchain
dev-dist Jul 3, 2025
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
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/content.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ enum Products {
FUNCTIONS = "functions",
VRF = "vrf",
FEEDS = "feeds",
STREAMS = "streams",
GENERAL = "general",
CHAINLINK_LOCAL = "chainlink-local",
}
Expand All @@ -18,6 +19,7 @@ export const productsInfo: Record<Products, { name: string; slug: string }> = {
functions: { name: "Functions", slug: "chainlink-functions" },
vrf: { name: "VRF", slug: "vrf" },
feeds: { name: "Data Feeds", slug: "data-feeds" },
streams: { name: "Data Streams", slug: "data-streams" },
general: { name: "General", slug: "/" },
"chainlink-local": { name: "Chainlink Local", slug: "chainlink-local" },
}
Expand Down
21 changes: 20 additions & 1 deletion src/content/data-streams/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,27 @@ Access data directly through REST APIs or WebSocket connections using our SDKs:

1. Implement Verification: Add [onchain verification](/data-streams/reference/onchain-verification) to ensure data authenticity in your smart contracts.

### Streams Trade: An alternative implementation
## Alternative implementations

### Streams Trade

For applications that require automated data retrieval and execution, Streams Trade combines Chainlink Data Streams with [Chainlink Automation](/chainlink-automation) to deliver automated trade execution with frontrunning mitigation. This approach suits dApps that require automated, trust-minimized trade execution and high-frequency market data.

[Learn more about Streams Trade](/data-streams/streams-trade).

### Data Streams Transmitter

<Aside type="caution" title="Disclaimer">
The Data Streams Transmitter and the reference consumer contract are community-built tools. The Transmitter is
developed and maintained by [HackBG](https://github.com/hackbg) and the contract is a community endeavour. These are
not official Chainlink products and are not supported by Chainlink Labs. No warranties or guarantees are provided.
Please do your own research and audit the code before using this tool in a production environment.
</Aside>

While Data Streams provides low-latency data offchain, bringing verified reports onchain requires developers to build and maintain a custom service to monitor the feed and push updates.

[Data Streams Transmitter](https://github.com/hackbg/chainlink-datastreams-transmitter) is a configurable service that you operate on your own infrastructure. It offers a simplified process for DevOps teams and Infrastructure Managers, handling the core logic of connecting to the off-chain Data Streams network via a WebSocket, monitoring for new reports, and relaying them to your smart contracts. The service also includes a UI for on-the-fly configuration and monitoring.

Based on predefined conditions like time intervals or price deviations, the Transmitter bundles and sends a report for onchain verification and consumption. This approach suits dApps that need fresh data pushed onchain based on custom logic, without the overhead of building and maintaining the necessary infrastructure.

[See our quickstart guide for Data Streams Transmitter](/quickstarts/transmitter).
Loading
Loading