Merge pull request #17 from push-protocol/upgradeable-factory

feat: made Factory contract upgradeable via Transparent Proxy

Author: 0xNilesh

x/ue/keeper/genesis.go

@@ -12,13 +12,44 @@ import (
 	"github.com/rollchains/pchain/x/ue/types"
 )
 
-func deployFactoryContract(ctx context.Context, evmKeeper types.EVMKeeper) {
+func deployFactoryProxy(ctx context.Context, evmKeeper types.EVMKeeper) {
 	sdkCtx := sdk.UnwrapSDKContext(ctx)
-	factoryAddress := common.HexToAddress(types.FACTORY_ADDRESS_HEX)
-	owner := common.HexToAddress(types.FACTORY_OWNER_ADDRESS_HEX)
+	proxyAddress := common.HexToAddress(types.FACTORY_PROXY_ADDRESS_HEX)
+	proxyAdminOwner := common.HexToAddress(types.PROXY_ADMIN_ADDRESS_HEX)
+	factoryImplAddress := common.HexToAddress(types.FACTORY_IMPL_ADDRESS_HEX)
 
 	// Compute the code hash from the runtime bytecode
-	codeHash := crypto.Keccak256(types.FactoryRuntimeBytecode)
+	codeHash := crypto.Keccak256(types.ProxyRuntimeBytecode)
+
+	// Create the EVM account object
+	evmAccount := statedb.Account{
+		Nonce:    1,             // to prevent tx nonce=0 conflicts
+		Balance:  big.NewInt(0), // zero balance by default
+		CodeHash: codeHash,      // link to deployed code
+	}
+
+	// Set the EVM account with the factory proxy contract
+	err := evmKeeper.SetAccount(sdkCtx, proxyAddress, evmAccount)
+	if err != nil {
+		panic("failed to set factory proxy contract account: " + err.Error())
+	}
+
+	// Store the runtime bytecode linked to the code hash
+	evmKeeper.SetCode(sdkCtx, codeHash, types.ProxyRuntimeBytecode)
+
+	// Update proxyAdmin Slot with the proxyAdmin owner address (left padded to 32 bytes)
+	evmKeeper.SetState(sdkCtx, proxyAddress, types.PROXY_ADMIN_SLOT, common.LeftPadBytes(proxyAdminOwner.Bytes(), 32))
+
+	// Update proxyImplementation Slot with the factory implementation address (left padded to 32 bytes)
+	evmKeeper.SetState(sdkCtx, proxyAddress, types.PROXY_IMPLEMENTATION_SLOT, common.LeftPadBytes(factoryImplAddress.Bytes(), 32))
+}
+
+func deployFactoryImplContract(ctx context.Context, evmKeeper types.EVMKeeper) {
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	factoryAddress := common.HexToAddress(types.FACTORY_IMPL_ADDRESS_HEX)
+
+	// Compute the code hash from the runtime bytecode
+	codeHash := crypto.Keccak256(types.FactoryImplRuntimeBytecode)
 
 	// Create the EVM account object
 	evmAccount := statedb.Account{
@@ -34,8 +65,44 @@ func deployFactoryContract(ctx context.Context, evmKeeper types.EVMKeeper) {
 	}
 
 	// Store the runtime bytecode linked to the code hash
-	evmKeeper.SetCode(sdkCtx, codeHash, types.FactoryRuntimeBytecode)
+	evmKeeper.SetCode(sdkCtx, codeHash, types.FactoryImplRuntimeBytecode)
+}
+
+func deployProxyAdminContract(ctx context.Context, evmKeeper types.EVMKeeper) {
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	proxyAdminAddress := common.HexToAddress(types.PROXY_ADMIN_ADDRESS_HEX)
+	owner := common.HexToAddress(types.PROXY_ADMIN_OWNER_ADDRESS_HEX)
+
+	// Compute the code hash from the runtime bytecode
+	codeHash := crypto.Keccak256(types.ProxyAdminRuntimeBytecode)
+
+	// Create the EVM account object
+	evmAccount := statedb.Account{
+		Nonce:    1,             // to prevent tx nonce=0 conflicts
+		Balance:  big.NewInt(0), // zero balance by default
+		CodeHash: codeHash,      // link to deployed code
+	}
+
+	// Set the EVM account with the proxy admin contract
+	err := evmKeeper.SetAccount(sdkCtx, proxyAdminAddress, evmAccount)
+	if err != nil {
+		panic("failed to set proxy admin contract account: " + err.Error())
+	}
+
+	// Store the runtime bytecode linked to the code hash
+	evmKeeper.SetCode(sdkCtx, codeHash, types.ProxyAdminRuntimeBytecode)
 
 	// Initialize storage slot 0 (Ownable.owner) with the owner address (left padded to 32 bytes)
-	evmKeeper.SetState(sdkCtx, factoryAddress, common.Hash{}, common.LeftPadBytes(owner.Bytes(), 32))
+	evmKeeper.SetState(sdkCtx, proxyAdminAddress, common.Hash{}, common.LeftPadBytes(owner.Bytes(), 32))
+}
+
+func deployFactoryEA(ctx context.Context, evmKeeper types.EVMKeeper) {
+	// Deploy the factory implementation contract
+	deployFactoryImplContract(ctx, evmKeeper)
+
+	// Deploy the proxy admin contract
+	deployProxyAdminContract(ctx, evmKeeper)
+
+	// Deploy the factory proxy contract
+	deployFactoryProxy(ctx, evmKeeper)
 }

x/ue/keeper/keeper.go

@@ -79,8 +79,8 @@ func (k *Keeper) InitGenesis(ctx context.Context, data *types.GenesisState) erro
 		return err
 	}
 
-	// deploy factory at 0xEA address
-	deployFactoryContract(ctx, k.evmKeeper)
+	// deploy factory proxy at 0xEA address
+	deployFactoryEA(ctx, k.evmKeeper)
 
 	return k.Params.Set(ctx, data.Params)
 }

x/ue/keeper/msg_deploy_uea.go

@@ -21,7 +21,7 @@ func (k Keeper) deployUEA(ctx context.Context, evmFrom common.Address, universal
 	fmt.Println("Base Fee BigInt:", baseFeeBig)
 
 	// EVM Call arguments
-	factoryAddress := common.HexToAddress(types.FACTORY_ADDRESS_HEX)
+	factoryAddress := common.HexToAddress(types.FACTORY_PROXY_ADDRESS_HEX)
 
 	// RPC call verification to verify the gateway interaction tx on source chain
 	err := k.utvKeeper.VerifyGatewayInteractionTx(ctx, universalAccount.Owner, txHash, universalAccount.Chain)

x/ue/keeper/msg_execute_payload.go

@@ -25,7 +25,7 @@ func (k Keeper) executePayload(ctx context.Context, evmFrom common.Address, univ
 		return fmt.Errorf("chain %s is not enabled", universalAccount.Chain)
 	}
 
-	factoryAddress := common.HexToAddress(types.FACTORY_ADDRESS_HEX)
+	factoryAddress := common.HexToAddress(types.FACTORY_PROXY_ADDRESS_HEX)
 
 	// Step 1: Compute smart account address
 	receipt, err := k.CallFactoryToComputeUEAAddress(sdkCtx, evmFrom, factoryAddress, universalAccount)

x/ue/keeper/msg_mint_push.go

@@ -18,7 +18,7 @@ import (
 func (k Keeper) mintPush(ctx context.Context, evmFrom common.Address, universalAccount *types.UniversalAccount, txHash string) error {
 	sdkCtx := sdk.UnwrapSDKContext(ctx)
 
-	factoryAddress := common.HexToAddress(types.FACTORY_ADDRESS_HEX)
+	factoryAddress := common.HexToAddress(types.FACTORY_PROXY_ADDRESS_HEX)
 
 	// RPC call verification to get amount to be mint
 	amountOfUsdLocked, usdDecimals, err := k.utvKeeper.VerifyAndGetLockedFunds(ctx, universalAccount.Owner, txHash, universalAccount.Chain)