Skip to content

Commit 36b3902

Browse files
authored
refactor: replace 'Broadcaster' with 'Gateway' (#567)
This commit replaces all instances of 'Broadcaster' with 'Gateway' in accordance with a decision made by the core team. For more details, refer to the discussion at https://discord.com/channels/423160867534929930/1051963444598943784/1210356864643109004.
1 parent 1ef5f9a commit 36b3902

21 files changed

+107
-105
lines changed

.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
node_modules
2-
.DS_Store
2+
.DS_Store
3+
4+
# IDEs
5+
.vscode

catalyst/deploying-catalyst.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ The easiest way to create a wallet and deposit funds is to use the go-livepeer
6565
node itself along with the `livepeer_cli` command-line tool. Both are
6666
downloadable from the
6767
[go-livepeer releases page on GitHub](https://github.com/livepeer/go-livepeer/releases).
68-
Once you have those binaries, you can boot up a temporary livepeer broadcaster
68+
Once you have those binaries, you can boot up a temporary livepeer gateway
6969
locally:
7070

7171
```
7272
./livepeer \
73-
-broadcaster \
73+
-gateway \
7474
-network arbitrum-one-mainnet \
7575
-ethUrl https://ETH_RPC_PROVIDER_HERE
7676
```
@@ -116,7 +116,7 @@ interface. You will be shown output something like this:
116116
| LivepeerTokenFaucet Address | 0x0000000000000000000000000000000000000000 |
117117
| FOR REFERENCE - DO NOT SEND TOKENS | |
118118
*------------------------------------*--------------------------------------------*
119-
| Broadcaster Account | YOUR WALLET HERE |
119+
| Gateway Account | YOUR WALLET HERE |
120120
| YOUR WALLET FOR ETH & LPT | |
121121
*------------------------------------*--------------------------------------------*
122122
| LPT Balance | 0 LPTU |
@@ -129,7 +129,7 @@ interface. You will be shown output something like this:
129129
*------------------------------------*--------------------------------------------*
130130
```
131131

132-
At this point you may deposit your Eth into the "Broadcaster Account" address
132+
At this point you may deposit your Eth into the "Gateway Account" address
133133
provided here. Once that transaction has posted to the Arbitrum One network, you
134134
can then invoke option 11: `Invoke "deposit broadcasting funds" (ETH)`. For
135135
example, if you intend to deposit 0.1 Eth in your deposit and 0.1 Eth in your

catalyst/introduction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ hackers to start working on it!
1919
that can then transfer to the hosted version at
2020
[livepeer.studio](https://livepeer.studio) when you're ready to go to
2121
production.
22-
- Bundles a fully-local offchain go-livepeer broadcaster and orchestrator, so
22+
- Bundles a fully-local offchain go-livepeer gateway and orchestrator, so
2323
that you may test transcoding with no external dependencies.
2424

2525
### Current limitations:

developers/core-concepts/livepeer-network/orchestrators.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
An Orchestrator on the Livepeer network is an entity or node that facilitates
22
the video processing tasks such as transcoding. Orchestrators provide their
3-
computational resources to assist broadcasters and developers in
3+
computational resources to assist gateways and developers in
44
transcoding/delivering videos. By running the
55
[`go-livepeer` client](https://github.com/livepeer/go-livepeer), individuals can
66
join the Livepeer network as Orchestrators.

developers/guides/livestream-from-browser.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ the WHIP spec):
251251

252252
<Info>
253253
The final HTTP DELETE is not needed for our media server, since we detect the
254-
end of broadcast by the lack of incoming packets from the broadcaster.
254+
end of broadcast by the lack of incoming packets from the gateway.
255255
</Info>
256256

257257
```txt WHIP Outline

developers/guides/optimize-latency-of-a-livestream.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ HLS (HTTP Live Streaming), initially developed by Apple for iOS devices, serves
3636
video with a series of segmented `.ts` files. It is broadly supported across
3737
many device types and is extremely well-optimized for serving multiple
3838
renditions; these characteristics position HLS as the default choice for many
39-
broadcasters.
39+
gateways.
4040

4141
However, HLS has very high overhead and latency. Specifically, its chunked
4242
segment delivery means that viewers must wait for the current segment to finish

mint.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -227,8 +227,8 @@
227227
"destination": "/orchestrators/guides/migrate-from-contract-wallet"
228228
},
229229
{
230-
"source": "/guides/orchestrating/broadcaster-introspection",
231-
"destination": "/orchestrators/guides/broadcaster-introspection"
230+
"source": "/guides/orchestrating/gateway-introspection",
231+
"destination": "/orchestrators/guides/gateway-introspection"
232232
},
233233
{
234234
"source": "/guides/orchestrating/troubleshoot",
@@ -488,7 +488,7 @@
488488
"orchestrators/guides/o-t-split",
489489
"orchestrators/guides/migrate-to-arbitrum",
490490
"orchestrators/guides/migrate-from-contract-wallet",
491-
"orchestrators/guides/broadcaster-introspection",
491+
"orchestrators/guides/gateway-introspection",
492492
"orchestrators/guides/troubleshoot"
493493
],
494494
"version": "Orchestrators"

orchestrators/guides/broadcaster-introspection.mdx orchestrators/guides/gateway-introspection.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
---
2-
title: Broadcaster Introspection
2+
title: Gateway Introspection
33
icon: tower-broadcast
44
---
55

6-
We launched a public API to enable Broadcaster introspection. Users of the API
7-
will be able to review the activity inside the Livepeer Broadcaster nodes and
6+
We launched a public API to enable Gateway introspection. Users of the API
7+
will be able to review the activity inside the Livepeer Gateway nodes and
88
understand the selection algorithms used to assign work to Orchestrator nodes.
99

1010
This is the initial release of the API, and only a few log lines have been
1111
enabled in the public logs. Orchestrators are encouraged to open pull requests
1212
to enable additional logs, which will be closely reviewed by the Livepeer team.
1313
Additionally, the core Livepeer team will publish more logs from Livepeer
14-
Broadcasters that may aid in understanding the selection algorithms.
14+
Gateways that may aid in understanding the selection algorithms.
1515

1616
This API uses Grafana's Loki for log aggregation. Examples of API usage are
1717
provided below. For more guidance, refer to
1818
[this page](https://grafana.com/docs/loki/v2.4.x/api/#get-lokiapiv1query).
1919

2020
### API usage
2121

22-
- Public logs from Livepeer Broadcasters are available through the public Loki
22+
- Public logs from Livepeer Gateways are available through the public Loki
2323
instance.
2424
- Example queries:
2525

orchestrators/guides/migrate-from-contract-wallet.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This guide is designed to be used in conjunction with the
1313
to support migrating to Arbitrum:
1414

1515
- Orchestrators - Migrate stake and fees
16-
- Broadcasters - Migrate your deposit and reserve
16+
- Gateways - Migrate your deposit and reserve
1717
- Delegators - Migrate undelegated stake
1818

1919
The migration process will transfer ownership of funds (i.e., stake) owned by

orchestrators/guides/migrate-to-arbitrum.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ used for mainnet, and it is finding a conflict on `chainId`.
246246
`Set orchestrator config`:
247247

248248
To receive work, you must register your service URI and fees so that
249-
broadcasters can discover your orchestrator.
249+
gateways can discover your orchestrator.
250250

251251
> 6a. Select the following option using `livepeer_cli`:
252252

orchestrators/guides/o-t-split.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ The `transcoder` field indicates the IP of the connecting transcoder and the
6161
`capacity` field indicates the number of simultaneous transcoding jobs that the
6262
transcoder can handle. Once the orchestrator has at least one transcoder
6363
connected, it will be able to send transcoding jobs to the transcoder when it
64-
receives a stream from a broadcaster.
64+
receives a stream from a gateway.

orchestrators/guides/set-pricing.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ icon: tag
44
---
55

66
In this guide we'll go over how to set and configure pricing to charge for
7-
transcoding advertised to broadcasters off-chain.
7+
transcoding advertised to gateways off-chain.
88

9-
# Setting WEI Price
9+
# Setting WEI Price
1010

1111
## Choose a Price
1212

1313
To charge for transcoding orchestrators set a price per pixel denominated in Wei
14-
(1 ETH = 1e18 Wei), advertised to broadcasters off-chain.
14+
(1 ETH = 1e18 Wei), advertised to gateways off-chain.
1515

1616
To get support for setting a price that will allow you to receive work on the
1717
network, contact us on our [Discord](https://discord.gg/uaPhtyrWsF) channel.
@@ -86,7 +86,7 @@ To set a price in USD, one just needs to add the `USD` suffix to the value provi
8686
8787
Given the price per pixel in USD is going to be a really low number, the recommendation is to also set the `-pixelsPerUnit` flag so a more human-friendly number can be specified on the price per unit. The `-pixelsPerUnit` acts as a denominator on the `-pricePerUnit` and the recommendation is to keep it constant over time, updating only the price per unit as seen fit.
8888
89-
e.g.:
89+
e.g.:
9090
9191
- To set a price of **$4.10 E -13**
9292
@@ -104,7 +104,7 @@ e.g.:
104104
105105
Notice that the `-pixelsPerUnit` flag supports the exponential notation, so it’s easier to understand the value being set. The `-pricePerUnit` does not support it though, so a standard decimal notation must be used. This is also an incentive to use the `-pixelsPerUnit` value in order to keep the `-pricePerUnit` as an easily readable value.
106106
107-
This feature is also supported by broadcasters, with the `-pixelsPerUnit` flag staying the same, while the `-maxPricePerUnit` should be set instead for the max price. The currency is specified in the same format.
107+
This feature is also supported by gateways, with the `-pixelsPerUnit` flag staying the same, while the `-maxPricePerUnit` should be set instead for the max price. The currency is specified in the same format.
108108
109109
### Advanced
110110

orchestrators/guides/set-session-limits.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ this guide to fine tune your configuration:
2828

2929
The **default limit of concurrent sessions is set to 10**. When this limit is
3030
exceeded, the orchestrator returns an error, `OrchestratorCapped`, to the
31-
broadcaster and transcoders and they will stop receiving work from
31+
gateway and transcoders and they will stop receiving work from
3232
orchestrators. The session limit should then be set depending on available
3333
hardware and bandwidth.
3434

orchestrators/guides/troubleshoot.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ most common issues that a video miner might encounter.
99
## OrchestratorCapped error
1010

1111
This error means that your orchestrator has hit its session limit so it is not
12-
longer accepting work from broadcasters. See the
12+
longer accepting work from gateways. See the
1313
[session limit guide](/orchestrators/guides/set-session-limits) for information
1414
on setting the session limit.
1515

@@ -45,7 +45,7 @@ transcoding completes.
4545

4646
These errors occur when a source video segment with certain properties that
4747
prevent it from being transcoded. There are no actionable steps for an operator
48-
in this scenario since the broadcaster is responsible for sending video segments
48+
in this scenario since the gateway is responsible for sending video segments
4949
that are supported by the Livepeer network.
5050

5151
## My node is still calling the reward claims function and spending gas, even though I have set `reward` to false
@@ -59,13 +59,13 @@ actions on behalf of your orchestrator if using the same wallet.
5959

6060
## TicketParams expired
6161

62-
This error indicates that the broadcaster sent a payment ticket with too old
63-
parameters. This may be caused by the broadcaster's delay (between getting the
62+
This error indicates that the gateway sent a payment ticket with too old
63+
parameters. This may be caused by the gateway's delay (between getting the
6464
last orchestrator info message and sending the segment) or by the delay in
6565
polling chain blocks (the expiration time is measured in L1 blocks). For more
6666
details please check
6767
[TicketParams expiration time](https://github.com/livepeer/go-livepeer/issues/1343).
68-
There are no actionable steps for an operator, broadcaster will retry a request
68+
There are no actionable steps for an operator, gateway will retry a request
6969
with the updated ticket parameters.
7070

7171
## Error creating Ethereum account manager
@@ -93,7 +93,7 @@ transcoded in Livepeer.
9393
**What does being ‘publicly accessible’ mean? Can I run a transcoder from
9494
home?**
9595

96-
Orchestrators should be reachable by broadcasters via the public IP and port
96+
Orchestrators should be reachable by gateways via the public IP and port
9797
that is set during registration. The only port that is required to be public is
9898
the one that was set during registration (default 8935). Be aware that there are
9999
many risks to running a public server. Only set up an orchestrator if you are
@@ -132,7 +132,7 @@ Some orchestrators in the past have used
132132

133133
**What is the service URI? Does this need to be an IP?**
134134

135-
The service registry acts as a discovery mechanism to allow broadcasters to look
135+
The service registry acts as a discovery mechanism to allow gateways to look
136136
up the addresses of orchestrators on the network. Orchestrators register their
137137
service URI by storing it on the blockchain. During registration you are only
138138
asked for your IP:port, but the URI stored on the blockchain in the form of .

references/go-livepeer/cli-reference.mdx

+11-12
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ also contain instructions for using flags to enable certain functionality in
3131
- httpAddr: Address to bind for HTTP commands. No default
3232

3333
- serviceAddr: Orchestrator only. Overrides the on-chain serviceURI that
34-
broadcasters can use to contact this node; may be an IP or hostname. No
35-
default
34+
gateways can use to contact this node; may be an IP or hostname. No default
3635

3736
- orchAddr: Orchestrator to connect to as a standalone transcoder. No default.
3837

@@ -54,7 +53,8 @@ also contain instructions for using flags to enable certain functionality in
5453

5554
- transcoder: Set to true to be an transcoder. Default `false`
5655

57-
- broadcaster: Set to true to be an broadcaster. Default `false`
56+
- gateway: Set to true to be an gateway (formerly known as *Broadcaster*). Default
57+
`false`
5858

5959
- orchSecret: Shared secret with the orchestrator as a standalone transcoder or
6060
path to file
@@ -68,8 +68,8 @@ also contain instructions for using flags to enable certain functionality in
6868
mode only). Default `0.3`
6969

7070
- maxSessions: Maximum number of concurrent transcoding sessions for
71-
Orchestrator, maximum number or RTMP streams for Broadcaster, or maximum
72-
capacity for transcoder. Default `10`
71+
Orchestrator, maximum number or RTMP streams for Gateway, or maximum capacity
72+
for transcoder. Default `10`
7373

7474
- currentManifest: Expose the currently active ManifestID as
7575
\"/stream/current.m3u8\". Default `false`
@@ -127,15 +127,15 @@ also contain instructions for using flags to enable certain functionality in
127127
than 0. Error if not set.
128128

129129
- maxPricePerUnit: The maximum transcoding price (in wei) per 'pixelsPerUnit' a
130-
broadcaster is willing to accept. If not set explicitly, broadcaster is
131-
willing to accept ANY price. Default `0`
130+
gateway is willing to accept. If not set explicitly, gateway is willing to
131+
accept ANY price. Default `0`
132132

133133
- pixelsPerUnit: Amount of pixels per unit. Set to '> 1' to have smaller price
134134
granularity than 1 wei / pixel. Default `1`
135135

136-
- pricePerBroadcaster: json list of price per broadcaster or path to json config
137-
file. Example:
138-
`{"broadcasters":[{"ethaddress":"address1","priceperunit":1000,"pixelsperunit":1},{"ethaddress":"address2","priceperunit":1200,"pixelsperunit":1}]}`
136+
- pricePerGateway: json list of price per gateway or path to json config file.
137+
Example:
138+
`{"gateways":[{"ethaddress":"address1","priceperunit":1000,"pixelsperunit":1},{"ethaddress":"address2","priceperunit":1200,"pixelsperunit":1}]}`
139139

140140
- autoAdjustPrice: Enable/disable automatic price adjustments based on the
141141
overhead for redeeming tickets. Default `true`
@@ -166,8 +166,7 @@ also contain instructions for using flags to enable certain functionality in
166166
- metadataPublishTimeout: Max time (ms) to wait in background for publishing
167167
operation metadata events. Default `1000 (1s)`
168168

169-
- maxFaceValue: Set the maximum face value of a ticket (in wei). No default
170-
169+
- maxFaceValue: Set the maximum face value of a ticket (in wei). No default
171170

172171
### Storage
173172

0 commit comments

Comments
 (0)