Skip to content

fix(DOCS): add note for macos to fix docker containers startup failure#2544

Merged
shamardy merged 2 commits intodevfrom
fix-docker-tests-doc
Jul 24, 2025
Merged

fix(DOCS): add note for macos to fix docker containers startup failure#2544
shamardy merged 2 commits intodevfrom
fix-docker-tests-doc

Conversation

@dimxy
Copy link
Copy Markdown
Collaborator

@dimxy dimxy commented Jul 23, 2025

No description provided.

@dimxy dimxy added status: pending review priority: medium Moderately important tasks that should be completed but are not urgent. improvement: docs labels Jul 23, 2025
@smk762 smk762 self-requested a review July 24, 2025 02:57
smk762
smk762 reviewed Jul 24, 2025
View reviewed changes
Comment thread docs/DEV_ENVIRONMENT.md Outdated
Note for MacOS users:
- Utxo test docker container may fail to start due to TCP port conflict with MacOS AirPlay Receiver (using the same 7000 port). Disabling AirPlay Receiver resolves this problem.

- Nucleus test docker container (and depending ibc-relayer container) may fail to start on MacOS. The MacOS Docker "Enable host networking" option may help with this issue.
Copy link
Copy Markdown

@smk762 smk762 Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

depending dependent
image

  • capitalisation of proper nouns (e.g. AirPlay Receiver) is valid, though this is inconsistently applied to docker/Docker. Given the context of its use, being referenced as an object (regular noun) rather than product, lowercase would be the way to go.

  • Inconsistent capitalisation of acronyms: Utxo, TCP, ibc

Other wise good in terms of spelling/grammar etc. (a stickler would want more use of definite article "the", but its superfluous in a tech doc context).

Copy link
Copy Markdown
Collaborator

@mariocynicys mariocynicys Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but its superfluous in a tech doc context

its it's

Copy link
Copy Markdown
Collaborator Author

@dimxy dimxy Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the notes,
tried to fix: fe87b87

mariocynicys
mariocynicys reviewed Jul 24, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@mariocynicys mariocynicys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM

mariocynicys
mariocynicys previously approved these changes Jul 24, 2025
View reviewed changes
shamardy
shamardy previously approved these changes Jul 24, 2025
View reviewed changes
@shamardy shamardy changed the base branch from main to dev July 24, 2025 19:36
@shamardy shamardy dismissed stale reviews from mariocynicys and themself July 24, 2025 19:36

The base branch was changed.

@shamardy shamardy force-pushed the fix-docker-tests-doc branch from fe87b87 to 3fd7268 Compare July 24, 2025 19:39
@shamardy shamardy merged commit 817b415 into dev Jul 24, 2025
18 of 25 checks passed
@shamardy shamardy deleted the fix-docker-tests-doc branch July 24, 2025 21:56
dimxy pushed a commit that referenced this pull request Jul 25, 2025
Merge branch 'dev' into allow-rust-log-tags
5c6569a 
* dev:
  fix(DOCS): add note for macos to fix docker containers startup failure (#2544)
  refactor(toolchain): general stabilization for stable rust (#2528)

# Conflicts:
#	mm2src/mm2_main/tests/integration_tests_common/mod.rs
onur-ozkan
onur-ozkan reviewed Jul 25, 2025
View reviewed changes
Comment thread docs/DEV_ENVIRONMENT.md
Note for MacOS users:
- The UTXO 'testblockchain' docker container may fail to start due to TCP port conflict with MacOS AirPlay Receiver (using the same 7000 port). Disabling AirPlay Receiver resolves this problem.

- The 'nucleusd' test docker container (and the dependent 'ibc-relayer' container) may fail to start on MacOS. The MacOS docker "Enable host networking" option may help with this issue.
Copy link
Copy Markdown

@onur-ozkan onur-ozkan Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would re-write this part as:

"nucleusd container (along with the dependent ibc-relayer container) requires host network access, but on MacOS, by default containers can not access to host network. Therefore, the "Enable host networking" option must be enabled to allow the nucleusd containers to run properly"

Copy link
Copy Markdown
Collaborator

@shamardy shamardy Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dimxy feel free to open another PR for these changes if you want. I guess I merged this a bit early

onur-ozkan
onur-ozkan reviewed Jul 25, 2025
View reviewed changes
Comment thread docs/DEV_ENVIRONMENT.md
9. Try `cargo test --all --features run-docker-tests -- --test-threads=16`.

Note for MacOS users:
- The UTXO 'testblockchain' docker container may fail to start due to TCP port conflict with MacOS AirPlay Receiver (using the same 7000 port). Disabling AirPlay Receiver resolves this problem.
Copy link
Copy Markdown

@onur-ozkan onur-ozkan Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we not changing the container port instead of telling users to disable AirPlay 🤔

Copy link
Copy Markdown
Collaborator Author

@dimxy dimxy Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could suggest the user to change the port by themselves, as another option

Copy link
Copy Markdown

@onur-ozkan onur-ozkan Jul 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not changing the container port directly on KDF? That way users don't have to change or know anything about it.

Copy link
Copy Markdown
Collaborator Author

@dimxy dimxy Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may change it ofc, no guarantee though that there would not conflicts with other services.
We may rephrase the note as more general like: if containers do not start check for port conflicts, for example for MacOS it may be a conflict with AirPlay

dimxy pushed a commit that referenced this pull request Aug 1, 2025
Merge branch 'dev' into fix-2.5-rc-trezor-issues
762c4c3 
* dev: (21 commits)
  feat(wallet-connect): impl BTC (UTxO) activation via WalletConnect (#2499)
  feat(utxo): add new fixed txfee option for DINGO-like coins (#2454)
  ci(pull-requests): review notification bot (#2468)
  improvement(walletconnect): return the `pairing_topic` in `new_connection` response (#2538)
  bless clippy (#2560)
  refactor(toolchain): use latest available stable compiler (#2557)
  feat(wallet): implement unified offline private key export API (#2542)
  improve note for docker test start failure (#2550)
  fix(DOCS): add note for macos to fix docker containers startup failure (#2544)
  refactor(toolchain): general stabilization for stable rust (#2528)
  fix(ci): adds nodejs 20 to ci-container (#2536)
  fix(WASM and Debian): fix build failures (#2534)
  improvement(event-streaming): impl DeriveStreamerId trait for all streamers (#2489)
  fix(eth): Propagate structured EIP-1559 fee errors (#2532)
  fix(eth): Correctly implement ETH max withdrawal logic (#2531)
  feat(use-clap-for-cli): use clap to parse CLI-Args #2215 (#2510)
  feat(orderbook): expirable maker orders (#2516)
  improvement(eth): drop parity support (#2527)
  chore(release): finalize changelog for v2.5.0-beta (#2524)
  chore(toolchain): upgrade toolchain to nightly 1.86.0 (#2444)
  ...

# Conflicts:
#	mm2src/coins/lp_coins.rs
#	mm2src/coins/rpc_command/get_new_address.rs
#	mm2src/trezor/src/eth/eth_command.rs
dimxy pushed a commit that referenced this pull request Aug 1, 2025
Merge branch 'dev' into refactor-gas-fee-policy
b0a1e16 
* dev:
  feat(wallet-connect): impl BTC (UTxO) activation via WalletConnect (#2499)
  feat(utxo): add new fixed txfee option for DINGO-like coins (#2454)
  ci(pull-requests): review notification bot (#2468)
  improvement(walletconnect): return the `pairing_topic` in `new_connection` response (#2538)
  bless clippy (#2560)
  refactor(toolchain): use latest available stable compiler (#2557)
  feat(wallet): implement unified offline private key export API (#2542)
  improve note for docker test start failure (#2550)
  fix(DOCS): add note for macos to fix docker containers startup failure (#2544)
  refactor(toolchain): general stabilization for stable rust (#2528)
  fix(ci): adds nodejs 20 to ci-container (#2536)
  fix(WASM and Debian): fix build failures (#2534)
  improvement(event-streaming): impl DeriveStreamerId trait for all streamers (#2489)
  chore(release): v2.3.0-beta (#2284)

# Conflicts:
#	mm2src/coins/eth.rs
#	mm2src/coins/eth/eth_swap_v2/eth_maker_swap_v2.rs
#	mm2src/coins/eth/eth_swap_v2/eth_taker_swap_v2.rs
#	mm2src/coins/eth/eth_tests.rs
#	mm2src/coins/eth/eth_withdraw.rs
#	mm2src/coins/eth/v2_activation.rs
#	mm2src/coins/nft.rs
#	mm2src/coins/qrc20.rs
#	mm2src/mm2_main/src/rpc/dispatcher/dispatcher.rs
#	mm2src/mm2_main/src/rpc/lp_commands/one_inch/rpcs.rs
#	mm2src/mm2_main/src/rpc/lp_commands/tokens.rs
#	mm2src/mm2_main/tests/docker_tests/eth_docker_tests.rs
dimxy pushed a commit that referenced this pull request Aug 15, 2025
Merge branch 'dev' into refactor-gas-fee-policy
093afd5 
* dev: (24 commits)
  fix(ordermatch): ignore loop-back; clear on null root; reject stale keep-alives (#2580)
  fix(clippy): fix clippy warnings for #2565 (#2589)
  fix(Trezor): fix utxo and eth calls due to firmware changes (#2565)
  fix(utxo): calculate min_trading_vol based on fixed tx fees (#2564)
  feat(protocol): [0] solana support (#2586)
  fix(utxo): fix header deserialization; guard AuxPoW (#2583)
  chore(rust 1.89): make CI clippy/fmt pass (wasm32, all-targets) (#2581)
  fix(utxo): deserialize sapling root for PIVX block headers (#2572)
  improvement(dep-stack): security bumps (#2562)
  fix(utxo): correct block header deserialization for AuxPow and KAWPOW coins (#2563)
  feat(wallet-connect): impl BTC (UTxO) activation via WalletConnect (#2499)
  feat(utxo): add new fixed txfee option for DINGO-like coins (#2454)
  ci(pull-requests): review notification bot (#2468)
  improvement(walletconnect): return the `pairing_topic` in `new_connection` response (#2538)
  bless clippy (#2560)
  refactor(toolchain): use latest available stable compiler (#2557)
  feat(wallet): implement unified offline private key export API (#2542)
  improve note for docker test start failure (#2550)
  fix(DOCS): add note for macos to fix docker containers startup failure (#2544)
  refactor(toolchain): general stabilization for stable rust (#2528)
  ...

# Conflicts:
#	mm2src/coins/eth.rs
#	mm2src/coins/eth/eth_swap_v2/eth_maker_swap_v2.rs
#	mm2src/coins/eth/eth_swap_v2/eth_taker_swap_v2.rs
#	mm2src/coins/eth/eth_tests.rs
#	mm2src/coins/eth/eth_withdraw.rs
#	mm2src/coins/eth/v2_activation.rs
#	mm2src/coins/nft.rs
#	mm2src/coins/qrc20.rs
#	mm2src/mm2_main/src/rpc/dispatcher/dispatcher.rs
#	mm2src/mm2_main/src/rpc/lp_commands/one_inch/rpcs.rs
#	mm2src/mm2_main/src/rpc/lp_commands/tokens.rs
#	mm2src/mm2_main/tests/docker_tests/eth_docker_tests.rs
dimxy pushed a commit that referenced this pull request Oct 15, 2025
fix(DOCS): add note for macos to fix docker containers startup failure (
b05e067 
#2544)
@shamardy shamardy mentioned this pull request Nov 25, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shamardy shamardy shamardy approved these changes

@mariocynicys mariocynicys mariocynicys left review comments

+2 more reviewers

@smk762 smk762 smk762 left review comments

@onur-ozkan onur-ozkan onur-ozkan left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

2.6.0-beta improvement: docs priority: medium Moderately important tasks that should be completed but are not urgent. status: pending review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@dimxy @smk762 @shamardy @onur-ozkan @mariocynicys