From babc32bba44953d6beb73a6738ec3396537a9693 Mon Sep 17 00:00:00 2001 From: Hunter Hillman Date: Wed, 19 Jan 2022 13:23:54 -0800 Subject: [PATCH 1/4] call out flags with abnormal behavior --- docs/video-miners/reference/configuration.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/video-miners/reference/configuration.md b/docs/video-miners/reference/configuration.md index 97a973f3..b4b3f6b6 100644 --- a/docs/video-miners/reference/configuration.md +++ b/docs/video-miners/reference/configuration.md @@ -43,9 +43,9 @@ verifierURL: URL of the verifier to use. No default. verifierPath: Path to verifier shared volume. No default. -localVerify: Set to true to enable local verification i.e. pixel count and signature verification. Default `true` +localVerify: Set to true to enable local verification i.e. pixel count and signature verification. Default `true`. However, if you are running in offchain mode, this will be set to false. -httpIngest: Set to true to enable HTTP ingest. Default `true` +httpIngest: Set to true to enable HTTP ingest. Default `true`. However, if (1) you do not provide a value, (2) you provide a non-local URL for `httpAddr`, and (3) you do not provide an `authWebhookURL`, this will be set to false. ``` ### Transcoding @@ -95,7 +95,7 @@ maxTxReplacements: Number of times to automatically replace pending Ethereum tra gasLimit: Gas limit for ETH transaction. Default `0` -minGasPrice: Minimum gas price (priority fee + base fee) for ETH transactions in wei, 10 Gwei = 10000000000. Default `0` +minGasPrice: Minimum gas price (priority fee + base fee) for ETH transactions in wei, 10 Gwei = 10000000000. If not set, this will be the network's default min gas fee. maxGasPrice: Maximum gas price (priority fee + base fee) for ETH transactions in wei, 40 Gwei = 40000000000. Default `0` @@ -109,7 +109,7 @@ maxTicketEV: The maximum acceptable expected value for PM tickets. Default `3000 depositMultiplier: The deposit multiplier used to determine max acceptable faceValue for PM tickets. Default `1` -pricePerUnit: The price per 'pixelsPerUnit' amount pixels. Default `0` +pricePerUnit: The price per 'pixelsPerUnit' amount pixels. Must be greater than 0. Error if not set. maxPricePerUnit: The maximum transcoding price (in wei) per 'pixelsPerUnit' a broadcaster is willing to accept. If not set explicitly, broadcaster is willing to accept ANY price. Default `0` @@ -123,7 +123,7 @@ redeemer: Set to true to run a ticket redemption service. Default `false` redeemerAddr: URL of the ticket redemption service to use. No default -reward: Set to true to run a reward service. Default `false` +reward: Set to true to run a reward service. If you do not want to automatically call `reward()`, you need to explicitly set this to `false`. Otherwise, it will default to true for on-chain orchestrators. monitor: Set to true to send performance metrics. Default `false` From 5b678b58494272985f50fe984b07e4001f623cf0 Mon Sep 17 00:00:00 2001 From: Hunter Hillman Date: Thu, 20 Jan 2022 11:39:09 -0800 Subject: [PATCH 2/4] update to point out that this also applies to Ts --- docs/video-miners/reference/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/video-miners/reference/configuration.md b/docs/video-miners/reference/configuration.md index b4b3f6b6..ad40a94e 100644 --- a/docs/video-miners/reference/configuration.md +++ b/docs/video-miners/reference/configuration.md @@ -123,7 +123,7 @@ redeemer: Set to true to run a ticket redemption service. Default `false` redeemerAddr: URL of the ticket redemption service to use. No default -reward: Set to true to run a reward service. If you do not want to automatically call `reward()`, you need to explicitly set this to `false`. Otherwise, it will default to true for on-chain orchestrators. +reward: Set to true to run a reward service. If you do not want to automatically call `reward()`, you need to explicitly set this to `false` for any node that's registered onchain (orchestrators or transcoders). Otherwise, it will default to true. monitor: Set to true to send performance metrics. Default `false` From b28d245e15858f2b2da45609bbd1f92de287aca6 Mon Sep 17 00:00:00 2001 From: Hunter Hillman Date: Thu, 20 Jan 2022 13:46:29 -0800 Subject: [PATCH 3/4] verbosity --- docs/video-miners/reference/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/video-miners/reference/configuration.md b/docs/video-miners/reference/configuration.md index ad40a94e..821f51c8 100644 --- a/docs/video-miners/reference/configuration.md +++ b/docs/video-miners/reference/configuration.md @@ -129,7 +129,7 @@ monitor: Set to true to send performance metrics. Default `false` version: Print out the version. Default `false` -verbosity: Log verbosity - {4|5|6}. No default +v: Log verbosity - {4|5|6}. No default metadataQueueUri: URI for message broker to send operation metadata. No default From 9f07ea5633a28d67f4aaf2ffb77bff756bb5c813 Mon Sep 17 00:00:00 2001 From: Hunter Hillman Date: Thu, 20 Jan 2022 14:51:16 -0800 Subject: [PATCH 4/4] fix --- docs/video-miners/reference/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/video-miners/reference/configuration.md b/docs/video-miners/reference/configuration.md index 821f51c8..cf3c5575 100644 --- a/docs/video-miners/reference/configuration.md +++ b/docs/video-miners/reference/configuration.md @@ -123,7 +123,7 @@ redeemer: Set to true to run a ticket redemption service. Default `false` redeemerAddr: URL of the ticket redemption service to use. No default -reward: Set to true to run a reward service. If you do not want to automatically call `reward()`, you need to explicitly set this to `false` for any node that's registered onchain (orchestrators or transcoders). Otherwise, it will default to true. +reward: Set to true to run a reward service. If you do not want to automatically call `reward()`, you need to explicitly set this to `false` for any node that's registered onchain. Otherwise, it will default to true. monitor: Set to true to send performance metrics. Default `false`