From 0059b7e468d9b8489b6c38b55eed252c02f7d96c Mon Sep 17 00:00:00 2001 From: Richard Moore Date: Fri, 3 Jul 2020 01:44:17 -0400 Subject: [PATCH] Fixed documentation typos (#895, #917, #924). --- docs.wrm/api/contract/contract-factory.wrm | 8 ++++---- docs.wrm/api/contract/contract.wrm | 10 +++++----- docs.wrm/api/contract/example.wrm | 2 +- docs.wrm/api/contract/index.wrm | 4 ++-- docs.wrm/api/providers/api-providers.wrm | 2 +- docs.wrm/api/providers/index.wrm | 6 +++--- docs.wrm/api/providers/jsonrpc-provider.wrm | 10 +++++----- docs.wrm/api/providers/provider.wrm | 2 +- docs.wrm/api/signer.wrm | 6 +++--- docs.wrm/api/utils/abi/fragments.wrm | 4 ++-- docs.wrm/api/utils/address.wrm | 2 +- docs.wrm/api/utils/bignumber.wrm | 2 +- docs.wrm/api/utils/fixednumber.wrm | 6 ++++++ docs.wrm/concepts/events.wrm | 2 +- docs.wrm/concepts/security/index.wrm | 4 ++-- docs.wrm/config.js | 10 +++++----- docs.wrm/getting-started.wrm | 2 +- docs.wrm/migration/ethers-v4.wrm | 8 ++++---- 18 files changed, 48 insertions(+), 42 deletions(-) diff --git a/docs.wrm/api/contract/contract-factory.wrm b/docs.wrm/api/contract/contract-factory.wrm index 981c7a832..d2beb0922 100644 --- a/docs.wrm/api/contract/contract-factory.wrm +++ b/docs.wrm/api/contract/contract-factory.wrm @@ -36,11 +36,11 @@ to the Contract's constructor. _property: contractFactory.deploy(...args) => Promise<[[Contract]]> @ -Uses the signer to deploy the Contract with //args// passed into tgee constructor and +Uses the signer to deploy the Contract with //args// passed into the constructor and retruns a Contract which is attached to the address where this contract **will** be -deployed once the transction is mined. +deployed once the transaction is mined. -The transction can be found at ``contract.deployTransaction``, and no interactions +The transaction can be found at ``contract.deployTransaction``, and no interactions should be made until the transaction is mined. _code: Deploying a Contract @@ -73,6 +73,6 @@ contract.deployTransaction contract.deployTransaction.wait() //! -// Now the contract is safe to ineract with +// Now the contract is safe to interact with contract.value() //! diff --git a/docs.wrm/api/contract/contract.wrm b/docs.wrm/api/contract/contract.wrm index ae2eb5924..b31c12d18 100644 --- a/docs.wrm/api/contract/contract.wrm +++ b/docs.wrm/api/contract/contract.wrm @@ -19,7 +19,7 @@ Returns a new instance of the Contract, but connected to By passing in a [[Provider]], this will return a downgraded **Contract** which only has read-only access (i.e. constant calls). -By passing in a [[Signer]]. the will return a **Contract** which +By passing in a [[Signer]]. this will return a **Contract** which will act on behalf of that signer. @@ -107,7 +107,7 @@ For values that have a simple meaning in JavaScript, the types are fairly straight forward; strings and booleans are returned as JavaScript strings and booleans. -For numbers, if the **type** is in the JavaSsript safe range (i.e. less +For numbers, if the **type** is in the JavaScript safe range (i.e. less than 53 bits, such as an ``int24`` or ``uint48``) a normal JavaScript number is used. Otherwise a [[BigNumber]] is returned. @@ -150,7 +150,7 @@ signer. _heading: Write Methods Analysis @ -There are secveral options to analyze properties and results of a +There are several options to analyze properties and results of a write method without actually executing it. _property: contract.estimateGas.METHOD_NAME(...args [ , overrides ]) => Promise<[[BigNumber]]> @ @@ -162,12 +162,12 @@ Returns an [[UnsignedTransaction]] which represents the transaction that would need to be signed and submitted to the network to execute //METHOD_NAME// with //args// and //overrides//. -_property: contract.staticCall.METHOD_NAME(...args [ , overrides ]) => Promise @ +_property: contract.callStatic.METHOD_NAME(...args [ , overrides ]) => Promise @ Rather than executing the state-change of a transaction, it is possible to ask a node to //pretend// that a call is not state-changing and return the result. -This does not actually chagne any state, but is free. This in some cases +This does not actually change any state, but is free. This in some cases can be used to determine if a transaction will fail or succeed. This otherwise functions the same as a [Read-Only Method](Contract--readonly). diff --git a/docs.wrm/api/contract/example.wrm b/docs.wrm/api/contract/example.wrm index 065ee4994..43cd5fe3d 100644 --- a/docs.wrm/api/contract/example.wrm +++ b/docs.wrm/api/contract/example.wrm @@ -91,7 +91,7 @@ Returns a new instance of the Contract, but connected to By passing in a [[Provider]], this will return a downgraded **Contract** which only has read-only access (i.e. constant calls). -By passing in a [[Signer]]. the will return a **Contract** which +By passing in a [[Signer]]. this will return a **Contract** which will act on behalf of that signer. _property: erc20.deployed() => Promise diff --git a/docs.wrm/api/contract/index.wrm b/docs.wrm/api/contract/index.wrm index d9420c5ef..68affc6a6 100644 --- a/docs.wrm/api/contract/index.wrm +++ b/docs.wrm/api/contract/index.wrm @@ -2,10 +2,10 @@ _section: Contract Interaction @ A **Contract** object is an abstraction of a contract (EVM bytecode) deployed on the Ethereum network. It allows for a simple way to -serialize calls and transaxtions to an on-chain contract and +serialize calls and transactions to an on-chain contract and deserialize their results and emitted logs. -A **ContractFactory** is an abstraction a contract's //bytecode// +A **ContractFactory** is an abstraction of a contract's //bytecode// and facilitates deploying a contract. _toc: diff --git a/docs.wrm/api/providers/api-providers.wrm b/docs.wrm/api/providers/api-providers.wrm index 1291244ce..0c8f2b9f4 100644 --- a/docs.wrm/api/providers/api-providers.wrm +++ b/docs.wrm/api/providers/api-providers.wrm @@ -96,7 +96,7 @@ specify a [Project Secret](link-infura-secret) which can be used on non-public sources (like on a server) to further secure your API access and quotas. -_property: InfuraProvider.getWebSocketProvider([ network [ , apiKey ] ]) => [[WebSocketProvider]] @ @SRC +_property: InfuraProvider.getWebSocketProvider([ network [ , apiKey ] ]) => [[WebSocketProvider]] @ @SRC Create a new [[WebSocketProvider]] using the INFURA web-socket endpoint to connect to //network// with the optional //apiKey//. diff --git a/docs.wrm/api/providers/index.wrm b/docs.wrm/api/providers/index.wrm index 0193a311c..c6166ecd7 100644 --- a/docs.wrm/api/providers/index.wrm +++ b/docs.wrm/api/providers/index.wrm @@ -55,16 +55,16 @@ _note: Note: API Keys It is highly recommended for production services that to acquire and specify an API Key for each sercice. -The deafult API Keys used by ethers are shared across all users, +The default API Keys used by ethers are shared across all users, so services may throttle all services that are using the default API Keys during periods of load without realizing it. Many services also have monitoring and usage metrics, which are -only available if an API Key is specifie. This allows tracking +only available if an API Key is specified. This allows tracking how many requests are being sent and which methods are being used the most. -Some services also provide additional paid features, whichare only +Some services also provide additional paid features, which are only available when specifying an API Key. diff --git a/docs.wrm/api/providers/jsonrpc-provider.wrm b/docs.wrm/api/providers/jsonrpc-provider.wrm index fa4036994..65df445b4 100644 --- a/docs.wrm/api/providers/jsonrpc-provider.wrm +++ b/docs.wrm/api/providers/jsonrpc-provider.wrm @@ -14,7 +14,7 @@ querying the node. _note: Note: Connecting to a Local Node Each node implementation is slightly different and may require specific command-line flags, configuration or settings in their UI to enable -JSON-RPC, unlock accounrs or expose specific APIs. Please consult +JSON-RPC, unlock accounts or expose specific APIs. Please consult their documentation. _property: jsonRpcProvider.getSigner([ addressOrIndex ]) => [[JsonRpcSigner]] @ @SRC @@ -42,12 +42,12 @@ _property: signer.provider => [[JsonRpcProvider]] The provider this signer was established from. _property: signer.connectUnchecked() => [[UncheckedJsonRpcSigner]] @ @SRC -Returns a new Signer object which does not perform addtional checks when +Returns a new Signer object which does not perform additional checks when sending a transaction. See [getUncheckedSigner](JsonRpcProvider-getUncheckedSigner) for more details. _property: signer.sendUncheckedTransaction(transaction) => Promise\>> @ @SRC Sends the //transaction// and returns a Promise which resolves to the -opacque transaction hash. +opaque transaction hash. _property: signer.unlock(password) => Promise @ @SRC Request the node unlock the account (if locked) using //password//. @@ -60,7 +60,7 @@ of a transaction before returning it. For example, the gas price and gas limit may be adjusted by the node or the nonce automatically included, in which case the opaque transaction hash has discarded this. -To remedy this, the [[JsonRpcSigner]] immeidately queries the provider for +To remedy this, the [[JsonRpcSigner]] immediately queries the provider for the details using the returned transaction hash to populate the [[providers-TransactionResponse]] object. @@ -85,7 +85,7 @@ The [jsonRpcProvider.send](JsonRpcProvider-send) method can be used to access th - [All JSON-RPC methods](link-json-rpc) (including the less common methods) which most Ethereum Nodes support. - [Parity's Trace Module](link-parity-trace) can be used to trace and debug EVM - execcution of a transaction (requires custom configuration) + execution of a transaction (requires custom configuration) - [Geth's Debug Module](link-geth-debug) can be used to debug transactions and internal cache state, etc. - [Additional Geth Methods](link-geth-rpc) diff --git a/docs.wrm/api/providers/provider.wrm b/docs.wrm/api/providers/provider.wrm index 75024013b..7e4e8a574 100644 --- a/docs.wrm/api/providers/provider.wrm +++ b/docs.wrm/api/providers/provider.wrm @@ -60,7 +60,7 @@ provider.getBlockWithTransactions(100004) _subsection: Ethereum Naming Service (ENS) Methods @ The [Ethereum Naming Service](link-ens) (ENS) allows a short and -easy-to-remember ENS Name to be atached to any set of keys +easy-to-remember ENS Name to be attached to any set of keys and values. One of the most common uses for this is to use a simple name to diff --git a/docs.wrm/api/signer.wrm b/docs.wrm/api/signer.wrm index e357a9da3..6d02cffe4 100644 --- a/docs.wrm/api/signer.wrm +++ b/docs.wrm/api/signer.wrm @@ -47,7 +47,7 @@ _property: signer.getBalance([ blockTag = "latest" ]) => Promise<[[BigNumber]]> Returns the balance of this wallet at //blockTag//. _property: signer.getChainId() => Promise @ @SRC -Returns ths chain ID this wallet is connected to. +Returns the chain ID this wallet is connected to. _property: signer.getGasPrice() => Promise<[[BigNumber]]> @ @SRC Returns the current gas price. @@ -121,7 +121,7 @@ properties such as the //provider// and //address// static throughout the life-cycle of the Signer helps prevent serious issues and many other classes and libraries make this assumption. -A sub-class **must** extend Sigenr and **must** call ``super()``. +A sub-class **must** extend Signer and **must** call ``super()``. _property: signer.checkTransaction(transactionRequest) => [[providers-TransactionRequest]] @ @SRC This is generally not required to be overridden, but may needed to provide @@ -197,7 +197,7 @@ The provider this wallet is connected to, which will ge used for any [[Signer--b methods. This can be null. _note: Note -A **Wallet** instance is immuatable, so if you wish to change the Provider, you +A **Wallet** instance is immutable, so if you wish to change the Provider, you may use the [connect](Signer-connect) method to create a new instance connected to the desired provider. diff --git a/docs.wrm/api/utils/abi/fragments.wrm b/docs.wrm/api/utils/abi/fragments.wrm index 30eb24267..d3f201890 100644 --- a/docs.wrm/api/utils/abi/fragments.wrm +++ b/docs.wrm/api/utils/abi/fragments.wrm @@ -12,12 +12,12 @@ The **JSON ABI Format** is the format that is A JSON serialized object is always a string, which represents an Array of Objects, where each Object has various properties describing the [[Fragment]] of the ABI. -The deserialied JSON string (which is a normal JavaScript Object) may +The deserialized JSON string (which is a normal JavaScript Object) may also be passed into any function which accepts a JSON String ABI. _heading: Humanb-Readable ABI -The Human-Readable ABI was +The Human-Readable ABI was @TODO [article](link-ricmoo-humanreadableabi) diff --git a/docs.wrm/api/utils/address.wrm b/docs.wrm/api/utils/address.wrm index 195b9875a..e7951ba73 100644 --- a/docs.wrm/api/utils/address.wrm +++ b/docs.wrm/api/utils/address.wrm @@ -45,7 +45,7 @@ _property: ethers.utils.getAddress(address) => string<[[address]]> @** //otherValue//. _property: BigNumber.gte(otherValue) => boolean @SRC Returns true if and only if the value of //BigNumber// **≥** //otherValue//. -_property: BigNumber.isZero() => boolean @SRC +_property: BigNumber.isZero() => boolean @SRC Returns true if and only if the value of //BigNumber// is zero. diff --git a/docs.wrm/api/utils/fixednumber.wrm b/docs.wrm/api/utils/fixednumber.wrm index 5b51466b6..a3accfa5e 100644 --- a/docs.wrm/api/utils/fixednumber.wrm +++ b/docs.wrm/api/utils/fixednumber.wrm @@ -49,6 +49,12 @@ _property: fixednumber.round([ decimals = 0 ]) => [[FixedNumber]] @SRC boolean @SRC +Returns true if and only if the value of //FixedNumber// is zero. + + _heading: Conversion _property: fixednumber.toFormat(format) => [[FixedNumber]] @SRC diff --git a/docs.wrm/concepts/events.wrm b/docs.wrm/concepts/events.wrm index 71233348d..e9493497e 100644 --- a/docs.wrm/concepts/events.wrm +++ b/docs.wrm/concepts/events.wrm @@ -27,7 +27,7 @@ If a topic-set is a single topic, a log topic in that position must match **that topic**. If a topic-set is an array of topics, a log topic in that position must -match any **one** of topics (i.e. the topic in thie position are ``OR``-ed). +match any **one** of the topics (i.e. the topic in this position are ``OR``-ed). _table: Example Log Matching @style diff --git a/docs.wrm/concepts/security/index.wrm b/docs.wrm/concepts/security/index.wrm index eaf98e4a9..bddf34f3b 100644 --- a/docs.wrm/concepts/security/index.wrm +++ b/docs.wrm/concepts/security/index.wrm @@ -12,7 +12,7 @@ much stronger security. The algorithm usually used for this process is [scrypt](link-wiki-scrypt), which is a memory and CPU intensive algorithm which computes -a key (fixed-length psudo-random series of bytes) for a given +a key (fixed-length pseudo-random series of bytes) for a given password. @@ -50,7 +50,7 @@ progress callback which will be periodically called with a number between In general a progress bar makes the experience feel faster, as well as more comfortable since there is a clear indication how much (relative) time -is remaining. Additionally, using language like //"decrpyting..."// in +is remaining. Additionally, using language like //"decrypting..."// in a progress bar makes a user feel like there time is not being //needlessly// wasted. diff --git a/docs.wrm/config.js b/docs.wrm/config.js index ff859d132..4aac6713c 100644 --- a/docs.wrm/config.js +++ b/docs.wrm/config.js @@ -54,7 +54,7 @@ function getDefinitions(source) { const getSourceUrl = (function(path, include, exclude) { console.log("Scanning TypeScript Sources..."); - const Link = "https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages$FILENAME#L$LINE"; + const Link = "https://github.com/ethers-io/ethers.js/blob/master/packages$FILENAME#L$LINE"; const Root = resolve(__dirname, path); const readdir = function(path) { @@ -151,16 +151,16 @@ function codeContextify(context) { module.exports = { title: "ethers", - subtitle: "v5.0-beta", + subtitle: "v5.0", logo: "logo.svg", prefix: "/v5", - link: "https:/\/docs-beta.ethers.io", + link: "https:/\/docs.ethers.io", copyright: "The content of this site is licensed under the [Creative Commons License](https:/\/choosealicense.com/licenses/cc-by-4.0/). Generated on &$now;.", markdown: { - "banner": "-----\n\nDocumentation: [html](https://docs-beta.ethers.io/)\n\n-----\n\n" + "banner": "-----\n\nDocumentation: [html](https://docs.ethers.io/)\n\n-----\n\n" }, codeContextify: codeContextify, @@ -217,7 +217,7 @@ module.exports = { "link-ethers-docs": "https:/\/docs.ethers.io/", "link-ethers-js": "https:/\/cdn.ethers.io/lib/ethers-5.0.esm.min.js", "link-ethers-npm": "https:/\/www.npmjs.com/search?q=%40ethersproject%2F", - "link-ethers-asm-grammar": "https:/\/github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/asm/grammar.jison", + "link-ethers-asm-grammar": "https:/\/github.com/ethers-io/ethers.js/blob/master/packages/asm/grammar.jison", "link-eip-155": { name: "EIP-155", url: "https:/\/eips.ethereum.org/EIPS/eip-155" }, "link-eip-191": { name: "EIP-191", url: "https:/\/eips.ethereum.org/EIPS/eip-191" }, diff --git a/docs.wrm/getting-started.wrm b/docs.wrm/getting-started.wrm index 8b4bc720d..2d2608ac5 100644 --- a/docs.wrm/getting-started.wrm +++ b/docs.wrm/getting-started.wrm @@ -78,7 +78,7 @@ Ethereum is to use [[link-metamask]], which is a browser extension that provides: - A connection to the Ethereum network (a [[Provider]]) -- Holds your private key and can sign thing (a [[Signer]]) +- Holds your private key and can sign things (a [[Signer]]) _code: Connecting to Metamask @lang