redprint-forge - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

package.json

 {
   "name": "redprint-forge",
   "description": "A developer-friendly framework/library in solidity to modify & deploy OPStack ’s contracts in a modular style.",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "homepage": "https://github.com/Ratimon/redprint-forg#readme",
@@ -6,0 +6,0 @@ "keywords": [

README.md

@@ -5,2 +5,3 @@ <h1>Keep Optimistic and be OPStack deployer!! </h1>
 - [What is it for](#what-is-it-for)
+- [Quickstart](#quickstart)
 - [Contributing](#contributing)
@@ -64,5 +65,92 @@
 
+- Tx Management via Safe Smart Contract Deploy Script
+
 Together with [`Redprint Wizard UI`](https://github.com/Ratimon/redprint-wizard), which is a code generator/ interactive playground oriented for OPStack development, it does not only help novice developers to deploy OPStack's smart contracts to deploy on OP mainnet, but also help them to use generated deployment script in their own projects.
 
 
+## Quickstart
+
+### Tx Management Via Safe-Multisig
+
+You can write solidity script, then execute it from command-line in order to make any smart contract calls, or send transactions from your own safe multi-sig wallet.
+
+You can access both [`_upgradeAndCallViaSafe`](https://github.com/Ratimon/redprint-forge/blob/main/script/safe-management/SafeScript.sol#L27) and [`_callViaSafe`](https://github.com/Ratimon/redprint-forge/blob/main/script/safe-management/SafeScript.sol#L23) easily by inheriting and using from  in `redprint-forge` module ’s parent contract [`SafeScript`](https://github.com/Ratimon/redprint-forge/blob/main/script/safe-management/SafeScript.sol).
+ 
+#### Call and Upgrade Proxy Contract
+
+Let’s see a practical example when initializing one of OPStack's proxy contract ( eg. [`ProtocolVersions`](https://github.com/Ratimon/redprint-forge/blob/main/src/L1/ProtocolVersions.sol) ) by calling [`_upgradeAndCallViaSafe`](https://github.com/Ratimon/redprint-forge/blob/main/script/safe-management/SafeScript.sol#L27C1-L28C1):
+
+```ts
+
+/** ... */
+
+// `redprint-forge` 's core engine
+import { SafeScript} from "@redprint-deploy/safe-management/SafeScript.sol";
+
+/** ... */
+
+contract DeployAndInitializeProtocolVersionsScript is DeployScript, SafeScript {
+
+    /** ... */
+
+    function initializeProtocolVersions() public {
+      console.log("Upgrading and initializing ProtocolVersions proxy");
+
+      /** ... */
+
+      address proxyAdmin = deployer.mustGetAddress("ProxyAdmin");
+      address safe = deployer.mustGetAddress("SystemOwnerSafe");
+
+      /** ... */
+
+      _upgradeAndCallViaSafe({
+          _proxyAdmin: proxyAdmin,
+          _safe: safe,
+          _owner: owner,
+          _proxy: payable(protocolVersionsProxy),
+          _implementation: protocolVersions,
+          _innerCallData: abi.encodeCall(
+              ProtocolVersions.initialize,
+              (
+                  finalSystemOwner,
+                  ProtocolVersion.wrap(requiredProtocolVersion),
+                  ProtocolVersion.wrap(recommendedProtocolVersion)
+              )
+          )
+      });
+      /** ... */
+    }
+
+}
+
+```
+
+>[!NOTE]
+> You can the full example here: [`03B_DeployAndInitializeProtocolVersions.s.sol`](https://github.com/Ratimon/redprint-optimism-contracts-examples/blob/main/script/203B_DeployAndInitializeProtocolVersions.s.sol)
+
+#### Call to Any Contract with arbitrary data
+
+Let’s see another example at [`SafeScript`](https://github.com/Ratimon/redprint-forge/blob/main/script/safe-management/SafeScript.sol) itselfs. Our internal function just calls [`_callViaSafe`](https://github.com/Ratimon/redprint-forge/blob/main/script/safe-management/SafeScript.sol#L23):
+
+```ts
+/** ... */
+
+abstract contract SafeScript {
+
+  /** ... */
+
+  function _upgradeAndCallViaSafe( address _owner, address _proxyAdmin, address _safe, address _proxy, address _implementation, bytes memory _innerCallData) internal {
+
+      bytes memory data =
+          abi.encodeCall(ProxyAdmin.upgradeAndCall, (payable(_proxy), _implementation, _innerCallData));
+
+      Safe safe = Safe(payable(_safe));
+      _callViaSafe({ _safe: safe, _owner: _owner, _target: _proxyAdmin, _data: data });
+  }
+
+  /** ... */
+
+}
+```
+
 ## Contributing
@@ -79,2 +167,2 @@
   [Medium](https://medium.com/), or your personal blog.
-- Keep Optimistic !!
+- Keep Optimistic !!

No alert changes

Improved metrics

Total package byte prevSize

603700

increased by0.52%

Number of lines in readme file

165

increased by111.54%

No dependency changes