From 9e5ac4e9bf4802847b49e19406cd1e4b82bf344e Mon Sep 17 00:00:00 2001 From: JSanchezFDZ Date: Thu, 5 Sep 2024 13:14:12 +0200 Subject: [PATCH] Rename getDepositStatus to getDepositState The new function getDepositStatus is changed to getDepositState to match the smart contract nomenclature. The documentation is also updated. --- .../classes/EthereumL1BitcoinDepositor.md | 8 ++++---- .../api-reference/interfaces/L1BitcoinDepositor.md | 12 ++++++------ typescript/src/lib/contracts/cross-chain.ts | 8 ++++---- typescript/src/lib/ethereum/l1-bitcoin-depositor.ts | 4 ++-- typescript/test/utils/mock-cross-chain.ts | 2 +- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/typescript/api-reference/classes/EthereumL1BitcoinDepositor.md b/typescript/api-reference/classes/EthereumL1BitcoinDepositor.md index a68d2ca77..6761bb637 100644 --- a/typescript/api-reference/classes/EthereumL1BitcoinDepositor.md +++ b/typescript/api-reference/classes/EthereumL1BitcoinDepositor.md @@ -35,7 +35,7 @@ for reference. - [extraDataEncoder](EthereumL1BitcoinDepositor.md#extradataencoder) - [getAddress](EthereumL1BitcoinDepositor.md#getaddress) - [getChainIdentifier](EthereumL1BitcoinDepositor.md#getchainidentifier) -- [getDepositStatus](EthereumL1BitcoinDepositor.md#getdepositstatus) +- [getDepositState](EthereumL1BitcoinDepositor.md#getDepositState) - [getEvents](EthereumL1BitcoinDepositor.md#getevents) - [initializeDeposit](EthereumL1BitcoinDepositor.md#initializedeposit) @@ -189,9 +189,9 @@ ___ ___ -### getDepositStatus +### getDepositState -▸ **getDepositStatus**(`depositId`): `Promise`\<[`DepositState`](../enums/DepositState.md)\> +▸ **getDepositState**(`depositId`): `Promise`\<[`DepositState`](../enums/DepositState.md)\> #### Parameters @@ -207,7 +207,7 @@ ___ #### Implementation of -[L1BitcoinDepositor](../interfaces/L1BitcoinDepositor.md).[getDepositStatus](../interfaces/L1BitcoinDepositor.md#getdepositstatus) +[L1BitcoinDepositor](../interfaces/L1BitcoinDepositor.md).[getDepositState](../interfaces/L1BitcoinDepositor.md#getDepositState) #### Defined in diff --git a/typescript/api-reference/interfaces/L1BitcoinDepositor.md b/typescript/api-reference/interfaces/L1BitcoinDepositor.md index dcdc48313..b20cad79f 100644 --- a/typescript/api-reference/interfaces/L1BitcoinDepositor.md +++ b/typescript/api-reference/interfaces/L1BitcoinDepositor.md @@ -13,7 +13,7 @@ specific to the given L2 chain, deployed on the L1 chain. - [extraDataEncoder](L1BitcoinDepositor.md#extradataencoder) - [getChainIdentifier](L1BitcoinDepositor.md#getchainidentifier) -- [getDepositStatus](L1BitcoinDepositor.md#getdepositstatus) +- [getDepositState](L1BitcoinDepositor.md#getDepositState) - [initializeDeposit](L1BitcoinDepositor.md#initializedeposit) ## Methods @@ -51,23 +51,23 @@ Gets the chain-specific identifier of this contract. ___ -### getDepositStatus +### getDepositState -▸ **getDepositStatus**(`depositId`): `Promise`\<[`DepositState`](../enums/DepositState.md)\> +▸ **getDepositState**(`depositId`): `Promise`\<[`DepositState`](../enums/DepositState.md)\> -Gets the deposit status for the given deposit identifier. +Gets the deposit state for the given deposit identifier. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `depositId` | `string` | Identifier of the deposit to get the status for. | +| `depositId` | `string` | Identifier of the deposit to get the state for. | #### Returns `Promise`\<[`DepositState`](../enums/DepositState.md)\> -The status of the deposit. +The state of the deposit. #### Defined in diff --git a/typescript/src/lib/contracts/cross-chain.ts b/typescript/src/lib/contracts/cross-chain.ts index ec2744d75..68a397fa9 100644 --- a/typescript/src/lib/contracts/cross-chain.ts +++ b/typescript/src/lib/contracts/cross-chain.ts @@ -127,11 +127,11 @@ export enum DepositState { */ export interface L1BitcoinDepositor { /** - * Gets the deposit status for the given deposit identifier. - * @param depositId Identifier of the deposit to get the status for. - * @returns The status of the deposit. + * Gets the deposit state for the given deposit identifier. + * @param depositId Identifier of the deposit to get the state for. + * @returns The state of the deposit. */ - getDepositStatus(depositId: string): Promise + getDepositState(depositId: string): Promise /** * Gets the chain-specific identifier of this contract. diff --git a/typescript/src/lib/ethereum/l1-bitcoin-depositor.ts b/typescript/src/lib/ethereum/l1-bitcoin-depositor.ts index bbf8f6c0b..9a437481d 100644 --- a/typescript/src/lib/ethereum/l1-bitcoin-depositor.ts +++ b/typescript/src/lib/ethereum/l1-bitcoin-depositor.ts @@ -87,9 +87,9 @@ export class EthereumL1BitcoinDepositor // eslint-disable-next-line valid-jsdoc /** - * @see {L1BitcoinDepositor#getDepositStatus} + * @see {L1BitcoinDepositor#getDepositState} */ - getDepositStatus(depositId: string): Promise { + getDepositState(depositId: string): Promise { return this._instance.deposits(depositId) } diff --git a/typescript/test/utils/mock-cross-chain.ts b/typescript/test/utils/mock-cross-chain.ts index d6052fc24..2142881b3 100644 --- a/typescript/test/utils/mock-cross-chain.ts +++ b/typescript/test/utils/mock-cross-chain.ts @@ -81,7 +81,7 @@ export class MockL1BitcoinDepositor implements L1BitcoinDepositor { this.#encoder = encoder } - getDepositStatus(depositId: string): Promise { + getDepositState(depositId: string): Promise { throw new Error("Not supported") }