chore(deploy-upgrade): update usage comments

storyprotocol · Sep 3, 2024 · f95ddd8 · f95ddd8
1 parent fe0d1cb
commit f95ddd8
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 12 deletions.
diff --git a/script/deployment/Main.s.sol b/script/deployment/Main.s.sol
@@ -32,8 +32,12 @@ contract Main is Script, StoryProtocolCoreAddressManager, BroadcastManager, Json
 
     constructor() JsonDeploymentHandler("main") {}
 
-    /// @dev To use, run the following command (e.g. for Sepolia):
-    /// forge script script/deployment/Main.s.sol:Main --rpc-url $RPC_URL --broadcast --verify -vvvv
+    /// @dev To use, run the following command (e.g., for Story Iliad testnet):
+    /// forge script script/deployment/Main.s.sol:Main --rpc-url=$TESTNET_URL \
+    /// -vvvv --broadcast --priority-gas-price=1 --legacy \
+    /// --verify --verifier=$VERIFIER_NAME --verifier-url=$VERIFIER_URL
+    ///
+    /// For detailed examples, see the documentation in `../../docs/DEPLOY_UPGRADE.md`.
     function run() public {
         _readStoryProtocolCoreAddresses();
         _beginBroadcast();

diff --git a/script/deployment/MockRewardPool.s.sol b/script/deployment/MockRewardPool.s.sol
@@ -17,9 +17,12 @@ contract MockRewardPool is Script, BroadcastManager, JsonDeploymentHandler {
 
     constructor() JsonDeploymentHandler("main") {}
 
-    /// @dev To use, run the following command (e.g. for Sepolia):
-    /// forge script script/deployment/MockRewardPool.s.sol:MockRewardPool --rpc-url $RPC_URL --broadcast --verify -vvvv
-
+    /// @dev To use, run the following command (e.g., for Story Iliad testnet):
+    /// forge script script/deployment/MockRewardPool.s.sol:MockRewardPool --rpc-url=$TESTNET_URL \
+    /// -vvvv --broadcast --priority-gas-price=1 --legacy \
+    /// --verify --verifier=$VERIFIER_NAME --verifier-url=$VERIFIER_URL
+    ///
+    /// For detailed examples, see the documentation in `../../docs/DEPLOY_UPGRADE.md`.
     function run() public {
         _beginBroadcast(); // BroadcastManager.s.sol
         _deployMockRewardPool();

diff --git a/script/upgrade/UpgradeGroupingWorkflows.s.sol b/script/upgrade/UpgradeGroupingWorkflows.s.sol
@@ -32,9 +32,12 @@ contract UpgradeGroupingWorkflows is
 
     constructor() JsonDeploymentHandler("main") {}
 
-    /// @dev To use, run the following command (e.g. for Sepolia):
-    /// forge script script/upgrade/UpgradeGroupingWorkflows.s.sol:UpgradeGroupingWorkflows
-    /// --rpc-url $RPC_URL --broadcast --verify -vvvv
+    /// @dev To use, run the following command (e.g., for Story Iliad testnet):
+    /// forge script script/upgrade/UpgradeGroupingWorkflows.s.sol:UpgradeGroupingWorkflows \
+    /// --rpc-url=$TESTNET_URL -vvvv --broadcast --priority-gas-price=1 --legacy \
+    /// --verify  --verifier=$VERIFIER_NAME --verifier-url=$VERIFIER_URL
+    ///
+    /// For detailed examples, see the documentation in `../../docs/DEPLOY_UPGRADE.md`.
     function run() public {
         _readStoryProtocolCoreAddresses();
         _readStoryProtocolPeripheryAddresses();

diff --git a/script/upgrade/UpgradeSPG.s.sol b/script/upgrade/UpgradeSPG.s.sol
@@ -32,8 +32,12 @@ contract UpgradeSPG is
 
     constructor() JsonDeploymentHandler("main") {}
 
-    /// @dev To use, run the following command (e.g. for Sepolia):
-    /// forge script script/upgrade/UpgradeSPG.s.sol:UpgradeSPG --rpc-url $RPC_URL --broadcast --verify -vvvv
+    /// @dev To use, run the following command (e.g., for Story Iliad testnet):
+    /// forge script script/upgrade/UpgradeSPG.s.sol:UpgradeSPG \
+    /// --rpc-url=$TESTNET_URL -vvvv --broadcast --priority-gas-price=1 --legacy \
+    /// --verify  --verifier=$VERIFIER_NAME --verifier-url=$VERIFIER_URL
+    ///
+    /// For detailed examples, see the documentation in `../../docs/DEPLOY_UPGRADE.md`.
     function run() public {
         _readStoryProtocolCoreAddresses();
         _readStoryProtocolPeripheryAddresses();

diff --git a/script/upgrade/UpgradeSPGNFT.s.sol b/script/upgrade/UpgradeSPGNFT.s.sol
@@ -26,8 +26,12 @@ contract UpgradeSPGNFT is Script, StoryProtocolPeripheryAddressManager, Broadcas
 
     constructor() JsonDeploymentHandler("main") {}
 
-    /// @dev To use, run the following command (e.g. for Sepolia):
-    /// forge script script/upgrade/UpgradeSPGNFT.s.sol:UpgradeSPGNFT --rpc-url $RPC_URL --broadcast --verify -vvvv
+    /// @dev To use, run the following command (e.g., for Story Iliad testnet):
+    /// forge script script/upgrade/UpgradeSPGNFT.s.sol:UpgradeSPGNFT \
+    /// --rpc-url=$TESTNET_URL -vvvv --broadcast --priority-gas-price=1 --legacy \
+    /// --verify  --verifier=$VERIFIER_NAME --verifier-url=$VERIFIER_URL
+    ///
+    /// For detailed examples, see the documentation in `../../docs/DEPLOY_UPGRADE.md`.
     function run() public {
         _readStoryProtocolPeripheryAddresses();