From 25a4bc490a53304110e7e1f79e99f4c8b7639164 Mon Sep 17 00:00:00 2001 From: Maddiaa <47148561+Maddiaa0@users.noreply.github.com> Date: Mon, 29 Jan 2024 21:30:20 +0000 Subject: [PATCH] chore: remove stubbed docs (#4196) --- .../src/avm/avm_execution_environment.ts | 25 +++++++------- .../src/avm/avm_machine_state.ts | 5 +-- .../src/avm/avm_message_call_result.ts | 3 +- .../acir-simulator/src/avm/fixtures/index.ts | 25 +++++++------- .../src/avm/journal/host_storage.ts | 5 ++- .../acir-simulator/src/avm/journal/journal.ts | 5 ++- .../src/avm/opcodes/accrued_substate.ts | 0 .../src/avm/opcodes/arithmetic.ts | 1 - .../src/avm/opcodes/instruction_set.ts | 4 +-- .../acir-simulator/src/avm/opcodes/storage.ts | 2 -- yarn-project/circuits.js/src/abis/abis.ts | 34 +------------------ yarn-project/cli/src/cmds/add_contract.ts | 3 -- yarn-project/cli/src/cmds/add_note.ts | 3 -- yarn-project/cli/src/cmds/block_number.ts | 3 -- yarn-project/cli/src/cmds/call.ts | 3 -- yarn-project/cli/src/cmds/check_deploy.ts | 3 -- yarn-project/cli/src/cmds/compute_selector.ts | 3 -- yarn-project/cli/src/cmds/create_account.ts | 3 -- yarn-project/cli/src/cmds/deploy.ts | 3 -- .../cli/src/cmds/deploy_l1_contracts.ts | 3 -- .../cli/src/cmds/example_contracts.ts | 3 -- .../cli/src/cmds/generate_p2p_private_key.ts | 3 -- .../cli/src/cmds/generate_private_key.ts | 3 -- yarn-project/cli/src/cmds/get_account.ts | 3 -- yarn-project/cli/src/cmds/get_accounts.ts | 3 -- .../cli/src/cmds/get_contract_data.ts | 3 -- yarn-project/cli/src/cmds/get_logs.ts | 3 -- yarn-project/cli/src/cmds/get_node_info.ts | 3 -- yarn-project/cli/src/cmds/get_recipient.ts | 3 -- yarn-project/cli/src/cmds/get_recipients.ts | 3 -- yarn-project/cli/src/cmds/get_tx_receipt.ts | 3 -- yarn-project/cli/src/cmds/inspect_contract.ts | 3 -- .../cli/src/cmds/parse_parameter_struct.ts | 3 -- yarn-project/cli/src/cmds/register_account.ts | 3 -- .../cli/src/cmds/register_recipient.ts | 3 -- yarn-project/cli/src/cmds/send.ts | 3 -- yarn-project/cli/src/cmds/unbox.ts | 3 -- .../add_noir_compiler_commander_actions.ts | 6 ---- .../src/type_conversion.ts | 3 -- 39 files changed, 32 insertions(+), 164 deletions(-) create mode 100644 yarn-project/acir-simulator/src/avm/opcodes/accrued_substate.ts diff --git a/yarn-project/acir-simulator/src/avm/avm_execution_environment.ts b/yarn-project/acir-simulator/src/avm/avm_execution_environment.ts index 6c921bd08e9..6a87f62d87b 100644 --- a/yarn-project/acir-simulator/src/avm/avm_execution_environment.ts +++ b/yarn-project/acir-simulator/src/avm/avm_execution_environment.ts @@ -10,31 +10,30 @@ import { Fr } from '@aztec/foundation/fields'; // TODO(https://github.com/AztecProtocol/aztec-packages/issues/3992): gas not implemented export class AvmExecutionEnvironment { constructor( - /** - */ public readonly address: AztecAddress, - /** - */ + public readonly storageAddress: AztecAddress, - /** - */ + public readonly origin: AztecAddress, - /** - */ + public readonly sender: AztecAddress, - /** - */ + public readonly portal: EthAddress, - /** - */ + public readonly feePerL1Gas: Fr, - /** - */ + public readonly feePerL2Gas: Fr, - /** - */ + public readonly feePerDaGas: Fr, - /** - */ + public readonly contractCallDepth: Fr, - /** - */ + public readonly globals: GlobalVariables, - /** - */ + public readonly isStaticCall: boolean, - /** - */ + public readonly isDelegateCall: boolean, - /** - */ + public readonly calldata: Fr[], ) {} diff --git a/yarn-project/acir-simulator/src/avm/avm_machine_state.ts b/yarn-project/acir-simulator/src/avm/avm_machine_state.ts index dc1ce28aa23..4d9fa6bb7fe 100644 --- a/yarn-project/acir-simulator/src/avm/avm_machine_state.ts +++ b/yarn-project/acir-simulator/src/avm/avm_machine_state.ts @@ -15,7 +15,6 @@ export class AvmMachineState { private returnData: Fr[]; - /** - */ public readonly memory: TaggedMemory; /** @@ -24,9 +23,8 @@ export class AvmMachineState { */ public internalCallStack: number[]; - /** - */ public pc: number; - /** - */ + public callStack: number[]; /** @@ -60,7 +58,6 @@ export class AvmMachineState { Object.freeze(returnData); } - /** - */ public getReturnData(): Fr[] { return this.returnData; } diff --git a/yarn-project/acir-simulator/src/avm/avm_message_call_result.ts b/yarn-project/acir-simulator/src/avm/avm_message_call_result.ts index e2290e4fa6d..713a306b3e9 100644 --- a/yarn-project/acir-simulator/src/avm/avm_message_call_result.ts +++ b/yarn-project/acir-simulator/src/avm/avm_message_call_result.ts @@ -4,9 +4,8 @@ import { Fr } from '@aztec/foundation/fields'; * AVM message call result. */ export class AvmMessageCallResult { - /** - */ public readonly reverted: boolean; - /** - */ + public readonly revertReason: Error | undefined; /** .- */ public readonly output: Fr[]; diff --git a/yarn-project/acir-simulator/src/avm/fixtures/index.ts b/yarn-project/acir-simulator/src/avm/fixtures/index.ts index fb16ebf4ee3..e97dc3fa2ce 100644 --- a/yarn-project/acir-simulator/src/avm/fixtures/index.ts +++ b/yarn-project/acir-simulator/src/avm/fixtures/index.ts @@ -10,31 +10,30 @@ import { AvmExecutionEnvironment } from '../avm_execution_environment.js'; * An interface that allows to override the default values of the AvmExecutionEnvironment */ export interface AvmExecutionEnvironmentOverrides { - /** - */ address?: AztecAddress; - /** - */ + storageAddress?: AztecAddress; - /** - */ + origin?: AztecAddress; - /** - */ + sender?: AztecAddress; - /** - */ + portal?: EthAddress; - /** - */ + feePerL1Gas?: Fr; - /** - */ + feePerL2Gas?: Fr; - /** - */ + feePerDaGas?: Fr; - /** - */ + contractCallDepth?: Fr; - /** - */ + globals?: GlobalVariables; - /** - */ + isStaticCall?: boolean; - /** - */ + isDelegateCall?: boolean; - /** - */ + calldata?: Fr[]; } diff --git a/yarn-project/acir-simulator/src/avm/journal/host_storage.ts b/yarn-project/acir-simulator/src/avm/journal/host_storage.ts index fcd9d27f722..b12e14f9c20 100644 --- a/yarn-project/acir-simulator/src/avm/journal/host_storage.ts +++ b/yarn-project/acir-simulator/src/avm/journal/host_storage.ts @@ -6,11 +6,10 @@ import { CommitmentsDB, PublicContractsDB, PublicStateDB } from '../../index.js' * A wrapper around the node dbs */ export class HostStorage { - /** - */ public readonly publicStateDb: PublicStateDB; - /** - */ + public readonly contractsDb: PublicContractsDB; - /** - */ + public readonly commitmentsDb: CommitmentsDB; constructor(publicStateDb: PublicStateDB, contractsDb: PublicContractsDB, commitmentsDb: CommitmentsDB) { diff --git a/yarn-project/acir-simulator/src/avm/journal/journal.ts b/yarn-project/acir-simulator/src/avm/journal/journal.ts index 62670b8f2f7..4d5b92fec6b 100644 --- a/yarn-project/acir-simulator/src/avm/journal/journal.ts +++ b/yarn-project/acir-simulator/src/avm/journal/journal.ts @@ -7,11 +7,10 @@ import { HostStorage } from './host_storage.js'; * Data held within the journal */ export type JournalData = { - /** - */ newCommitments: Fr[]; - /** - */ + newL1Messages: Fr[]; - /** - */ + newNullifiers: Fr[]; /** contract address -\> key -\> value */ storageWrites: Map>; diff --git a/yarn-project/acir-simulator/src/avm/opcodes/accrued_substate.ts b/yarn-project/acir-simulator/src/avm/opcodes/accrued_substate.ts new file mode 100644 index 00000000000..e69de29bb2d diff --git a/yarn-project/acir-simulator/src/avm/opcodes/arithmetic.ts b/yarn-project/acir-simulator/src/avm/opcodes/arithmetic.ts index 5366c8428d6..0b1910f0dd7 100644 --- a/yarn-project/acir-simulator/src/avm/opcodes/arithmetic.ts +++ b/yarn-project/acir-simulator/src/avm/opcodes/arithmetic.ts @@ -59,7 +59,6 @@ export class Mul extends Instruction { } } -/** -*/ export class Div extends Instruction { static type: string = 'DIV'; static numberOfOperands = 3; diff --git a/yarn-project/acir-simulator/src/avm/opcodes/instruction_set.ts b/yarn-project/acir-simulator/src/avm/opcodes/instruction_set.ts index 9ea66060ae3..e63fe02dc20 100644 --- a/yarn-project/acir-simulator/src/avm/opcodes/instruction_set.ts +++ b/yarn-project/acir-simulator/src/avm/opcodes/instruction_set.ts @@ -8,11 +8,9 @@ import { Opcode } from './opcodes.js'; //import { Eq, Lt, Lte } from './comparators.js'; import { SLoad, SStore } from './storage.js'; -/** - */ type InstructionConstructor = new (...args: any[]) => Instruction; -/** - */ + type InstructionConstructorAndMembers = InstructionConstructor & { - /** - */ numberOfOperands: number; }; diff --git a/yarn-project/acir-simulator/src/avm/opcodes/storage.ts b/yarn-project/acir-simulator/src/avm/opcodes/storage.ts index 7364945d992..c226522b3db 100644 --- a/yarn-project/acir-simulator/src/avm/opcodes/storage.ts +++ b/yarn-project/acir-simulator/src/avm/opcodes/storage.ts @@ -6,7 +6,6 @@ import { AvmInterpreterError } from '../interpreter/interpreter.js'; import { AvmJournal } from '../journal/journal.js'; import { Instruction } from './instruction.js'; -/** - */ export class SStore extends Instruction { static type: string = 'SSTORE'; static numberOfOperands = 2; @@ -33,7 +32,6 @@ export class SStore extends Instruction { } } -/** - */ export class SLoad extends Instruction { static type: string = 'SLOAD'; static numberOfOperands = 2; diff --git a/yarn-project/circuits.js/src/abis/abis.ts b/yarn-project/circuits.js/src/abis/abis.ts index d5828a428ea..94043432bef 100644 --- a/yarn-project/circuits.js/src/abis/abis.ts +++ b/yarn-project/circuits.js/src/abis/abis.ts @@ -190,9 +190,6 @@ export function computeCompleteAddress( ); } -/** - * - */ function computePartialAddress(contractAddrSalt: Fr, fnTreeRoot: Fr, constructorHash: Fr) { return Fr.fromBuffer( pedersenHash( @@ -450,9 +447,6 @@ export function computeTxHash(txRequest: TxRequest): Fr { ); } -/** - * - */ function computeFunctionDataHash(functionData: FunctionData): Fr { return Fr.fromBuffer( pedersenHash( @@ -467,9 +461,6 @@ function computeFunctionDataHash(functionData: FunctionData): Fr { ); } -/** - * - */ function computeTxContextHash(txContext: TxContext): Fr { return Fr.fromBuffer( pedersenHash( @@ -486,9 +477,6 @@ function computeTxContextHash(txContext: TxContext): Fr { ); } -/** - * - */ function computeContractDeploymentDataHash(data: ContractDeploymentData): Fr { return Fr.fromBuffer( pedersenHash( @@ -505,9 +493,6 @@ function computeContractDeploymentDataHash(data: ContractDeploymentData): Fr { ); } -/** - * - */ function computeCallContextHash(input: CallContext) { return pedersenHash( [ @@ -524,9 +509,6 @@ function computeCallContextHash(input: CallContext) { ); } -/** - * - */ function computePrivateInputsHash(input: PrivateCircuitPublicInputs) { const toHash = [ computeCallContextHash(input.callContext), @@ -589,9 +571,6 @@ export function computePrivateCallStackItemHash(callStackItem: PrivateCallStackI ); } -/** - * - */ function computeContractStorageUpdateRequestHash(input: ContractStorageUpdateRequest) { return pedersenHash( [input.storageSlot.toBuffer(), input.oldValue.toBuffer(), input.newValue.toBuffer()], @@ -599,22 +578,14 @@ function computeContractStorageUpdateRequestHash(input: ContractStorageUpdateReq ); } -/** - * - */ function computeContractStorageReadsHash(input: ContractStorageRead) { return pedersenHash([input.storageSlot.toBuffer(), input.currentValue.toBuffer()], GeneratorIndex.PUBLIC_DATA_READ); } -/** - * - */ + export function computeCommitmentsHash(input: SideEffect) { return pedersenHash([input.value.toBuffer(), input.counter.toBuffer()], GeneratorIndex.SIDE_EFFECT); } -/** - * - */ export function computeNullifierHash(input: SideEffectLinkedToNoteHash) { return pedersenHash( [input.value.toBuffer(), input.noteHash.toBuffer(), input.counter.toBuffer()], @@ -622,9 +593,6 @@ export function computeNullifierHash(input: SideEffectLinkedToNoteHash) { ); } -/** - * - */ export function computePublicInputsHash(input: PublicCircuitPublicInputs) { const toHash = [ computeCallContextHash(input.callContext), diff --git a/yarn-project/cli/src/cmds/add_contract.ts b/yarn-project/cli/src/cmds/add_contract.ts index 6ac361f1fbc..0124a6c83fb 100644 --- a/yarn-project/cli/src/cmds/add_contract.ts +++ b/yarn-project/cli/src/cmds/add_contract.ts @@ -4,9 +4,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; import { getContractArtifact } from '../utils.js'; -/** - * - */ export async function addContract( rpcUrl: string, contractArtifactPath: string, diff --git a/yarn-project/cli/src/cmds/add_note.ts b/yarn-project/cli/src/cmds/add_note.ts index e547f76d3c9..c70176159d7 100644 --- a/yarn-project/cli/src/cmds/add_note.ts +++ b/yarn-project/cli/src/cmds/add_note.ts @@ -5,9 +5,6 @@ import { DebugLogger } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; import { parseFields } from '../parse_args.js'; -/** - * - */ export async function addNote( address: AztecAddress, contractAddress: AztecAddress, diff --git a/yarn-project/cli/src/cmds/block_number.ts b/yarn-project/cli/src/cmds/block_number.ts index 37795a12966..c5aed126443 100644 --- a/yarn-project/cli/src/cmds/block_number.ts +++ b/yarn-project/cli/src/cmds/block_number.ts @@ -2,9 +2,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function blockNumber(rpcUrl: string, debugLogger: DebugLogger, log: LogFn) { const client = await createCompatibleClient(rpcUrl, debugLogger); const num = await client.getBlockNumber(); diff --git a/yarn-project/cli/src/cmds/call.ts b/yarn-project/cli/src/cmds/call.ts index 7e395276177..cab98e2dd42 100644 --- a/yarn-project/cli/src/cmds/call.ts +++ b/yarn-project/cli/src/cmds/call.ts @@ -6,9 +6,6 @@ import { format } from 'util'; import { createCompatibleClient } from '../client.js'; import { getFunctionArtifact, getTxSender, prepTx } from '../utils.js'; -/** - * - */ export async function call( functionName: string, functionArgsIn: any[], diff --git a/yarn-project/cli/src/cmds/check_deploy.ts b/yarn-project/cli/src/cmds/check_deploy.ts index 25641418c71..90408309ff4 100644 --- a/yarn-project/cli/src/cmds/check_deploy.ts +++ b/yarn-project/cli/src/cmds/check_deploy.ts @@ -3,9 +3,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function checkDeploy(rpcUrl: string, contractAddress: AztecAddress, debugLogger: DebugLogger, log: LogFn) { const client = await createCompatibleClient(rpcUrl, debugLogger); const isDeployed = await isContractDeployed(client, contractAddress); diff --git a/yarn-project/cli/src/cmds/compute_selector.ts b/yarn-project/cli/src/cmds/compute_selector.ts index d0ef8e14abe..074be33597a 100644 --- a/yarn-project/cli/src/cmds/compute_selector.ts +++ b/yarn-project/cli/src/cmds/compute_selector.ts @@ -1,9 +1,6 @@ import { FunctionSelector } from '@aztec/foundation/abi'; import { LogFn } from '@aztec/foundation/log'; -/** - * - */ export function computeSelector(functionSignature: string, log: LogFn) { const selector = FunctionSelector.fromSignature(functionSignature); log(`${selector}`); diff --git a/yarn-project/cli/src/cmds/create_account.ts b/yarn-project/cli/src/cmds/create_account.ts index a8f895a84ce..2ad6a5d92d6 100644 --- a/yarn-project/cli/src/cmds/create_account.ts +++ b/yarn-project/cli/src/cmds/create_account.ts @@ -5,9 +5,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function createAccount( rpcUrl: string, privateKey: Fq, diff --git a/yarn-project/cli/src/cmds/deploy.ts b/yarn-project/cli/src/cmds/deploy.ts index a8c7e7ffd96..986417edac8 100644 --- a/yarn-project/cli/src/cmds/deploy.ts +++ b/yarn-project/cli/src/cmds/deploy.ts @@ -6,9 +6,6 @@ import { encodeArgs } from '../encoding.js'; import { GITHUB_TAG_PREFIX } from '../github.js'; import { getContractArtifact, getFunctionArtifact } from '../utils.js'; -/** - * - */ export async function deploy( artifactPath: string, json: boolean, diff --git a/yarn-project/cli/src/cmds/deploy_l1_contracts.ts b/yarn-project/cli/src/cmds/deploy_l1_contracts.ts index 3b45537d88a..7ecd5abe455 100644 --- a/yarn-project/cli/src/cmds/deploy_l1_contracts.ts +++ b/yarn-project/cli/src/cmds/deploy_l1_contracts.ts @@ -2,9 +2,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { deployAztecContracts } from '../utils.js'; -/** - * - */ export async function deployL1Contracts( rpcUrl: string, apiKey: string, diff --git a/yarn-project/cli/src/cmds/example_contracts.ts b/yarn-project/cli/src/cmds/example_contracts.ts index a5b71e2ec0d..5b40c5c60c3 100644 --- a/yarn-project/cli/src/cmds/example_contracts.ts +++ b/yarn-project/cli/src/cmds/example_contracts.ts @@ -2,9 +2,6 @@ import { LogFn } from '@aztec/foundation/log'; import { getExampleContractArtifacts } from '../utils.js'; -/** - * - */ export async function exampleContracts(log: LogFn) { const abisList = await getExampleContractArtifacts(); const names = Object.keys(abisList); diff --git a/yarn-project/cli/src/cmds/generate_p2p_private_key.ts b/yarn-project/cli/src/cmds/generate_p2p_private_key.ts index 4bf3ad7a5c4..928e61974ba 100644 --- a/yarn-project/cli/src/cmds/generate_p2p_private_key.ts +++ b/yarn-project/cli/src/cmds/generate_p2p_private_key.ts @@ -2,9 +2,6 @@ import { LogFn } from '@aztec/foundation/log'; import { createSecp256k1PeerId } from '@libp2p/peer-id-factory'; -/** - * - */ export async function generateP2PPrivateKey(log: LogFn) { const peerId = await createSecp256k1PeerId(); const exportedPeerId = Buffer.from(peerId.privateKey!).toString('hex'); diff --git a/yarn-project/cli/src/cmds/generate_private_key.ts b/yarn-project/cli/src/cmds/generate_private_key.ts index 8586f03f37a..b447cdcc738 100644 --- a/yarn-project/cli/src/cmds/generate_private_key.ts +++ b/yarn-project/cli/src/cmds/generate_private_key.ts @@ -3,9 +3,6 @@ import { LogFn } from '@aztec/foundation/log'; import { mnemonicToAccount } from 'viem/accounts'; -/** - * - */ export function generatePrivateKey(mnemonic: string | undefined, log: LogFn) { let privKey; let publicKey; diff --git a/yarn-project/cli/src/cmds/get_account.ts b/yarn-project/cli/src/cmds/get_account.ts index 47b3b1056a7..8b3e9359d5f 100644 --- a/yarn-project/cli/src/cmds/get_account.ts +++ b/yarn-project/cli/src/cmds/get_account.ts @@ -3,9 +3,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function getAccount(aztecAddress: AztecAddress, rpcUrl: string, debugLogger: DebugLogger, log: LogFn) { const client = await createCompatibleClient(rpcUrl, debugLogger); const account = await client.getRegisteredAccount(aztecAddress); diff --git a/yarn-project/cli/src/cmds/get_accounts.ts b/yarn-project/cli/src/cmds/get_accounts.ts index 79f9dbee325..1e36475f3a8 100644 --- a/yarn-project/cli/src/cmds/get_accounts.ts +++ b/yarn-project/cli/src/cmds/get_accounts.ts @@ -2,9 +2,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function getAccounts( rpcUrl: string, json: boolean, diff --git a/yarn-project/cli/src/cmds/get_contract_data.ts b/yarn-project/cli/src/cmds/get_contract_data.ts index 432d4fa249e..80f1e7afb2a 100644 --- a/yarn-project/cli/src/cmds/get_contract_data.ts +++ b/yarn-project/cli/src/cmds/get_contract_data.ts @@ -4,9 +4,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function getContractData( rpcUrl: string, contractAddress: AztecAddress, diff --git a/yarn-project/cli/src/cmds/get_logs.ts b/yarn-project/cli/src/cmds/get_logs.ts index 1a48dd920cc..76c27c76726 100644 --- a/yarn-project/cli/src/cmds/get_logs.ts +++ b/yarn-project/cli/src/cmds/get_logs.ts @@ -5,9 +5,6 @@ import { sleep } from '@aztec/foundation/sleep'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function getLogs( txHash: TxHash, fromBlock: number, diff --git a/yarn-project/cli/src/cmds/get_node_info.ts b/yarn-project/cli/src/cmds/get_node_info.ts index 2f14d5f5a24..b775c08aa0d 100644 --- a/yarn-project/cli/src/cmds/get_node_info.ts +++ b/yarn-project/cli/src/cmds/get_node_info.ts @@ -2,9 +2,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function getNodeInfo(rpcUrl: string, debugLogger: DebugLogger, log: LogFn) { const client = await createCompatibleClient(rpcUrl, debugLogger); const info = await client.getNodeInfo(); diff --git a/yarn-project/cli/src/cmds/get_recipient.ts b/yarn-project/cli/src/cmds/get_recipient.ts index 9edf6edecfc..270bbad9ac2 100644 --- a/yarn-project/cli/src/cmds/get_recipient.ts +++ b/yarn-project/cli/src/cmds/get_recipient.ts @@ -3,9 +3,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function getRecipient(aztecAddress: AztecAddress, rpcUrl: string, debugLogger: DebugLogger, log: LogFn) { const client = await createCompatibleClient(rpcUrl, debugLogger); const recipient = await client.getRecipient(aztecAddress); diff --git a/yarn-project/cli/src/cmds/get_recipients.ts b/yarn-project/cli/src/cmds/get_recipients.ts index 92bc9fad973..875b84b6038 100644 --- a/yarn-project/cli/src/cmds/get_recipients.ts +++ b/yarn-project/cli/src/cmds/get_recipients.ts @@ -2,9 +2,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function getRecipients(rpcUrl: string, debugLogger: DebugLogger, log: LogFn) { const client = await createCompatibleClient(rpcUrl, debugLogger); const recipients = await client.getRecipients(); diff --git a/yarn-project/cli/src/cmds/get_tx_receipt.ts b/yarn-project/cli/src/cmds/get_tx_receipt.ts index fe133608820..beaa53e2f9b 100644 --- a/yarn-project/cli/src/cmds/get_tx_receipt.ts +++ b/yarn-project/cli/src/cmds/get_tx_receipt.ts @@ -4,9 +4,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function getTxReceipt(rpcUrl: string, txHash: TxHash, debugLogger: DebugLogger, log: LogFn) { const client = await createCompatibleClient(rpcUrl, debugLogger); const receipt = await client.getTxReceipt(txHash); diff --git a/yarn-project/cli/src/cmds/inspect_contract.ts b/yarn-project/cli/src/cmds/inspect_contract.ts index e55954adc1e..ad8aafa871d 100644 --- a/yarn-project/cli/src/cmds/inspect_contract.ts +++ b/yarn-project/cli/src/cmds/inspect_contract.ts @@ -7,9 +7,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { getContractArtifact } from '../utils.js'; -/** - * - */ export async function inspectContract(contractArtifactFile: string, debugLogger: DebugLogger, log: LogFn) { const contractArtifact = await getContractArtifact(contractArtifactFile, debugLogger); const contractFns = contractArtifact.functions.filter( diff --git a/yarn-project/cli/src/cmds/parse_parameter_struct.ts b/yarn-project/cli/src/cmds/parse_parameter_struct.ts index 1ef572fd5ce..d8b29211d3a 100644 --- a/yarn-project/cli/src/cmds/parse_parameter_struct.ts +++ b/yarn-project/cli/src/cmds/parse_parameter_struct.ts @@ -5,9 +5,6 @@ import { LogFn } from '@aztec/foundation/log'; import { parseStructString } from '../encoding.js'; import { getContractArtifact } from '../utils.js'; -/** - * - */ export async function parseParameterStruct( encodedString: string, contractArtifactPath: string, diff --git a/yarn-project/cli/src/cmds/register_account.ts b/yarn-project/cli/src/cmds/register_account.ts index fae880f81a1..b6949cee4fa 100644 --- a/yarn-project/cli/src/cmds/register_account.ts +++ b/yarn-project/cli/src/cmds/register_account.ts @@ -3,9 +3,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function registerAccount( rpcUrl: string, privateKey: Fq, diff --git a/yarn-project/cli/src/cmds/register_recipient.ts b/yarn-project/cli/src/cmds/register_recipient.ts index df8b7a0c11a..6458143c542 100644 --- a/yarn-project/cli/src/cmds/register_recipient.ts +++ b/yarn-project/cli/src/cmds/register_recipient.ts @@ -4,9 +4,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; -/** - * - */ export async function registerRecipient( aztecAddress: AztecAddress, publicKey: Point, diff --git a/yarn-project/cli/src/cmds/send.ts b/yarn-project/cli/src/cmds/send.ts index 50dab7479e9..8513fe1392e 100644 --- a/yarn-project/cli/src/cmds/send.ts +++ b/yarn-project/cli/src/cmds/send.ts @@ -5,9 +5,6 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log'; import { createCompatibleClient } from '../client.js'; import { prepTx } from '../utils.js'; -/** - * - */ export async function send( functionName: string, functionArgsIn: any[], diff --git a/yarn-project/cli/src/cmds/unbox.ts b/yarn-project/cli/src/cmds/unbox.ts index 38150ba16e4..b1b6542b5e0 100644 --- a/yarn-project/cli/src/cmds/unbox.ts +++ b/yarn-project/cli/src/cmds/unbox.ts @@ -80,9 +80,6 @@ function copyDependenciesToBox(dirName: string, destPath: string) { ); } -/** - * - */ function packageJsonInjectLocalResolutions(path: string) { const data = readFileSync(path, 'utf-8'); const packageJson = JSON.parse(data); diff --git a/yarn-project/noir-compiler/src/cli/add_noir_compiler_commander_actions.ts b/yarn-project/noir-compiler/src/cli/add_noir_compiler_commander_actions.ts index ab40a9b78e8..ee3513d6b67 100644 --- a/yarn-project/noir-compiler/src/cli/add_noir_compiler_commander_actions.ts +++ b/yarn-project/noir-compiler/src/cli/add_noir_compiler_commander_actions.ts @@ -3,16 +3,10 @@ import { LogFn } from '@aztec/foundation/log'; import { Command } from 'commander'; import { dirname } from 'path'; -/** - * - */ export function addNoirCompilerCommanderActions(program: Command, log: LogFn = () => {}) { addCodegenCommanderAction(program, log); } -/** - * - */ export function addCodegenCommanderAction(program: Command, _: LogFn = () => {}) { program .command('codegen') diff --git a/yarn-project/noir-protocol-circuits/src/type_conversion.ts b/yarn-project/noir-protocol-circuits/src/type_conversion.ts index 2102133b2e8..0ddb88ad5af 100644 --- a/yarn-project/noir-protocol-circuits/src/type_conversion.ts +++ b/yarn-project/noir-protocol-circuits/src/type_conversion.ts @@ -185,9 +185,6 @@ export function mapNumberFromNoir(number: NoirField): number { return Number(Fr.fromString(number).toBigInt()); } -/** - * - */ export function mapNumberToNoir(number: number): NoirField { return new Fr(BigInt(number)).toString(); }