From 2ff0054681c0d867229cbc245921d3b86ff64556 Mon Sep 17 00:00:00 2001 From: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Date: Fri, 20 Dec 2024 15:39:28 +0200 Subject: [PATCH] Fix Typographical Errors in Documentation and Code Comments (#3325) * 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 --- cmd/devtool/README.md | 2 +- cmd/livepeer_cli/wizard_transcoder.go | 2 +- common/util.go | 2 +- doc/httpcli.md | 2 +- doc/rtmpwebhookauth.md | 4 ++-- pm/stub.go | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/cmd/devtool/README.md b/cmd/devtool/README.md index 7710a0a078..63eea3a48d 100644 --- a/cmd/devtool/README.md +++ b/cmd/devtool/README.md @@ -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_.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` diff --git a/cmd/livepeer_cli/wizard_transcoder.go b/cmd/livepeer_cli/wizard_transcoder.go index 2416aadbd0..262a9b9140 100644 --- a/cmd/livepeer_cli/wizard_transcoder.go +++ b/cmd/livepeer_cli/wizard_transcoder.go @@ -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 diff --git a/common/util.go b/common/util.go index 4a408ba6c8..19fb0b6a9c 100644 --- a/common/util.go +++ b/common/util.go @@ -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) } diff --git a/doc/httpcli.md b/doc/httpcli.md index 2a5d9e255d..8ff77761d0 100644 --- a/doc/httpcli.md +++ b/doc/httpcli.md @@ -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 `:` flag. ## Available endpoints: diff --git a/doc/rtmpwebhookauth.md b/doc/rtmpwebhookauth.md index 1b9bdafea3..63e30b521e 100644 --- a/doc/rtmpwebhookauth.md +++ b/doc/rtmpwebhookauth.md @@ -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. @@ -74,4 +74,4 @@ If a valid `priceInfo` object is provided in the response the orchestrator will "pixelsPerUnit": number } } -``` \ No newline at end of file +``` diff --git a/pm/stub.go b/pm/stub.go index 44b8ab0961..33ba0352d1 100644 --- a/pm/stub.go +++ b/pm/stub.go @@ -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)