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

Fix manifest error when connecting to an Anvil dev network #950

Merged
merged 6 commits into from
Dec 21, 2023
Merged

Fix manifest error when connecting to an Anvil dev network #950

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ba9354e
Handle null forkedNetwork from anvil
ericglau Dec 20, 2023
1ee2bd3
Update changelog
ericglau Dec 20, 2023
fcd8771
Update changelog
ericglau Dec 20, 2023
2d497ad
Only keep necessary error handling, use stronger types
ericglau Dec 20, 2023
9f182ec
Use anvil_metadata if available
ericglau Dec 20, 2023
e78d649
spacing
ericglau Dec 21, 2023
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
4 changes: 4 additions & 0 deletions packages/core/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## Unreleased

- Fix manifest error when connecting to an Anvil dev network. ([#950](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/950))

## 1.32.1 (2023-12-14)

- CLI: Fix ambiguous name error when passing in fully qualified contract names. ([#944](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/944))
Expand Down
16 changes: 14 additions & 2 deletions packages/core/src/manifest.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,11 +399,23 @@ test('manifest name for an unknown network, development instance, non hardhat',
test('manifest name for an unknown network, development instance, hardhat', t => {
const chainId = 31337;
const instanceId = '0x22223';
const devInstanceMetadata = { networkName: 'dev', instanceId: instanceId };
const devInstanceMetadata = { networkName: 'hardhat', instanceId: instanceId };

const manifest = new Manifest(chainId, devInstanceMetadata, '/tmp');

const expectedPath = `/tmp/openzeppelin-upgrades/dev-${chainId}-${instanceId}.json`;
const expectedPath = `/tmp/openzeppelin-upgrades/hardhat-${chainId}-${instanceId}.json`;
t.is(manifest.file, expectedPath);
t.is(manifest.fallbackFile, `.openzeppelin/unknown-${chainId}.json`);
});

test('manifest name for an unknown network, development instance, anvil - forkedNetwork null', t => {
const chainId = 31337;
const instanceId = '0x22224';
const devInstanceMetadata = { networkName: 'anvil', instanceId: instanceId, forkedNetwork: null };

const manifest = new Manifest(chainId, devInstanceMetadata, '/tmp');

const expectedPath = `/tmp/openzeppelin-upgrades/anvil-${chainId}-${instanceId}.json`;
t.is(manifest.file, expectedPath);
t.is(manifest.fallbackFile, `.openzeppelin/unknown-${chainId}.json`);
});
Expand Down
10 changes: 5 additions & 5 deletions packages/core/src/manifest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import os from 'os';
import path from 'path';
import { promises as fs } from 'fs';
import { EthereumProvider, getChainId, getHardhatMetadata, networkNames } from './provider';
import { EthereumProvider, HardhatMetadata, getChainId, getHardhatMetadata, networkNames } from './provider';
import lockfile from 'proper-lockfile';
import { compare as compareVersions } from 'compare-versions';

Expand Down Expand Up @@ -48,7 +48,7 @@ async function getDevInstanceMetadata(
provider: EthereumProvider,
chainId: number,
): Promise<DevInstanceMetadata | undefined> {
let hardhatMetadata;
let hardhatMetadata: HardhatMetadata;

try {
hardhatMetadata = await getHardhatMetadata(provider);
Expand All @@ -63,7 +63,7 @@ async function getDevInstanceMetadata(
}

return {
networkName: 'hardhat',
networkName: hardhatMetadata.clientVersion.startsWith('anvil') ? 'anvil' : 'hardhat',
instanceId: hardhatMetadata.instanceId,
forkedNetwork: hardhatMetadata.forkedNetwork,
};
Expand All @@ -83,7 +83,7 @@ interface DevInstanceMetadata {
forkedNetwork?: {
// The chainId of the network that is being forked
chainId: number;
};
} | null;
}

export class Manifest {
Expand Down Expand Up @@ -129,7 +129,7 @@ export class Manifest {
}
debug('development manifest file:', this.file, 'fallback file:', this.fallbackFile);

if (devInstanceMetadata.forkedNetwork !== undefined) {
if (devInstanceMetadata.forkedNetwork) {
const forkedChainId = devInstanceMetadata.forkedNetwork.chainId;
debug('forked network chain id:', forkedChainId);

Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,14 @@ export interface EthereumProvider {
send(method: string, params: unknown[]): Promise<unknown>;
}

interface HardhatMetadata {
export interface HardhatMetadata {
clientVersion: string;
chainId: number;
instanceId: string;
forkedNetwork?: {
// The chainId of the network that is being forked
chainId: number;
};
} | null;
}

interface EthereumTransaction {
Expand Down