Feature: oft adapter step3 - deploy script and test by blueogin · Pull Request #11 · GoodDollar/GoodBridge

blueogin · 2026-01-30T12:51:02Z

Description

This PR implements the deployment scripts and testing infrastructure for the GoodDollar OFT (Omnichain Fungible Token) adapter system. The implementation enables cross-chain bridging of GoodDollar tokens between XDC and CELO networks using LayerZero's OFT protocol.

About #7

How Has This Been Tested?

https://layerzeroscan.com/tx/0x3575146c0e395d46b4a3e09ec3ae79e1005ea6d4461765d6dc19d6aebed512bb
https://layerzeroscan.com/tx/0xa267c36a25337ea8d45d83de83a3e83a291ba4d2eaf0fd0393d365faf3c078e8

Checklist:

…acts, including enabling hardhat-deploy and adding new network configurations for CELO and XDC

… management structures, and add deployment and configuration scripts for cross-chain functionality

…C network, enhance GoodDollarOFTAdapter with upgrade authorization event, and modify deployment scripts for improved functionality

…ant fee deduction details

sourcery-ai

Sorry @blueogin, your pull request is larger than the review limit of 150000 diff characters

sirpy · 2026-02-02T07:39:27Z

packages/bridge-contracts/contracts/oft/GoodDollarOFTAdapter.sol

+    function _authorizeUpgrade(address newImplementation) internal override onlyOwner {
+        // Authorization is handled by onlyOwner modifier
+        // Additional checks can be added here if needed
+        emit AuthorizedUpgrade(newImplementation);


no required

Okay, It was required for UUPSUpgradeable contract.
I will use transparent model and remove that function

i ment that the emit event is not requred. we should use uups

I see I will make it use UUPS

packages/bridge-contracts/release/deployment.json

sirpy · 2026-02-02T07:51:35Z

packages/bridge-contracts/scripts/oft/configure-oft-xdc-celo.sh

+# 6. Test bridge functionality (optional, last step)
+#
+# Usage:
+#   ./scripts/multichain-deploy/oft/configure-oft-xdc-celo.sh


In general scripts should be hardhat scripts in typescript. not shell.

the script should configure a single network ie configure-oft.ts --network development-xdc

the script should be a hardhat script so --network is available

all config values should be read from a json file ie oft.config.json (import config from './oft.config.json')
where each network/env has its entry in the config file.

This file is rarely used in a production environment and is intended mainly as a reference.
Also, including all configuring logic into 1 script is not ideal I think
I’ll add an OFT_CONFIGURING_GUIDE file under scripts/oft to explain the configuration steps.

we use hadhat-deploy scripts , see messagepassingbridge

It's now using hardhat-deploy script

sirpy · 2026-02-02T07:52:15Z

packages/bridge-contracts/test/oft/configure-oft-xdc-celo.sh

+echo ""
+
+# Step 7: Test bridge (optional, last step)
+if [ "$SKIP_BRIDGE_TEST" != "true" ]; then


should be separated into a different script. ( a hardhat script)

packages/bridge-contracts/scripts/oft/oft-deploy.ts

packages/bridge-contracts/.env.sample

packages/bridge-contracts/hardhat.config.ts

packages/bridge-contracts/contracts/oft/GoodDollarOFTAdapter.sol

… unused dependencies in bridge-contracts

openzeppelin-code · 2026-02-02T12:54:33Z

Feature: oft adapter step3 - deploy script and test

Generated at commit: 86d4b555c138354b9a3f92281eb5f7a82f3bff10

🚨 Report Summary

	Severity Level	Results
Contracts	Critical High Medium Low Note Total	0 1 0 9 36 46
Dependencies	Critical High Medium Low Note Total	0 0 0 0 0 0

For more details view the full report in OpenZeppelin Code Inspector

…nd to transparent in GoodDollarOFTAdapter and deployment script

…pts to reference new deployment file

…nd update set-minter-burner-limits script to utilize new config

…nd CELO networks

…t for cleaner implementation

…and integrating IMessagePassingBridge for limit management

sirpy · 2026-02-04T10:12:15Z

packages/bridge-contracts/scripts/oft/oft-deploy.ts

    MinterBurner = await upgrades.deployProxy(
      MinterBurnerFactory,
      [nameServiceAddress],
-      { kind: "uups", initializer: "initialize" }


i dont understand. why this was changed. we use uups

It's now using uups

sirpy · 2026-02-04T10:14:53Z

packages/bridge-contracts/scripts/oft/oft-deploy.ts

 import fse from "fs-extra";
 import Contracts from "@gooddollar/goodprotocol/releases/deployment.json";
-import release from "../../release/deployment.json";
+import release from "../../release/deployment-oft.json";


why are we not using hardhat-deploy for deployment scripts

we are using hardhat-deploy now

sirpy · 2026-02-04T10:16:23Z

packages/bridge-contracts/test/oft/OFT_CONFIGURING_GUIDE.md

+
+**Note**: Limit values can be specified in decimal format (e.g., "5000" for 5,000 G$). The scripts automatically convert them to wei (18 decimals).
+
+## Manual Configuration: Step-by-Step


we should have a hardhat deploy script just like messagepassingbridge has

sirpy · 2026-02-04T10:17:07Z

packages/bridge-contracts/contracts/oft/GoodDollarOFTAdapter.sol

+    function _authorizeUpgrade(address newImplementation) internal override onlyOwner {
+        // Authorization is handled by onlyOwner modifier
+        // Additional checks can be added here if needed
+        emit AuthorizedUpgrade(newImplementation);


i ment that the emit event is not requred. we should use uups

packages/bridge-contracts/contracts/oft/GoodDollarOFTAdapter.sol

…code clarity and reduce dependencies

…te request approval mechanism to use bytes32 IDs, and implement request ID generation for improved limit management

… MinterBurner contracts

…oved clarity, implement request approval checks, and enforce limits on sending and receiving functions

…8.9 with optimizer settings and modify LayerZero config to reference the correct deployment file

…zation for enhanced fee management

…ove legacy deployment script; add set-oft-operator script for DAO governance integration

…terministic proxy pattern and improve initialization process

…ormula, IGoodDollarCustom, ISuperGoodDollar, and related interfaces

… updated before processing receive requests

…dDollarOFTAdapter, and adjust bridging amount in tests

…and production environments for GoodDollarMinterBurner and GoodDollarOFTAdapter

…dDollarOFTAdapter in development environments

…quest function to remove owner restriction in GoodDollarOFTAdapter

…to bridging configuration

…ions from OFT_CONFIGURING_GUIDE.md for clarity

…to streamline settings

…st to ensure proper allowance before quoteSend

… GoodDollar OFT contracts

sirpy · 2026-03-17T14:42:29Z

packages/bridge-contracts/deploy/deployOFT.ts

+    release[networkName] = {};
+  }
+  release[networkName].GoodDollarMinterBurner = minterBurnerAddress;
+  await fse.writeJSON('release/deployment-oft.json', release, { spaces: 2 });


hardhat deploy already writes to file. look at the help

Now it reads contract addresses from files that are automatically generated by hardhat-deploy.

sirpy · 2026-03-17T14:43:14Z

packages/bridge-contracts/deploy/deployOFT.ts

+
+  // Verify GoodDollarMinterBurner implementation (no constructor args)
+  if (!['hardhat', 'localhost', 'develop'].includes(networkName)) {
+    await verifyContract(hre as any, minterBurnerImpl.address, [], 'GoodDollarMinterBurner');


verify for all envs. you can exclude hardhat and localhost

Removed develop from the helper’s skip list, so it also no longer skips verification on develop.

sirpy · 2026-03-17T14:45:33Z

packages/bridge-contracts/deploy/upgradeOFT.ts

+
+  // --- GoodDollarOFTAdapter: deploy new implementation via hardhat-deploy, then upgrade proxy ---
+  console.log("\nDeploying new GoodDollarOFTAdapter implementation...");
+  const oftAdapterImpl = await deployments.deploy("GoodDollarOFTAdapter_Implementation_Upgrade", {


should impl be deterministic?
in the deploy script it is

Now the implementation contracts are deployed deterministically with the salt of contract's bytecode

sirpy · 2026-03-17T14:49:05Z

packages/bridge-contracts/test/oft/set-bridge-limits.ts

@@ -0,0 +1,184 @@
+/***


rename file

Okay I will rename it to set-bridge-limits.ts

sirpy · 2026-03-17T14:53:32Z

packages/bridge-contracts/deploy/deployOFT.ts

@@ -0,0 +1,249 @@
+/***


make sure this scripts does all the steps required for full deployment.
besides DAO related actions such as giving minter rights to the minterburner

I confirmed that all 7 steps are required

Step 1 deploys and initializes the OFT contracts, which has to happen before anything else.
Step 2 sets the adapter as operator via DAO governance
Step 3 grants MINTER_ROLE via DAO governance
Step 4 wires LayerZero connections/enforced options, an external integration step that can fail and has to be run with the correct owner/delegate permissions.
Step 5 sets bridge limits as an optional step because you may not want to set them.
Step 6 tests bridging and is optional because it depends on having balances/gas/fees and is meant as a validation step, not a core deployment requirement.
Step 7 transfers ownership to the DAO Avatar and is optional.

…cing configuration management and transaction execution

…etting bridge limits and transferring ownership, enhancing user understanding

…MinterBurner to use consistent implementation naming and enable deterministic deployments

…dDollarMinterBurner and GoodDollarOFTAdapter in deployment and upgrade scripts

…' network, enhancing clarity in network handling for GoodDollarMinterBurner and GoodDollarOFTAdapter

…tifacts for GoodDollarOFTAdapter and GoodDollarMinterBurner, improving deployment consistency and error handling

…across deployment scripts, tests, and documentation for consistency and clarity in cross-chain token management

blueogin · 2026-03-19T16:17:50Z

Hi @sirpy
Could you please review?

blueogin added 6 commits January 26, 2026 14:51

chore: update hardhat configuration and dependencies for bridge contr…

7d00674

…acts, including enabling hardhat-deploy and adding new network configurations for CELO and XDC

feat: enhance GoodDollarOFTAdapter with new bridge limits and account…

6a11b79

… management structures, and add deployment and configuration scripts for cross-chain functionality

Merge branch 'feat/oft-adapter-step2' into feat/oft-adatper-step3

b54c09b

feat: add .env.sample for configuration, update Hardhat config for XD…

56be154

…C network, enhance GoodDollarOFTAdapter with upgrade authorization event, and modify deployment scripts for improved functionality

Merge branch 'feat/oft-adapter-step2' into feat/oft-adatper-step3

3b1ea49

fix: clarify documentation in GoodDollarOFTAdapter by removing redund…

b45c2ae

…ant fee deduction details

sourcery-ai bot reviewed Jan 30, 2026

View reviewed changes

chore: remove outdated verification script for GoodDollar OFT contracts

89fae4a

sirpy changed the base branch from master to feat/oft-adapter-step2 February 2, 2026 07:37

sirpy requested changes Feb 2, 2026

View reviewed changes

sirpy reviewed Feb 2, 2026

View reviewed changes

packages/bridge-contracts/contracts/oft/GoodDollarOFTAdapter.sol Show resolved Hide resolved

refactor: update ISuperGoodDollar interface implementation and remove…

76e9709

… unused dependencies in bridge-contracts

blueogin added 9 commits February 2, 2026 08:48

Merge branch 'feat/oft-adapter-step2' into feat/oft-adatper-step3

d77238d

refactor: remove upgrade authorization logic and change deployment ki…

fb5d269

…nd to transparent in GoodDollarOFTAdapter and deployment script

feat: introduce deployment-oft.json for OFT contracts and update scri…

1d08bce

…pts to reference new deployment file

feat: add oft.config.json for network-specific limit configurations a…

124a1a1

…nd update set-minter-burner-limits script to utilize new config

docs: add OFT configuration guide for cross-chain setup between XDC a…

d1dc1d4

…nd CELO networks

refactor: remove unused initialization code from OFT deployment scrip…

9d11522

…t for cleaner implementation

chore: enable contract size checking on compile in Hardhat configuration

c5b45df

refactor: streamline GoodDollarOFTAdapter by removing unused structs …

e907906

…and integrating IMessagePassingBridge for limit management

Merge branch 'feat/oft-adapter-step2' into feat/oft-adatper-step3

5c4c510

sirpy requested changes Feb 4, 2026

View reviewed changes

blueogin added 7 commits February 4, 2026 09:36

refactor: remove unused imports from GoodDollarOFTAdapter to enhance …

30178c0

…code clarity and reduce dependencies

refactor: enhance GoodDollarOFTAdapter with UUPS upgradeability, upda…

71da58c

…te request approval mechanism to use bytes32 IDs, and implement request ID generation for improved limit management

refactor: update OFT deployment script to use UUPS upgradeability for…

e67caf1

… MinterBurner contracts

refactor: reorganize GoodDollarOFTAdapter contract structure for impr…

52284e0

…oved clarity, implement request approval checks, and enforce limits on sending and receiving functions

refactor: update Hardhat configuration to include Solidity version 0.…

0f8d105

…8.9 with optimizer settings and modify LayerZero config to reference the correct deployment file

refactor: add feeRecipient parameter to GoodDollarOFTAdapter initiali…

a4b2c68

…zation for enhanced fee management

feat: introduce deployOFT script for GoodDollar OFT contracts and rem…

b678f7b

…ove legacy deployment script; add set-oft-operator script for DAO governance integration

blueogin added 4 commits March 2, 2026 11:19

feat: refactor deployment script for GoodDollarMinterBurner to use de…

2b109b2

…terministic proxy pattern and improve initialization process

chore: remove OFT configuration script for XDC and CELO networks

365283e

chore: remove unused contract factory and type definitions for IFeesF…

a98d554

…ormula, IGoodDollarCustom, ISuperGoodDollar, and related interfaces

fix: correct logic in GoodDollarOFTAdapter to ensure daily limits are…

04e4c2a

… updated before processing receive requests

blueogin requested a review from sirpy March 2, 2026 17:15

blueogin added 12 commits March 3, 2026 06:43

chore: update deployment addresses for GoodDollarMinterBurner and Goo…

bd2e5d1

…dDollarOFTAdapter, and adjust bridging amount in tests

Merge branch 'feat/oft-adapter-step2' into feat/oft-adatper-step3

9406240

feat: enhance deployment script to differentiate between development …

4a1e1a3

…and production environments for GoodDollarMinterBurner and GoodDollarOFTAdapter

chore: update deployment addresses for GoodDollarMinterBurner and Goo…

b748e7f

…dDollarOFTAdapter in development environments

fix: update OPTIMISTIC_WINDOW to 5 minutes and modify approveFailedRe…

aa25144

…quest function to remove owner restriction in GoodDollarOFTAdapter

chore: clean up .env.sample by removing deprecated variables related …

8ecceb6

…to bridging configuration

chore: remove outdated configuration options and troubleshooting sect…

59df931

…ions from OFT_CONFIGURING_GUIDE.md for clarity

chore: remove unnecessary configuration options from oft.config.json …

86d4b55

…to streamline settings

Merge branch 'feat/oft-adapter-step2' into feat/oft-adatper-step3

b368b8c

feat: add token approval step for MinterBurner in bridge-oft-token te…

75d4e99

…st to ensure proper allowance before quoteSend

Merge branch 'feat/oft-adapter-step2' into feat/oft-adatper-step3

ac95378

feat: update XDC RPC URL in hardhat config and add upgrade script for…

67c8191

… GoodDollar OFT contracts

sirpy requested changes Mar 17, 2026

View reviewed changes

blueogin added 10 commits March 18, 2026 11:11

Merge branch 'feat/oft-adapter-step2' into feat/oft-adatper-step3

4274043

feat: add script to set bridge limits for GoodDollarOFTAdapter, enhan…

9abc6ad

…cing configuration management and transaction execution

docs: update OFT_CONFIGURING_GUIDE.md to clarify optional steps for s…

82f7167

…etting bridge limits and transferring ownership, enhancing user understanding

fix: update deployment script for GoodDollarOFTAdapter and GoodDollar…

38ce793

…MinterBurner to use consistent implementation naming and enable deterministic deployments

refactor: implement CREATE2 salt for deterministic deployments of Goo…

5cd6658

…dDollarMinterBurner and GoodDollarOFTAdapter in deployment and upgrade scripts

refactor: update deployment scripts to skip verification for 'develop…

dba7ec6

…' network, enhancing clarity in network handling for GoodDollarMinterBurner and GoodDollarOFTAdapter

refactor: replace usage of deployment-oft.json with hardhat-deploy ar…

1c209f3

…tifacts for GoodDollarOFTAdapter and GoodDollarMinterBurner, improving deployment consistency and error handling

Merge branch 'feat/oft-adapter-step2' into feat/oft-adatper-step3

4c87230

Merge branch 'feat/oft-adapter-step2' into feat/oft-adatper-step3

df199e2

refactor: rename GoodDollarMinterBurner to GoodDollarOFTMinterBurner …

57507a2

…across deployment scripts, tests, and documentation for consistency and clarity in cross-chain token management

blueogin requested a review from sirpy March 19, 2026 16:17


		Note: Limit values can be specified in decimal format (e.g., "5000" for 5,000 G$). The scripts automatically convert them to wei (18 decimals).

		## Manual Configuration: Step-by-Step

Conversation

blueogin commented Jan 30, 2026

Description

How Has This Been Tested?

Checklist:

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blueogin Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blueogin Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openzeppelin-code bot commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Feature: oft adapter step3 - deploy script and test

🚨 Report Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blueogin Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blueogin Feb 2, 2026 •

edited

Loading

blueogin Feb 2, 2026 •

edited

Loading

openzeppelin-code bot commented Feb 2, 2026 •

edited

Loading

blueogin Mar 18, 2026 •

edited

Loading