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: no unlimited retries by default in aztec.js #1723

Merged
merged 2 commits into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ import {
TxReceipt,
} from '@aztec/types';

export { mustSucceedFetch } from '@aztec/foundation/json-rpc/client';
export { mustSucceedFetchUnlessNoRetry } from '@aztec/foundation/json-rpc/client';
export { makeFetch } from '@aztec/foundation/json-rpc/client';

export const createAztecRpcClient = (url: string, fetch = defaultFetch): AztecRPC =>
createJsonRpcClient<AztecRPC>(
Expand Down
4 changes: 2 additions & 2 deletions yarn-project/canary/src/uniswap_trade_on_l1_from_l2.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
createDebugLogger,
getL1ContractAddresses,
getSandboxAccountsWallet,
mustSucceedFetch,
makeFetch,
sleep,
waitForSandbox,
} from '@aztec/aztec.js';
Expand Down Expand Up @@ -53,7 +53,7 @@ const ethRpcUrl = ETHEREUM_HOST;
const hdAccount = mnemonicToAccount(MNEMONIC);
const privateKey = new PrivateKey(Buffer.from(hdAccount.getHdKey().privateKey!));

const aztecRpcClient = createAztecRpcClient(aztecRpcUrl, mustSucceedFetch);
const aztecRpcClient = createAztecRpcClient(aztecRpcUrl, makeFetch([1, 2, 3], false));
let wallet: Wallet;

/**
Expand Down
4 changes: 2 additions & 2 deletions yarn-project/end-to-end/src/aztec_rpc_sandbox.test.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { aztecRpcTestSuite } from '@aztec/aztec-rpc';
import { createAztecRpcClient, mustSucceedFetchUnlessNoRetry, waitForSandbox } from '@aztec/aztec.js';
import { createAztecRpcClient, makeFetch, waitForSandbox } from '@aztec/aztec.js';

const { SANDBOX_URL = 'http://localhost:8080' } = process.env;

const setup = async () => {
const aztecRpc = createAztecRpcClient(SANDBOX_URL, mustSucceedFetchUnlessNoRetry);
const aztecRpc = createAztecRpcClient(SANDBOX_URL, makeFetch([1, 2, 3], true));
await waitForSandbox(aztecRpc);
return aztecRpc;
};
Expand Down
90 changes: 50 additions & 40 deletions yarn-project/end-to-end/src/e2e_aztec_js_browser.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ conditionalDescribe()('e2e_aztec.js_browser', () => {
let page: Page;

beforeAll(async () => {
testClient = AztecJs.createAztecRpcClient(SANDBOX_URL!, AztecJs.mustSucceedFetch);
testClient = AztecJs.createAztecRpcClient(SANDBOX_URL!, AztecJs.makeFetch([1, 2, 3], false));
await AztecJs.waitForSandbox(testClient);

app = new Koa();
Expand Down Expand Up @@ -110,8 +110,8 @@ conditionalDescribe()('e2e_aztec.js_browser', () => {
it('Creates an account', async () => {
const result = await page.evaluate(
async (rpcUrl, privateKeyString) => {
const { PrivateKey, createAztecRpcClient, mustSucceedFetch, getUnsafeSchnorrAccount } = window.AztecJs;
const client = createAztecRpcClient(rpcUrl!, mustSucceedFetch);
const { PrivateKey, createAztecRpcClient, makeFetch, getUnsafeSchnorrAccount } = window.AztecJs;
const client = createAztecRpcClient(rpcUrl!, makeFetch([1, 2, 3], false));
const privateKey = PrivateKey.fromString(privateKeyString);
const account = getUnsafeSchnorrAccount(client, privateKey);
await account.waitDeploy();
Expand All @@ -129,52 +129,22 @@ conditionalDescribe()('e2e_aztec.js_browser', () => {
}, 15_000);

it('Deploys Private Token contract', async () => {
const txHash = await page.evaluate(
async (rpcUrl, privateKeyString, initialBalance, PrivateTokenContractAbi) => {
const { PrivateKey, DeployMethod, createAztecRpcClient, mustSucceedFetch, getUnsafeSchnorrAccount } =
window.AztecJs;
const client = createAztecRpcClient(rpcUrl!, mustSucceedFetch);
let accounts = await client.getAccounts();
if (accounts.length === 0) {
// This test needs an account for deployment. We create one in case there is none available in the RPC server.
const privateKey = PrivateKey.fromString(privateKeyString);
await getUnsafeSchnorrAccount(client, privateKey).waitDeploy();
accounts = await client.getAccounts();
}
const owner = accounts[0];
const tx = new DeployMethod(owner.publicKey, client, PrivateTokenContractAbi, [
initialBalance,
owner.address,
]).send();
await tx.wait();
const receipt = await tx.getReceipt();
console.log(`Contract Deployed: ${receipt.contractAddress}`);
return receipt.txHash.toString();
},
SANDBOX_URL,
privKey.toString(),
initialBalance,
PrivateTokenContractAbi,
);

const txResult = await testClient.getTxReceipt(AztecJs.TxHash.fromString(txHash));
expect(txResult.status).toEqual(AztecJs.TxStatus.MINED);
contractAddress = txResult.contractAddress!;
await deployPrivateTokenContract();
}, 30_000);

it("Gets the owner's balance", async () => {
const result = await page.evaluate(
async (rpcUrl, contractAddress, PrivateTokenContractAbi) => {
const { Contract, AztecAddress, createAztecRpcClient, mustSucceedFetch } = window.AztecJs;
const client = createAztecRpcClient(rpcUrl!, mustSucceedFetch);
const { Contract, AztecAddress, createAztecRpcClient, makeFetch } = window.AztecJs;
const client = createAztecRpcClient(rpcUrl!, makeFetch([1, 2, 3], false));
const owner = (await client.getAccounts())[0].address;
const wallet = await AztecJs.getSandboxAccountsWallet(client);
const contract = await Contract.at(AztecAddress.fromString(contractAddress), PrivateTokenContractAbi, wallet);
const balance = await contract.methods.getBalance(owner).view({ from: owner });
return balance;
},
SANDBOX_URL,
contractAddress.toString(),
(await getPrivateTokenAddress()).toString(),
PrivateTokenContractAbi,
);
logger('Owner balance:', result);
Expand All @@ -185,8 +155,8 @@ conditionalDescribe()('e2e_aztec.js_browser', () => {
const result = await page.evaluate(
async (rpcUrl, contractAddress, transferAmount, PrivateTokenContractAbi) => {
console.log(`Starting transfer tx`);
const { AztecAddress, Contract, createAztecRpcClient, mustSucceedFetch } = window.AztecJs;
const client = createAztecRpcClient(rpcUrl!, mustSucceedFetch);
const { AztecAddress, Contract, createAztecRpcClient, makeFetch } = window.AztecJs;
const client = createAztecRpcClient(rpcUrl!, makeFetch([1, 2, 3], false));
const accounts = await client.getAccounts();
const owner = accounts[0].address;
const receiver = accounts[1].address;
Expand All @@ -197,10 +167,50 @@ conditionalDescribe()('e2e_aztec.js_browser', () => {
return await contract.methods.getBalance(receiver).view({ from: receiver });
},
SANDBOX_URL,
contractAddress.toString(),
(await getPrivateTokenAddress()).toString(),
transferAmount,
PrivateTokenContractAbi,
);
expect(result).toEqual(transferAmount);
}, 60_000);

const deployPrivateTokenContract = async () => {
const txHash = await page.evaluate(
async (rpcUrl, privateKeyString, initialBalance, PrivateTokenContractAbi) => {
const { PrivateKey, DeployMethod, createAztecRpcClient, makeFetch, getUnsafeSchnorrAccount } = window.AztecJs;
const client = createAztecRpcClient(rpcUrl!, makeFetch([1, 2, 3], false));
let accounts = await client.getAccounts();
if (accounts.length === 0) {
// This test needs an account for deployment. We create one in case there is none available in the RPC server.
const privateKey = PrivateKey.fromString(privateKeyString);
await getUnsafeSchnorrAccount(client, privateKey).waitDeploy();
accounts = await client.getAccounts();
}
const owner = accounts[0];
const tx = new DeployMethod(owner.publicKey, client, PrivateTokenContractAbi, [
initialBalance,
owner.address,
]).send();
await tx.wait();
const receipt = await tx.getReceipt();
console.log(`Contract Deployed: ${receipt.contractAddress}`);
return receipt.txHash.toString();
},
SANDBOX_URL,
privKey.toString(),
initialBalance,
PrivateTokenContractAbi,
);

const txResult = await testClient.getTxReceipt(AztecJs.TxHash.fromString(txHash));
expect(txResult.status).toEqual(AztecJs.TxStatus.MINED);
contractAddress = txResult.contractAddress!;
};

const getPrivateTokenAddress = async () => {
if (!contractAddress) {
await deployPrivateTokenContract();
}
return contractAddress;
};
});
4 changes: 2 additions & 2 deletions yarn-project/end-to-end/src/fixtures/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ import {
getL1ContractAddresses,
getSandboxAccountsWallet,
getUnsafeSchnorrAccount,
makeFetch,
} from '@aztec/aztec.js';
import { CompleteAddress, PrivateKey, PublicKey } from '@aztec/circuits.js';
import { DeployL1Contracts, deployL1Contract, deployL1Contracts } from '@aztec/ethereum';
import { ContractAbi } from '@aztec/foundation/abi';
import { Fr } from '@aztec/foundation/fields';
import { mustSucceedFetch } from '@aztec/foundation/json-rpc/client';
import { DebugLogger, createDebugLogger } from '@aztec/foundation/log';
import { retryUntil } from '@aztec/foundation/retry';
import { PortalERC20Abi, PortalERC20Bytecode, TokenPortalAbi, TokenPortalBytecode } from '@aztec/l1-artifacts';
Expand Down Expand Up @@ -80,7 +80,7 @@ const createRpcServer = async (
): Promise<AztecRPC> => {
if (SANDBOX_URL) {
logger(`Creating JSON RPC client to remote host ${SANDBOX_URL}`);
const jsonClient = createJsonRpcClient(SANDBOX_URL, mustSucceedFetch);
const jsonClient = createJsonRpcClient(SANDBOX_URL, makeFetch([1, 2, 3], false));
await waitForRPCServer(jsonClient, logger);
logger('JSON RPC client connected to RPC Server');
return jsonClient;
Expand Down
8 changes: 1 addition & 7 deletions yarn-project/foundation/src/json-rpc/client/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1 @@
export {
createJsonRpcClient,
mustSucceedFetch,
mustSucceedFetchUnlessNoRetry,
defaultFetch,
makeFetch,
} from './json_rpc_client.js';
export { createJsonRpcClient, defaultFetch, makeFetch } from './json_rpc_client.js';
20 changes: 0 additions & 20 deletions yarn-project/foundation/src/json-rpc/client/json_rpc_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,6 @@ export async function defaultFetch(
return responseJson;
}

/**
* A fetch function with retries.
*/
export async function mustSucceedFetch(host: string, rpcMethod: string, body: any, useApiEndpoints: boolean) {
return await retry(() => defaultFetch(host, rpcMethod, body, useApiEndpoints), 'JsonRpcClient request');
}

/**
* Makes a fetch function that retries based on the given attempts.
* @param retries - Sequence of intervals (in seconds) to retry.
Expand All @@ -90,19 +83,6 @@ export function makeFetch(retries: number[], noRetry: boolean, log?: DebugLogger
};
}

/**
* A fetch function with retries unless the error is a NoRetryError.
*/
export async function mustSucceedFetchUnlessNoRetry(
host: string,
rpcMethod: string,
body: any,
useApiEndpoints: boolean,
) {
const noRetry = true;
return await retry(() => defaultFetch(host, rpcMethod, body, useApiEndpoints, noRetry), 'JsonRpcClient request');
}

/**
* Creates a Proxy object that delegates over RPC and satisfies RemoteObject<T>.
* The server should have ran new JsonRpcServer().
Expand Down