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.

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

feat: NodeInfo cleanup #2370

Merged
merged 3 commits into from
Sep 19, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
11 changes: 5 additions & 6 deletions yarn-project/aztec-rpc/src/aztec_rpc_server/aztec_rpc_server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ export class AztecRPCServer implements AztecRPC {
private contractDataOracle: ContractDataOracle;
private simulator: AcirSimulator;
private log: DebugLogger;
private clientInfo: string;
private sandboxVersion: string;

constructor(
private keyStore: KeyStore,
Expand All @@ -82,8 +82,7 @@ export class AztecRPCServer implements AztecRPC {
this.contractDataOracle = new ContractDataOracle(db, node);
this.simulator = getAcirSimulator(db, node, node, node, keyStore, this.contractDataOracle);

const { version, name } = getPackageInfo();
this.clientInfo = `${name.split('/')[name.split('/').length - 1]}@${version}`;
this.sandboxVersion = getPackageInfo().version;
}

/**
Expand Down Expand Up @@ -345,11 +344,11 @@ export class AztecRPCServer implements AztecRPC {
]);

return {
version,
sandboxVersion: this.sandboxVersion,
compatibleNargoVersion: NoirVersion.tag,
chainId,
version,
rollupAddress,
client: this.clientInfo,
compatibleNargoVersion: NoirVersion.tag,
};
}

Expand Down
4 changes: 2 additions & 2 deletions yarn-project/aztec.js/src/contract/contract.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ describe('Contract Class', () => {
const mockTxReceipt = { type: 'TxReceipt' } as any as TxReceipt;
const mockViewResultValue = 1;
const mockNodeInfo: NodeInfo = {
sandboxVersion: 'vx.x.x',
compatibleNargoVersion: 'vx.x.x-aztec.x',
version: 1,
chainId: 2,
rollupAddress: EthAddress.random(),
client: '',
compatibleNargoVersion: 'vx.x.x-aztec.x',
};

const defaultAbi: ContractAbi = {
Expand Down
6 changes: 3 additions & 3 deletions yarn-project/cli/src/client.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ describe('client', () => {
});

it('checks versions match', async () => {
rpc.getNodeInfo.mockResolvedValue({ client: 'rpc@0.1.0-alpha47' } as NodeInfo);
rpc.getNodeInfo.mockResolvedValue({ sandboxVersion: '0.1.0-alpha47' } as NodeInfo);
await checkServerVersion(rpc, '0.1.0-alpha47');
});

it('reports mismatch on older rpc version', async () => {
rpc.getNodeInfo.mockResolvedValue({ client: 'rpc@0.1.0-alpha47' } as NodeInfo);
rpc.getNodeInfo.mockResolvedValue({ sandboxVersion: '0.1.0-alpha47' } as NodeInfo);
await expect(checkServerVersion(rpc, '0.1.0-alpha48')).rejects.toThrowError(
/is older than the expected by this CLI/,
);
});

it('reports mismatch on newer rpc version', async () => {
rpc.getNodeInfo.mockResolvedValue({ client: 'rpc@0.1.0-alpha48' } as NodeInfo);
rpc.getNodeInfo.mockResolvedValue({ sandboxVersion: '0.1.0-alpha48' } as NodeInfo);
await expect(checkServerVersion(rpc, '0.1.0-alpha47')).rejects.toThrowError(
/is newer than the expected by this CLI/,
);
Expand Down
23 changes: 12 additions & 11 deletions yarn-project/cli/src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,25 +51,26 @@ class VersionMismatchError extends Error {}
*/
export async function checkServerVersion(rpc: AztecRPC, expectedVersionRange: string) {
const serverName = 'Aztec Sandbox';
const { client } = await rpc.getNodeInfo();
if (!client) {
const { sandboxVersion } = await rpc.getNodeInfo();
if (!sandboxVersion) {
throw new VersionMismatchError(`Couldn't determine ${serverName} version. You may run into issues.`);
}
const version = client.split('@')[1];
if (!version || !valid(version)) {
throw new VersionMismatchError(`Missing or invalid version identifier for ${serverName} (${version ?? 'empty'}).`);
} else if (!satisfies(version, expectedVersionRange)) {
if (gtr(version, expectedVersionRange)) {
if (!sandboxVersion || !valid(sandboxVersion)) {
throw new VersionMismatchError(
`Missing or invalid version identifier for ${serverName} (${sandboxVersion ?? 'empty'}).`,
);
} else if (!satisfies(sandboxVersion, expectedVersionRange)) {
if (gtr(sandboxVersion, expectedVersionRange)) {
throw new VersionMismatchError(
`${serverName} is running version ${version} which is newer than the expected by this CLI (${expectedVersionRange}). Consider upgrading your CLI to a newer version.`,
`${serverName} is running version ${sandboxVersion} which is newer than the expected by this CLI (${expectedVersionRange}). Consider upgrading your CLI to a newer version.`,
);
} else if (ltr(version, expectedVersionRange)) {
} else if (ltr(sandboxVersion, expectedVersionRange)) {
throw new VersionMismatchError(
`${serverName} is running version ${version} which is older than the expected by this CLI (${expectedVersionRange}). Consider upgrading your ${serverName} to a newer version.`,
`${serverName} is running version ${sandboxVersion} which is older than the expected by this CLI (${expectedVersionRange}). Consider upgrading your ${serverName} to a newer version.`,
);
} else {
throw new VersionMismatchError(
`${serverName} is running version ${version} which does not match the expected by this CLI (${expectedVersionRange}).`,
`${serverName} is running version ${sandboxVersion} which does not match the expected by this CLI (${expectedVersionRange}).`,
);
}
}
Expand Down
20 changes: 10 additions & 10 deletions yarn-project/types/src/interfaces/aztec_rpc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,25 +37,25 @@ export interface DeployedContract {
*/
export type NodeInfo = {
/**
* The version number of the node.
* Version as tracked in the aztec-packages repository.
*/
version: number;
sandboxVersion: string;
/**
* The network's chain id.
* The nargo version compatible with this sandbox version
*/
chainId: number;
compatibleNargoVersion: string;
/**
* The rollup contract address
* L1 chain id.
*/
rollupAddress: EthAddress;
chainId: number;
/**
* Identifier of the client software.
* Protocol version.
*/
client: string;
version: number;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe rename this to protocolVersion?

/**
* The nargo version compatible with this node.
* The rollup contract address
*/
compatibleNargoVersion: string;
rollupAddress: EthAddress;
};

/** Provides up to which block has been synced by different components. */
Expand Down