Skip to content

Commit

Permalink
Fix Typographical Errors in Documentation and Code Comments (#3325)
Browse files Browse the repository at this point in the history
* typos util.go

* typos README.md

* typos wizard_transcoder.go

* typos httpcli.md

* typos rtmpwebhookauth.md

* typos stub.go

* Fix bad grammar

---------

Co-authored-by: Thom Shutt <[email protected]>
  • Loading branch information
Dimitrolito and thomshutt authored Dec 20, 2024
1 parent 5a756c4 commit 2ff0054
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion cmd/devtool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ docker run -p 8545:8545 -p 8546:8546 --name geth-with-livepeer-protocol livepeer
This command will submit the setup transactions for a broadcaster and generate the Bash script
`run_broadcaster_<ETH_ACCOUNT>.sh` which can be used to start a broadcaster node.

### Step 3: Set up a orchestrator/transcoder
### Step 3: Set up an orchestrator/transcoder

`go run cmd/devtool/devtool.go setup transcoder`

Expand Down
2 changes: 1 addition & 1 deletion cmd/livepeer_cli/wizard_transcoder.go
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ func (w *wizard) activateOrchestrator() {
val := w.getOrchestratorConfigFormValues()

if d.BondedAmount.Cmp(big.NewInt(0)) <= 0 || d.DelegateAddress != d.Address {
fmt.Printf("You must bond to yourself in order to become a orchestrator\n")
fmt.Printf("You must bond to yourself in order to become an orchestrator\n")

rebond := false

Expand Down
2 changes: 1 addition & 1 deletion common/util.go
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ func PriceToFixed(price *big.Rat) (int64, error) {
return ratToFixed(price, priceScalingFactor)
}

// FixedToPrice converts an fixed point number with 3 decimal places represented as in int64 into a big.Rat
// FixedToPrice converts a fixed point number with 3 decimal places represented as in int64 into a big.Rat
func FixedToPrice(price int64) *big.Rat {
return big.NewRat(price, priceScalingFactor)
}
Expand Down
2 changes: 1 addition & 1 deletion doc/httpcli.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HTTP endpoint

The Livepeer node exposes a HTTP interface for monitoring and managing the node. This is how the `livepeer_cli` tool interfaces with a running node.
The Livepeer node exposes an HTTP interface for monitoring and managing the node. This is how the `livepeer_cli` tool interfaces with a running node.
By default, the CLI listens to localhost:7935. This can be adjusted with the -cliAddr `<interface>:<port>` flag.

## Available endpoints:
Expand Down
4 changes: 2 additions & 2 deletions doc/rtmpwebhookauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Incoming streams can be authenticated using webhooks on both orchestrator and broadcaster nodes. To use these webhooks, node operators must implement their own web service / endpoint to be accessed only by the Livepeer node. As new streams appear, the Livepeer node will call this endpoint to determine whether the given stream is allowed.

The webhook server should respond with HTTP status code `200` in order to authenticate / authorize the stream. A response with a HTTP status code other than `200` will cause the Livepeer node to disconnect the stream.
The webhook server should respond with HTTP status code `200` in order to authenticate / authorize the stream. A response with an HTTP status code other than `200` will cause the Livepeer node to disconnect the stream.

To enable webhook authentication functionality, the Livepeer node should be started with the `-authWebhookUrl` flag, along with the webhook endpoint URL.

Expand Down Expand Up @@ -74,4 +74,4 @@ If a valid `priceInfo` object is provided in the response the orchestrator will
"pixelsPerUnit": number
}
}
```
```
2 changes: 1 addition & 1 deletion pm/stub.go
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ func (m *MockRecipient) ReceiveTicket(ticket *Ticket, sig []byte, seed *big.Int)
}

// RedeemWinningTickets redeems all winning tickets with the broker
// for a all sessionIDs
// for all sessionIDs
func (m *MockRecipient) RedeemWinningTickets(sessionIDs []string) error {
args := m.Called(sessionIDs)
return args.Error(0)
Expand Down

0 comments on commit 2ff0054

Please sign in to comment.