Installing submodules fails after fresh clone

[wottpal]

Is there an existing issue for this?

• I have searched the existing issues

Package Version

main

Current Behavior

Cloning the repository as described in Contributing.md fails (both via git & gh). The problem seems to be missing access to git@github.com:jxom/foundry.git (but not sure if that's the only issue).

➜ git clone https://github.com/wevm/viem.git --recurse-submodules

Cloning into 'viem'...
remote: Enumerating objects: 32963, done.
remote: Counting objects: 100% (2448/2448), done.
remote: Compressing objects: 100% (1205/1205), done.
remote: Total 32963 (delta 1429), reused 2099 (delta 1196), pack-reused 30515
Receiving objects: 100% (32963/32963), 355.93 MiB | 4.88 MiB/s, done.
Resolving deltas: 100% (23989/23989), done.
Submodule 'test/invokers' (https://github.com/anton-rs/3074-invokers.git) registered for path 'test/invokers'
Cloning into '.../viem/test/invokers'...
remote: Enumerating objects: 365, done.        
remote: Counting objects: 100% (155/155), done.        
remote: Compressing objects: 100% (65/65), done.        
remote: Total 365 (delta 108), reused 107 (delta 89), pack-reused 210        
Receiving objects: 100% (365/365), 90.24 KiB | 2.26 MiB/s, done.
Resolving deltas: 100% (183/183), done.
Submodule path 'test/invokers': checked out '6ee1f28b01614593aca2c80dd9fb07779a85415e'
Submodule 'lib/forge-std' (https://github.com/foundry-rs/forge-std) registered for path 'test/invokers/lib/forge-std'
Submodule 'lib/foundry' (git@github.com:jxom/foundry.git) registered for path 'test/invokers/lib/foundry'
Submodule 'lib/solady' (https://github.com/vectorized/solady) registered for path 'test/invokers/lib/solady'
Submodule 'lib/solidity' (https://github.com/enitrat/solidity) registered for path 'test/invokers/lib/solidity'
Cloning into '.../viem/test/invokers/lib/forge-std'...
remote: Enumerating objects: 2285, done.        
remote: Counting objects: 100% (2280/2280), done.        
remote: Compressing objects: 100% (795/795), done.        
remote: Total 2285 (delta 1514), reused 2129 (delta 1413), pack-reused 5        
Receiving objects: 100% (2285/2285), 651.83 KiB | 5.34 MiB/s, done.
Resolving deltas: 100% (1514/1514), done.
Cloning into '.../viem/test/invokers/lib/foundry'...
git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
fatal: clone of 'git@github.com:jxom/foundry.git' into submodule path '.../viem/test/invokers/lib/foundry' failed
Failed to clone 'lib/foundry'. Retry scheduled
Cloning into '.../viem/test/invokers/lib/solady'...
remote: Enumerating objects: 7038, done.        
remote: Counting objects: 100% (2527/2527), done.        
remote: Compressing objects: 100% (859/859), done.        
remote: Total 7038 (delta 2108), reused 1906 (delta 1667), pack-reused 4511        
Receiving objects: 100% (7038/7038), 4.74 MiB | 12.13 MiB/s, done.
Resolving deltas: 100% (4852/4852), done.
Cloning into '.../viem/test/invokers/lib/solidity'...
remote: Enumerating objects: 173430, done.        
remote: Counting objects: 100% (9/9), done.        
remote: Compressing objects: 100% (9/9), done.        
remote: Total 173430 (delta 0), reused 2 (delta 0), pack-reused 173421        
Receiving objects: 100% (173430/173430), 62.51 MiB | 3.99 MiB/s, done.
Resolving deltas: 100% (128372/128372), done.
Cloning into '.../viem/test/invokers/lib/foundry'...
git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
fatal: clone of 'git@github.com:jxom/foundry.git' into submodule path '.../viem/test/invokers/lib/foundry' failed
Failed to clone 'lib/foundry' a second time, aborting
fatal: Failed to recurse into submodule path 'test/invokers'

Expected Behavior

No response

Steps To Reproduce

git clone https://github.com/wevm/viem.git --recurse-submodules

➜  viem git:(main) ✗ node -v             
v20.12.2
➜  viem git:(main) ✗ git -v                          
git version 2.45.0

Link to Minimal Reproducible Example (StackBlitz, CodeSandbox, GitHub repo etc.)

No response

Anything else?

No response

[wottpal]

Update: Fixed it by enabling gh to act as an authentication helper for git via gh auth setup-git. Though, I have the feeling cloning should work out of the box with un-authed clients 🤔

[github-actions]

This issue has been locked since it has been closed for more than 14 days.

If you found a concrete bug or regression related to it, please open a new bug report with a reproduction against the latest Viem version. If you have any questions or comments you can create a new discussion thread.