From 237bc0a7b9bb08b227bb2a9d5be7b98e53d84737 Mon Sep 17 00:00:00 2001 From: Derek Croote Date: Sat, 26 Nov 2022 11:47:26 -0800 Subject: [PATCH 1/4] Clarify provider URL when running airnode-examples locally --- .changeset/eleven-donkeys-listen.md | 5 +++++ packages/airnode-examples/README.md | 12 +++++++----- 2 files changed, 12 insertions(+), 5 deletions(-) create mode 100644 .changeset/eleven-donkeys-listen.md diff --git a/.changeset/eleven-donkeys-listen.md b/.changeset/eleven-donkeys-listen.md new file mode 100644 index 0000000000..681a512e18 --- /dev/null +++ b/.changeset/eleven-donkeys-listen.md @@ -0,0 +1,5 @@ +--- +'@api3/airnode-examples': patch +--- + +Clarify provider URL when running airnode-examples locally diff --git a/packages/airnode-examples/README.md b/packages/airnode-examples/README.md index 6aece5b307..33061d681a 100644 --- a/packages/airnode-examples/README.md +++ b/packages/airnode-examples/README.md @@ -182,12 +182,14 @@ The latter, `secrets.env` can be generated by running: yarn create-airnode-secrets ``` -> If you are using docker for Windows/WSL or docker for Mac and you want to connect to your local hardhat network, you -> will need to modify the generated `secrets.env` file found in `integrations//` by replacing the -> provider URL with the following: `PROVIDER_URL=http://host.docker.internal:8545`. This is a docker limitation. See: -> https://stackoverflow.com/a/24326540. +> If you are using docker for Windows/WSL, docker for Mac, or potentially some flavors of Linux like Pop!\_OS and you +> want to connect to your local hardhat network, you will need to modify the generated `secrets.env` file found in +> `integrations//` by replacing the provider URL with the following: +> `PROVIDER_URL=http://host.docker.internal:8545`. This is a docker limitation. See: +> https://stackoverflow.com/a/24326540. A symptom of needing this change is the following error when attempting to +> connect to your local hardhat network: `could not detect network`. > -> The `create-airnode-secrets` script will handle this for you. +> The `create-airnode-secrets` script will handle this for you on Mac and Windows/WSL. Refer to the [documentation](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html) for From 685c677d698e81720084cf326785778d1a45d8a9 Mon Sep 17 00:00:00 2001 From: Derek Croote Date: Sun, 27 Nov 2022 14:42:13 -0800 Subject: [PATCH 2/4] Change language to Docker Desktop --- packages/airnode-examples/README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/packages/airnode-examples/README.md b/packages/airnode-examples/README.md index 33061d681a..9568bc14eb 100644 --- a/packages/airnode-examples/README.md +++ b/packages/airnode-examples/README.md @@ -182,14 +182,13 @@ The latter, `secrets.env` can be generated by running: yarn create-airnode-secrets ``` -> If you are using docker for Windows/WSL, docker for Mac, or potentially some flavors of Linux like Pop!\_OS and you -> want to connect to your local hardhat network, you will need to modify the generated `secrets.env` file found in -> `integrations//` by replacing the provider URL with the following: -> `PROVIDER_URL=http://host.docker.internal:8545`. This is a docker limitation. See: +> If you are using Docker Desktop (Windows, WSL, Mac, or Linux) and you want to connect to your local hardhat network, +> you will need to modify the generated `secrets.env` file found in `integrations//` by replacing the +> provider URL with the following: `PROVIDER_URL=http://host.docker.internal:8545`. This is a docker limitation. See: > https://stackoverflow.com/a/24326540. A symptom of needing this change is the following error when attempting to > connect to your local hardhat network: `could not detect network`. > -> The `create-airnode-secrets` script will handle this for you on Mac and Windows/WSL. +> The `create-airnode-secrets` script will handle this for you on Mac, Windows, and WSL. Refer to the [documentation](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html) for From 95acc7b7f41133e29ed28a93cedffa095fd8061d Mon Sep 17 00:00:00 2001 From: Derek Croote Date: Tue, 29 Nov 2022 17:27:10 -0800 Subject: [PATCH 3/4] Update packages/airnode-examples/README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Emanuel Tesař --- packages/airnode-examples/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/airnode-examples/README.md b/packages/airnode-examples/README.md index 9568bc14eb..8d251e138b 100644 --- a/packages/airnode-examples/README.md +++ b/packages/airnode-examples/README.md @@ -182,7 +182,7 @@ The latter, `secrets.env` can be generated by running: yarn create-airnode-secrets ``` -> If you are using Docker Desktop (Windows, WSL, Mac, or Linux) and you want to connect to your local hardhat network, +> If you are using Docker Desktop (on any platform) and you want to connect to your local hardhat network, > you will need to modify the generated `secrets.env` file found in `integrations//` by replacing the > provider URL with the following: `PROVIDER_URL=http://host.docker.internal:8545`. This is a docker limitation. See: > https://stackoverflow.com/a/24326540. A symptom of needing this change is the following error when attempting to From e8b988fad76862c8c916a9314fd97d503807e462 Mon Sep 17 00:00:00 2001 From: Derek Croote Date: Tue, 29 Nov 2022 17:35:49 -0800 Subject: [PATCH 4/4] Prettier after suggestion --- packages/airnode-examples/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/airnode-examples/README.md b/packages/airnode-examples/README.md index 8d251e138b..b285c71aa0 100644 --- a/packages/airnode-examples/README.md +++ b/packages/airnode-examples/README.md @@ -182,9 +182,9 @@ The latter, `secrets.env` can be generated by running: yarn create-airnode-secrets ``` -> If you are using Docker Desktop (on any platform) and you want to connect to your local hardhat network, -> you will need to modify the generated `secrets.env` file found in `integrations//` by replacing the -> provider URL with the following: `PROVIDER_URL=http://host.docker.internal:8545`. This is a docker limitation. See: +> If you are using Docker Desktop (on any platform) and you want to connect to your local hardhat network, you will need +> to modify the generated `secrets.env` file found in `integrations//` by replacing the provider URL +> with the following: `PROVIDER_URL=http://host.docker.internal:8545`. This is a docker limitation. See: > https://stackoverflow.com/a/24326540. A symptom of needing this change is the following error when attempting to > connect to your local hardhat network: `could not detect network`. >