Skip to content

Improve Documentation and Comments in BaseContract #5010

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve Documentation and Comments in BaseContract #5010

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions src.ts/contract/contract.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,7 +643,7 @@ export class BaseContract implements Addressable, EventEmitterable<ContractEvent
* The target to connect to.
*
* This can be an address, ENS name or any [[Addressable]], such as
* another contract. To get the resovled address, use the ``getAddress``
* another contract. To get the resolved address, use the ``getAddress``
* method.
*/
readonly target!: string | Addressable;
Expand Down Expand Up @@ -841,7 +841,7 @@ export class BaseContract implements Addressable, EventEmitterable<ContractEvent
* resolve immediately if already deployed.
*/
async waitForDeployment(): Promise<this> {
// We have the deployement transaction; just use that (throws if deployement fails)
// We have the deployment transaction; just use that (throws if deployment fails)
const deployTx = this.deploymentTransaction();
if (deployTx) {
await deployTx.wait();
Expand Down Expand Up @@ -884,7 +884,7 @@ export class BaseContract implements Addressable, EventEmitterable<ContractEvent
/**
* Return the function for a given name. This is useful when a contract
* method name conflicts with a JavaScript name such as ``prototype`` or
* when using a Contract programatically.
* when using a Contract programmatically.
*/
getFunction<T extends ContractMethod = ContractMethod>(key: string | FunctionFragment): T {
if (typeof(key) !== "string") { key = key.format(); }
Expand All @@ -895,7 +895,7 @@ export class BaseContract implements Addressable, EventEmitterable<ContractEvent
/**
* Return the event for a given name. This is useful when a contract
* event name conflicts with a JavaScript name such as ``prototype`` or
* when using a Contract programatically.
* when using a Contract programmatically.
*/
getEvent(key: string | EventFragment): ContractEvent {
if (typeof(key) !== "string") { key = key.format(); }
Expand Down