search

0xPolygon / polygon-docs

Polygon Technical Docs
https://docs.polygon.technology
MIT License
136 stars 270 forks source link

DO NOT MERGE: ISSUES NOT PR: Update the script start command in checking ENV in CDK Getting Started #639

Closed VorobevSA closed 2 months ago

VorobevSA commented 2 months ago

Changed the script call method from sh to ./ for

  1. Fixes problems - who has basic SHELL - bash example: 
    
xxx@node:~/kurtosis-cdk$ sh scripts/tool_check.sh
Checking that you have the necessary tools to deploy the Kurtosis CDK package...
❌ kurtosis is not installed. Please install kurtosis to proceed: https://docs.kurtosis.com/install/
/usr/bin/kurtosis

xxx@node:~/kurtosis-cdk$ ./scripts/tool_check.sh Checking that you have the necessary tools to deploy the Kurtosis CDK package... ✅ kurtosis 1.0.0 is installed, meets the requirement (=1.0). ✅ docker 27.1.1 is installed, meets the requirement (>=24.7). ... 🎉 You are ready to go!



2. To unify the approach of running scripts 
example of the approach used in the Readme - https://github.com/0xPolygon/polygon-docs/blob/main/README.md
kmurphypolygon commented 2 months ago

Thanks for your input @VorobevSA. It just so happens I'm reviewing this doc today so will definitely include your change. Thanks again :)

VorobevSA commented 2 months ago

@kmurphypolygon Thank you!

I've also noticed that the default repository now uses - erigon -> https://github.com/0xPolygon/kurtosis-cdk/blob/8dba7da37e729178f134bd182ead2d0048e9ab25/params.yml#L44 but in the documentation - ETH_RPC_URL is used - zkevm

An experienced user will not be embarrassed by this, but the fact that you will encounter an error when performing actions according to the documentation is not pleasant). 

xxx@node:~$ export ETH_RPC_URL="$(kurtosis port print cdk-v1 cdk-erigon-node-001 http-rpc)" 
xxx@node:~$ export ETH_RPC_URL="$(kurtosis port print cdk-v1 zkevm-node-rpc-001 http-rpc)"
Error:  An error occurred running command 'print'
  Caused by: An error occurred calling the run function for command 'print'
  Caused by: An error occurred while getting service context for service with identifier 'zkevm-node-rpc-001'
  Caused by: An error occurred when trying to get info for service 'zkevm-node-rpc-001'
  Caused by: rpc error: code = Unknown desc = Failed to get service info for service 'zkevm-node-rpc-001'
  Caused by: An error occurred getting info for service 'zkevm-node-rpc-001'
  Caused by: An error occurred while fetching registration for service identifier 'zkevm-node-rpc-001'
  Caused by: An error occurred while fetching name for service identifier 'zkevm-node-rpc-001'
  Caused by: Couldn't find a matching service name for identifier 'zkevm-node-rpc-001'

Probably should be updated in the documentation?

sonarcloud[bot] commented 2 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

kmurphypolygon commented 2 months ago

çekme_isteği_hedefi

Agreed, thanks for raising, I'll reopen this. Actually, I'm doing a full review so let me know anything else you see. I'll translate your recent comment too.

I'm just gonna make a note not to merge this, maybe you could open an issue instead with anything else?

Thanks again :)

kmurphypolygon commented 2 months ago

Hi @VorobevSA please track PR #643 where I have added your suggestions. Thanks so much for the help and assistance :)