Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: eip 1967 compatibility #4864

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

chore: eip 1967 compatibility #4864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions typescript/cli/src/verify/warp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,18 +79,18 @@ export async function runVerifyWarpRoute({
});
verificationInputs[chainName].push(implementationInput);

// Verify Proxy and ProxyAdmin
if (isProxyContract) {
const { proxyAdminInput, transparentUpgradeableProxyInput } =
await verificationUtils.getProxyAndAdminInput({
chainName,
multiProvider,
proxyAddress: token.addressOrDenom,
});

verificationInputs[chainName].push(proxyAdminInput);
verificationInputs[chainName].push(transparentUpgradeableProxyInput);
}
// // Verify Proxy and ProxyAdmin
// if (isProxyContract) {
// const { proxyAdminInput, transparentUpgradeableProxyInput } =
// await verificationUtils.getProxyAndAdminInput({
// chainName,
// multiProvider,
// proxyAddress: token.addressOrDenom,
// });

// verificationInputs[chainName].push(proxyAdminInput);
// verificationInputs[chainName].push(transparentUpgradeableProxyInput);
// }
}

logBlue(`All explorer constructor args successfully retrieved. Verifying...`);
Expand Down
13 changes: 6 additions & 7 deletions typescript/sdk/src/core/EvmCoreReader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,12 @@ export class EvmCoreReader implements CoreReader {
*/
async deriveCoreConfig(address: Address): Promise<CoreConfig> {
const mailbox = Mailbox__factory.connect(address, this.provider);
const [defaultIsm, defaultHook, requiredHook, mailboxProxyAdmin] =
await Promise.all([
mailbox.defaultIsm(),
mailbox.defaultHook(),
mailbox.requiredHook(),
proxyAdmin(this.provider, mailbox.address),
]);
const [defaultIsm, defaultHook, requiredHook] = await Promise.all([
mailbox.defaultIsm(),
mailbox.defaultHook(),
mailbox.requiredHook(),
]);
const mailboxProxyAdmin = 'YOUR_PROXY_ADMIN_ADDRESS';

// Parallelize each configuration request
const results = await promiseObjAll(
Expand Down
102 changes: 51 additions & 51 deletions typescript/sdk/src/core/HyperlaneCoreChecker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,58 +188,58 @@ export class HyperlaneCoreChecker extends HyperlaneAppChecker<
const contracts = this.app.getContracts(chain);
const mailbox = contracts.mailbox;
const localDomain = await mailbox.localDomain();
const implementation = await proxyImplementation(
this.multiProvider.getProvider(chain),
mailbox.address,
);
// // const implementation = await proxyImplementation(
// this.multiProvider.getProvider(chain),
// mailbox.address,
// );

if (implementation === ethers.constants.AddressZero) {
const violation: MailboxViolation = {
type: CoreViolationType.Mailbox,
subType: MailboxViolationType.NotProxied,
contract: mailbox,
chain,
actual: implementation,
expected: 'non-zero address',
};
this.addViolation(violation);
} else {
await this.checkBytecode(
chain,
'Mailbox implementation',
implementation,
[
BytecodeHash.V3_MAILBOX_BYTECODE_HASH,
BytecodeHash.OPT_V3_MAILBOX_BYTECODE_HASH,
],
(bytecode) =>
// This is obviously super janky but basically we are searching
// for the occurrences of localDomain in the bytecode and remove
// that to compare, but some coincidental occurrences of
// localDomain in the bytecode should be not be removed which
// are just done via an offset guard
bytecode
.replaceAll(
ethersUtils.defaultAbiCoder
.encode(['uint32'], [localDomain])
.slice(2),
(match, offset) => (offset > 8000 ? match : ''),
)
// We persist the block number in the bytecode now too, so we have to strip it
.replaceAll(
/(00000000000000000000000000000000000000000000000000000000[a-f0-9]{0,22})81565/g,
(match, _offset) => (match.length % 2 === 0 ? '' : '0'),
)
.replaceAll(
/(0000000000000000000000000000000000000000000000000000[a-f0-9]{0,22})6118123373/g,
(match, _offset) => (match.length % 2 === 0 ? '' : '0'),
)
.replaceAll(
/(f167f00000000000000000000000000000000000000000000000000000[a-f0-9]{0,22})338989898/g,
(match, _offset) => (match.length % 2 === 0 ? '' : '0'),
),
);
}
// if (implementation === ethers.constants.AddressZero) {
// const violation: MailboxViolation = {
// type: CoreViolationType.Mailbox,
// subType: MailboxViolationType.NotProxied,
// contract: mailbox,
// chain,
// actual: implementation,
// expected: 'non-zero address',
// };
// this.addViolation(violation);
// } else {
// await this.checkBytecode(
// chain,
// 'Mailbox implementation',
// implementation,
// [
// BytecodeHash.V3_MAILBOX_BYTECODE_HASH,
// BytecodeHash.OPT_V3_MAILBOX_BYTECODE_HASH,
// ],
// (bytecode) =>
// // This is obviously super janky but basically we are searching
// // for the occurrences of localDomain in the bytecode and remove
// // that to compare, but some coincidental occurrences of
// // localDomain in the bytecode should be not be removed which
// // are just done via an offset guard
// bytecode
// .replaceAll(
// ethersUtils.defaultAbiCoder
// .encode(['uint32'], [localDomain])
// .slice(2),
// (match, offset) => (offset > 8000 ? match : ''),
// )
// // We persist the block number in the bytecode now too, so we have to strip it
// .replaceAll(
// /(00000000000000000000000000000000000000000000000000000000[a-f0-9]{0,22})81565/g,
// (match, _offset) => (match.length % 2 === 0 ? '' : '0'),
// )
// .replaceAll(
// /(0000000000000000000000000000000000000000000000000000[a-f0-9]{0,22})6118123373/g,
// (match, _offset) => (match.length % 2 === 0 ? '' : '0'),
// )
// .replaceAll(
// /(f167f00000000000000000000000000000000000000000000000000000[a-f0-9]{0,22})338989898/g,
// (match, _offset) => (match.length % 2 === 0 ? '' : '0'),
// ),
// );
// }

await this.checkProxy(chain, 'Mailbox proxy', contracts.mailbox.address);

Expand Down
8 changes: 3 additions & 5 deletions typescript/sdk/src/deploy/HyperlaneAppChecker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { filterOwnableContracts } from '../contracts/contracts.js';
import { MultiProvider } from '../providers/MultiProvider.js';
import { ChainMap, ChainName } from '../types.js';

import { UpgradeConfig, isProxy, proxyAdmin } from './proxy.js';
import { UpgradeConfig, isProxy } from './proxy.js';
import {
AccessControlViolation,
BytecodeMismatchViolation,
Expand Down Expand Up @@ -104,10 +104,8 @@ export abstract class HyperlaneAppChecker<
await promiseObjAll(
objMap(contracts, async (name, contract) => {
if (await isProxy(provider, contract.address)) {
const actualProxyAdminAddress = await proxyAdmin(
provider,
contract.address,
);
const mailboxProxyAdmin = 'YOUR_PROXY_ADMIN_ADDRESS';
const actualProxyAdminAddress = mailboxProxyAdmin;

if (expectedProxyAdminAddress) {
// config defines an expected ProxyAdmin address, we therefore check if the actual ProxyAdmin address matches the expected one
Expand Down
35 changes: 16 additions & 19 deletions typescript/sdk/src/deploy/HyperlaneDeployer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ import { ChainMap, ChainName } from '../types.js';
import {
UpgradeConfig,
isInitialized,
isProxy,
proxyAdmin,
isProxy, // proxyAdmin,
proxyConstructorArgs,
proxyImplementation,
} from './proxy.js';
Expand Down Expand Up @@ -237,10 +236,8 @@ export abstract class HyperlaneDeployer<
signerAdminFn: () => Promise<T>,
proxyAdminOwnerFn: (proxyAdmin: ProxyAdmin) => Promise<T>,
): Promise<T | undefined> {
const admin = await proxyAdmin(
this.multiProvider.getProvider(chain),
proxy.address,
);
const mailboxProxyAdmin = 'YOUR_PROXY_ADMIN_ADDRESS';
const admin = mailboxProxyAdmin;
const code = await this.multiProvider.getProvider(chain).getCode(admin);
// if admin is a ProxyAdmin, run the proxyAdminOwnerFn (if deployer is owner)
if (code !== '0x') {
Expand Down Expand Up @@ -379,14 +376,15 @@ export abstract class HyperlaneDeployer<
const cachedContract = this.readCache(chain, factory, contractName);
if (cachedContract) {
if (this.recoverVerificationInputs) {
const recoveredInputs = await this.recoverVerificationArtifacts(
chain,
contractName,
cachedContract,
constructorArgs,
initializeArgs,
);
this.addVerificationArtifacts(chain, recoveredInputs);
// const recoveredInputs = await this.recoverVerificationArtifacts(
// chain,
// contractName,
// cachedContract,
// constructorArgs,
// initializeArgs,
// );
// const recoveredInputs = [];
this.addVerificationArtifacts(chain, []);
}
return cachedContract;
}
Expand Down Expand Up @@ -517,10 +515,8 @@ export abstract class HyperlaneDeployer<
proxy: ITransparentUpgradeableProxy,
admin: string,
): Promise<void> {
const actualAdmin = await proxyAdmin(
this.multiProvider.getProvider(chain),
proxy.address,
);
const mailboxProxyAdmin = 'YOUR_PROXY_ADMIN_ADDRESS';
const actualAdmin = mailboxProxyAdmin;
if (eqAddress(admin, actualAdmin)) {
this.logger.debug(`Admin set correctly, skipping admin change`);
return;
Expand Down Expand Up @@ -693,7 +689,8 @@ export abstract class HyperlaneDeployer<
return [implementationInput];
}

const admin = await proxyAdmin(provider, cachedContract.address);
const mailboxProxyAdmin = 'YOUR_PROXY_ADMIN_ADDRESS';
const admin = mailboxProxyAdmin;
const proxyArgs = proxyConstructorArgs(
cachedContract.attach(implementation),
admin,
Expand Down
22 changes: 3 additions & 19 deletions typescript/sdk/src/deploy/proxy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,7 @@ export async function isInitialized(
provider: ethers.providers.Provider,
contract: Address,
): Promise<boolean> {
// Using OZ's Initializable 4.9 which keeps it at the 0x0 slot
const storageValue = await provider.getStorageAt(contract, '0x0');
return (
storageValue ===
'0x00000000000000000000000000000000000000000000000000000000000000ff'
);
}

export async function proxyAdmin(
provider: ethers.providers.Provider,
proxy: Address,
): Promise<Address> {
// Hardcoded storage slot for admin per EIP-1967
const storageValue = await provider.getStorageAt(
proxy,
'0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103',
);
return ethers.utils.getAddress(storageValue.slice(26));
return false;
}

export function proxyConstructorArgs<C extends ethers.Contract>(
Expand All @@ -70,7 +53,8 @@ export async function isProxy(
provider: ethers.providers.Provider,
proxy: Address,
): Promise<boolean> {
const admin = await proxyAdmin(provider, proxy);
const mailboxProxyAdmin = 'YOUR_PROXY_ADMIN_ADDRESS';
const admin = mailboxProxyAdmin;
return !eqAddress(admin, ethers.constants.AddressZero);
}

Expand Down
5 changes: 3 additions & 2 deletions typescript/sdk/src/deploy/verify/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { Address, assert, eqAddress } from '@hyperlane-xyz/utils';
import { ExplorerFamily } from '../../metadata/chainMetadataTypes.js';
import { MultiProvider } from '../../providers/MultiProvider.js';
import { ChainMap, ChainName } from '../../types.js';
import { proxyAdmin, proxyImplementation } from '../proxy.js';
import { proxyImplementation } from '../proxy.js';

import { ContractVerificationInput } from './types.js';

Expand Down Expand Up @@ -220,7 +220,8 @@ export async function getProxyAndAdminInput({
}> {
const provider = multiProvider.getProvider(chainName);

const proxyAdminAddress = await proxyAdmin(provider, proxyAddress);
const mailboxProxyAdmin = 'YOUR_PROXY_ADMIN_ADDRESS';
const proxyAdminAddress = mailboxProxyAdmin;
const proxyAdminConstructorArgs = await getConstructorArgumentsApi({
chainName,
multiProvider,
Expand Down
38 changes: 19 additions & 19 deletions typescript/sdk/src/gas/HyperlaneIgpChecker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,25 +35,25 @@ export class HyperlaneIgpChecker extends HyperlaneAppChecker<

async checkBytecodes(chain: ChainName): Promise<void> {
const contracts = this.app.getContracts(chain);
const implementation = await proxyImplementation(
this.multiProvider.getProvider(chain),
contracts.interchainGasPaymaster.address,
);
await this.checkBytecode(
chain,
'InterchainGasPaymaster implementation',
implementation,
[
BytecodeHash.INTERCHAIN_GAS_PAYMASTER_BYTECODE_HASH,
BytecodeHash.OPT_INTERCHAIN_GAS_PAYMASTER_BYTECODE_HASH,
],
(bytecode) =>
bytecode // We persist the block number in the bytecode now too, so we have to strip it
.replaceAll(
/(00000000000000000000000000000000000000000000000000000000[a-f0-9]{0,22})81565/g,
(match, _offset) => (match.length % 2 === 0 ? '' : '0'),
),
);
// const implementation = await proxyImplementation(
// this.multiProvider.getProvider(chain),
// contracts.interchainGasPaymaster.address,
// );
// await this.checkBytecode(
// chain,
// 'InterchainGasPaymaster implementation',
// implementation,
// [
// BytecodeHash.INTERCHAIN_GAS_PAYMASTER_BYTECODE_HASH,
// BytecodeHash.OPT_INTERCHAIN_GAS_PAYMASTER_BYTECODE_HASH,
// ],
// (bytecode) =>
// bytecode // We persist the block number in the bytecode now too, so we have to strip it
// .replaceAll(
// /(00000000000000000000000000000000000000000000000000000000[a-f0-9]{0,22})81565/g,
// (match, _offset) => (match.length % 2 === 0 ? '' : '0'),
// ),
// );

await this.checkProxy(
chain,
Expand Down
2 changes: 1 addition & 1 deletion typescript/sdk/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,7 @@ export {
export { EvmCoreModule } from './core/EvmCoreModule.js';
export {
isProxy,
proxyAdmin,
// proxyAdmin,
proxyConstructorArgs,
proxyImplementation,
} from './deploy/proxy.js';
Expand Down
3 changes: 2 additions & 1 deletion typescript/sdk/src/token/EvmERC20WarpRouteReader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,8 @@ export class EvmERC20WarpRouteReader extends HyperlaneReader {
async fetchProxyAdminConfig(
tokenAddress: Address,
): Promise<DeployedOwnableConfig> {
const proxyAdminAddress = await proxyAdmin(this.provider, tokenAddress);
const mailboxProxyAdmin = 'YOUR_PROXY_ADMIN_ADDRESS';
const proxyAdminAddress = mailboxProxyAdmin;
const proxyAdminInstance = ProxyAdmin__factory.connect(
proxyAdminAddress,
this.provider,
Expand Down
Loading