From dee70200681af683e84a5e9c6f95d191b0165f36 Mon Sep 17 00:00:00 2001 From: Rafal Czajkowski Date: Tue, 20 Jun 2023 15:01:05 +0200 Subject: [PATCH] Improve docs in the Ethereum Bridge implementation --- typescript/src/ethereum.ts | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/typescript/src/ethereum.ts b/typescript/src/ethereum.ts index d64c98a4c..f3d229585 100644 --- a/typescript/src/ethereum.ts +++ b/typescript/src/ethereum.ts @@ -698,6 +698,10 @@ export class Bridge }) } + // eslint-disable-next-line valid-jsdoc + /** + * @see {ChainBridge#wallets} + */ async wallets(walletPublicKeyHash: string): Promise { const wallet = await backoffRetrier( this._totalRetryAttempts @@ -708,6 +712,11 @@ export class Bridge return this.parseWalletDetails(wallet) } + /** + * Parses a wallet data using data fetched from the on-chain contract. + * @param wallet Data of the wallet. + * @returns Parsed wallet data. + */ private async parseWalletDetails( wallet: Wallets.WalletStructOutput ): Promise { @@ -730,11 +739,12 @@ export class Bridge } } + // eslint-disable-next-line valid-jsdoc /** * Builds the UTXO hash based on the UTXO components. UTXO hash is computed as * `keccak256(txHash | txOutputIndex | txOutputValue)`. - * @param utxo UTXO components. - * @returns The hash of the UTXO. + * + * @see {ChainBridge#buildUTXOHash} */ buildUTXOHash(utxo: UnspentTransactionOutput): Hex { return Hex.from(