Updated docs build.
This commit is contained in:
parent
0059b7e468
commit
c646a0c881
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -80,6 +80,7 @@ Developer Documentation
|
|||||||
* [IpcProvider](api/providers/other)
|
* [IpcProvider](api/providers/other)
|
||||||
* [UrlJsonRpcProvider](api/providers/other)
|
* [UrlJsonRpcProvider](api/providers/other)
|
||||||
* [Web3Provider](api/providers/other)
|
* [Web3Provider](api/providers/other)
|
||||||
|
* [WebSocketProvider](api/providers/other)
|
||||||
* [Types](api/providers/types)
|
* [Types](api/providers/types)
|
||||||
* [BlockTag](api/providers/types)
|
* [BlockTag](api/providers/types)
|
||||||
* [Network](api/providers/types)
|
* [Network](api/providers/types)
|
||||||
@ -235,6 +236,8 @@ Developer Documentation
|
|||||||
* [Testing](testing)
|
* [Testing](testing)
|
||||||
* [Contributing and Hacking](contributing)
|
* [Contributing and Hacking](contributing)
|
||||||
* [Building](contributing)
|
* [Building](contributing)
|
||||||
|
* [Making your changes](contributing)
|
||||||
|
* [Documentation](contributing)
|
||||||
* [Flatworm Docs](documentation)
|
* [Flatworm Docs](documentation)
|
||||||
* [Fragments](documentation)
|
* [Fragments](documentation)
|
||||||
* [Markdown](documentation)
|
* [Markdown](documentation)
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -54,6 +54,7 @@ Application Programming Interface
|
|||||||
* [IpcProvider](providers/other)
|
* [IpcProvider](providers/other)
|
||||||
* [UrlJsonRpcProvider](providers/other)
|
* [UrlJsonRpcProvider](providers/other)
|
||||||
* [Web3Provider](providers/other)
|
* [Web3Provider](providers/other)
|
||||||
|
* [WebSocketProvider](providers/other)
|
||||||
* [Types](providers/types)
|
* [Types](providers/types)
|
||||||
* [BlockTag](providers/types)
|
* [BlockTag](providers/types)
|
||||||
* [Network](providers/types)
|
* [Network](providers/types)
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -52,9 +52,9 @@ Returns the unsigned transaction which would deploy this Contract with *args* pa
|
|||||||
|
|
||||||
#### *contractFactory* . **deploy**( ...args ) => *Promise< [Contract](/v5/api/contract/contract/) >*
|
#### *contractFactory* . **deploy**( ...args ) => *Promise< [Contract](/v5/api/contract/contract/) >*
|
||||||
|
|
||||||
Uses the signer to deploy the Contract with *args* passed into tgee constructor and retruns a Contract which is attached to the address where this contract **will** be deployed once the transction is mined.
|
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 transaction is mined.
|
||||||
|
|
||||||
The transction can be found at `contract.deployTransaction`, and no interactions should be made until the transaction is mined.
|
The transaction can be found at `contract.deployTransaction`, and no interactions should be made until the transaction is mined.
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -86,7 +86,7 @@ contract.deployTransaction
|
|||||||
contract.deployTransaction.wait()
|
contract.deployTransaction.wait()
|
||||||
//!
|
//!
|
||||||
|
|
||||||
// Now the contract is safe to ineract with
|
// Now the contract is safe to interact with
|
||||||
contract.value()
|
contract.value()
|
||||||
//!
|
//!
|
||||||
```
|
```
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -25,7 +25,7 @@ Returns a new instance of the Contract, but connected to *providerOrSigner*.
|
|||||||
|
|
||||||
By passing in a [Provider](/v5/api/providers/provider/), this will return a downgraded **Contract** which only has read-only access (i.e. constant calls).
|
By passing in a [Provider](/v5/api/providers/provider/), this will return a downgraded **Contract** which only has read-only access (i.e. constant calls).
|
||||||
|
|
||||||
By passing in a [Signer](/v5/api/signer/#Signer). the will return a **Contract** which will act on behalf of that signer.
|
By passing in a [Signer](/v5/api/signer/#Signer). this will return a **Contract** which will act on behalf of that signer.
|
||||||
|
|
||||||
|
|
||||||
Properties
|
Properties
|
||||||
@ -121,7 +121,7 @@ The type of the result depends on the ABI.
|
|||||||
|
|
||||||
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 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 than 53 bits, such as an `int24` or `uint48`) a normal JavaScript number is used. Otherwise a [BigNumber](/v5/api/utils/bignumber/) is returned.
|
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](/v5/api/utils/bignumber/) is returned.
|
||||||
|
|
||||||
For bytes (both fixed length and dynamic), a [DataHexString](/v5/api/utils/bytes/#DataHexString) is returned.
|
For bytes (both fixed length and dynamic), a [DataHexString](/v5/api/utils/bytes/#DataHexString) is returned.
|
||||||
|
|
||||||
@ -156,11 +156,11 @@ Returns the estimate units of gas that would be required to execute the *METHOD_
|
|||||||
Returns an [UnsignedTransaction](/v5/api/utils/transactions/#UnsignedTransaction) which represents the transaction that would need to be signed and submitted to the network to execute *METHOD_NAME* with *args* and *overrides*.
|
Returns an [UnsignedTransaction](/v5/api/utils/transactions/#UnsignedTransaction) which represents the transaction that would need to be signed and submitted to the network to execute *METHOD_NAME* with *args* and *overrides*.
|
||||||
|
|
||||||
|
|
||||||
#### *contract* . *staticCall* . **METHOD_NAME**( ...args [ , overrides ] ) => *Promise< any >*
|
#### *contract* . *callStatic* . **METHOD_NAME**( ...args [ , overrides ] ) => *Promise< any >*
|
||||||
|
|
||||||
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.
|
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 can be used to determine if a transaction will fail or succeed.
|
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](/v5/api/contract/contract/#Contract--readonly).
|
This otherwise functions the same as a [Read-Only Method](/v5/api/contract/contract/#Contract--readonly).
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -102,7 +102,7 @@ Returns a new instance of the Contract, but connected to *providerOrSigner*.
|
|||||||
|
|
||||||
By passing in a [Provider](/v5/api/providers/provider/), this will return a downgraded **Contract** which only has read-only access (i.e. constant calls).
|
By passing in a [Provider](/v5/api/providers/provider/), this will return a downgraded **Contract** which only has read-only access (i.e. constant calls).
|
||||||
|
|
||||||
By passing in a [Signer](/v5/api/signer/#Signer). the will return a **Contract** which will act on behalf of that signer.
|
By passing in a [Signer](/v5/api/signer/#Signer). this will return a **Contract** which will act on behalf of that signer.
|
||||||
|
|
||||||
|
|
||||||
#### *erc20* . **deployed**( ) => *Promise< Contract >*
|
#### *erc20* . **deployed**( ) => *Promise< Contract >*
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -25,9 +25,9 @@ Option Properties
|
|||||||
|
|
||||||
It is highly recommended for production services that to acquire and specify an API Key for each sercice.
|
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, so services may throttle all services that are using the default API Keys during periods of load without realizing it.
|
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 how many requests are being sent and which methods are being used the most.
|
Many services also have monitoring and usage metrics, which are 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, which are only available when specifying an API Key.
|
Some services also provide additional paid features, which are only available when specifying an API Key.
|
||||||
|
|
||||||
@ -58,6 +58,7 @@ Provider Documentation
|
|||||||
* [IpcProvider](other)
|
* [IpcProvider](other)
|
||||||
* [UrlJsonRpcProvider](other)
|
* [UrlJsonRpcProvider](other)
|
||||||
* [Web3Provider](other)
|
* [Web3Provider](other)
|
||||||
|
* [WebSocketProvider](other)
|
||||||
* [Types](types)
|
* [Types](types)
|
||||||
* [BlockTag](types)
|
* [BlockTag](types)
|
||||||
* [Network](types)
|
* [Network](types)
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -76,6 +76,13 @@ The *network* may be specified as **string** for a common network name, a **numb
|
|||||||
The *apiKey* can be a **string** Project ID or an **object** with the properties `projectId` and `projectSecret` to specify a [Project Secret](https://infura.io/docs/gettingStarted/authentication) which can be used on non-public sources (like on a server) to further secure your API access and quotas.
|
The *apiKey* can be a **string** Project ID or an **object** with the properties `projectId` and `projectSecret` to specify a [Project Secret](https://infura.io/docs/gettingStarted/authentication) which can be used on non-public sources (like on a server) to further secure your API access and quotas.
|
||||||
|
|
||||||
|
|
||||||
|
#### *InfuraProvider* . **getWebSocketProvider**( [ network [ , apiKey ] ] ) => *[WebSocketProvider](/v5/api/providers/other/#WebSocketProvider)*
|
||||||
|
|
||||||
|
Create a new [WebSocketProvider](/v5/api/providers/other/#WebSocketProvider) using the INFURA web-socket endpoint to connect to *network* with the optional *apiKey*.
|
||||||
|
|
||||||
|
The *network* and *apiKey* are specified the same as [the constructor](/v5/api/providers/api-providers/#InfuraProvider).
|
||||||
|
|
||||||
|
|
||||||
#### Note: Default API keys
|
#### Note: Default API keys
|
||||||
|
|
||||||
If no *apiKey* is provided, a shared API key will be used, which may result in reduced performance and throttled requests.
|
If no *apiKey* is provided, a shared API key will be used, which may result in reduced performance and throttled requests.
|
||||||
@ -111,6 +118,9 @@ provider = new InfuraProvider("homestead", {
|
|||||||
projectId: projectId,
|
projectId: projectId,
|
||||||
projectSecret: projectSecret
|
projectSecret: projectSecret
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Connect to the INFURA WebSocket endpoints with a WebSocketProvider
|
||||||
|
provider = InfuraProvider.getWebSocketProvider()
|
||||||
```
|
```
|
||||||
|
|
||||||
AlchemyProvider
|
AlchemyProvider
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -14,7 +14,7 @@ Connect to a JSON-RPC API located at *url* using the *aNetworkish* network. If *
|
|||||||
|
|
||||||
#### Note: Connecting to a Local Node
|
#### 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 their documentation.
|
Each node implementation is slightly different and may require specific command-line flags, configuration or settings in their UI to enable JSON-RPC, unlock accounts or expose specific APIs. Please consult their documentation.
|
||||||
|
|
||||||
|
|
||||||
#### *jsonRpcProvider* . **getSigner**( [ addressOrIndex ] ) => *[JsonRpcSigner](/v5/api/providers/jsonrpc-provider/#JsonRpcSigner)*
|
#### *jsonRpcProvider* . **getSigner**( [ addressOrIndex ] ) => *[JsonRpcSigner](/v5/api/providers/jsonrpc-provider/#JsonRpcSigner)*
|
||||||
@ -48,12 +48,12 @@ The provider this signer was established from.
|
|||||||
|
|
||||||
#### *signer* . **connectUnchecked**( ) => *[JsonRpcUncheckedSigner](/v5/api/providers/jsonrpc-provider/#UncheckedJsonRpcSigner)*
|
#### *signer* . **connectUnchecked**( ) => *[JsonRpcUncheckedSigner](/v5/api/providers/jsonrpc-provider/#UncheckedJsonRpcSigner)*
|
||||||
|
|
||||||
Returns a new Signer object which does not perform addtional checks when sending a transaction. See [getUncheckedSigner](/v5/api/providers/jsonrpc-provider/#JsonRpcProvider-getUncheckedSigner) for more details.
|
Returns a new Signer object which does not perform additional checks when sending a transaction. See [getUncheckedSigner](/v5/api/providers/jsonrpc-provider/#JsonRpcProvider-getUncheckedSigner) for more details.
|
||||||
|
|
||||||
|
|
||||||
#### *signer* . **sendUncheckedTransaction**( transaction ) => *Promise< string< [DataHexString](/v5/api/utils/bytes/#DataHexString)< 32 > > >*
|
#### *signer* . **sendUncheckedTransaction**( transaction ) => *Promise< string< [DataHexString](/v5/api/utils/bytes/#DataHexString)< 32 > > >*
|
||||||
|
|
||||||
Sends the *transaction* and returns a Promise which resolves to the opacque transaction hash.
|
Sends the *transaction* and returns a Promise which resolves to the opaque transaction hash.
|
||||||
|
|
||||||
|
|
||||||
#### *signer* . **unlock**( password ) => *Promise< boolean >*
|
#### *signer* . **unlock**( password ) => *Promise< boolean >*
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -120,3 +120,13 @@ The *callback* should use the error-first calling semantics, so `(error, result)
|
|||||||
This is identical to `sendAsync`. Historically, this used a synchronous web request, but no current browsers support this, so its use this way was deprecated quite a long time ago
|
This is identical to `sendAsync`. Historically, this used a synchronous web request, but no current browsers support this, so its use this way was deprecated quite a long time ago
|
||||||
|
|
||||||
|
|
||||||
|
WebSocketProvider
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
#### **new ***ethers* . *provider* . **WebSockerProvider**( [ url [ , network ] ] )
|
||||||
|
|
||||||
|
Returns a new [WebSocketProvider](/v5/api/providers/other/#WebSocketProvider) connected to *url* as the *network*.
|
||||||
|
|
||||||
|
If *url* is unspecified, the default `"ws://localhost:8546"` will be used. If *network* is unspecified, it will be queried from the network.
|
||||||
|
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -33,7 +33,7 @@ Returns the number of transactions *address* has ever **sent**, as of *blockTag*
|
|||||||
```javascript
|
```javascript
|
||||||
// Get the balance for an account...
|
// Get the balance for an account...
|
||||||
provider.getBalance("ricmoo.firefly.eth");
|
provider.getBalance("ricmoo.firefly.eth");
|
||||||
// { Promise: { BigNumber: "955864037352077165" } }
|
// { Promise: { BigNumber: "1585454034436018765" } }
|
||||||
|
|
||||||
// Get the code for a contract...
|
// Get the code for a contract...
|
||||||
provider.getCode("registrar.firefly.eth");
|
provider.getCode("registrar.firefly.eth");
|
||||||
@ -45,7 +45,7 @@ provider.getStorageAt("registrar.firefly.eth", 0)
|
|||||||
|
|
||||||
// Get transaction count of an account...
|
// Get transaction count of an account...
|
||||||
provider.getTransactionCount("ricmoo.firefly.eth");
|
provider.getTransactionCount("ricmoo.firefly.eth");
|
||||||
// { Promise: 668 }
|
// { Promise: 670 }
|
||||||
```
|
```
|
||||||
|
|
||||||
Blocks Methods
|
Blocks Methods
|
||||||
@ -96,7 +96,7 @@ provider.getBlockWithTransactions(100004)
|
|||||||
// blockHash: '0xf93283571ae16dcecbe1816adc126954a739350cd1523a1559eabeae155fbb63',
|
// blockHash: '0xf93283571ae16dcecbe1816adc126954a739350cd1523a1559eabeae155fbb63',
|
||||||
// blockNumber: 100004,
|
// blockNumber: 100004,
|
||||||
// chainId: 0,
|
// chainId: 0,
|
||||||
// confirmations: 10153796,
|
// confirmations: 10284646,
|
||||||
// creates: null,
|
// creates: null,
|
||||||
// data: '0x',
|
// data: '0x',
|
||||||
// from: '0xcf00A85f3826941e7A25BFcF9Aac575d40410852',
|
// from: '0xcf00A85f3826941e7A25BFcF9Aac575d40410852',
|
||||||
@ -177,16 +177,16 @@ provider.getNetwork()
|
|||||||
|
|
||||||
// The current block number
|
// The current block number
|
||||||
provider.getBlockNumber()
|
provider.getBlockNumber()
|
||||||
// { Promise: 10253799 }
|
// { Promise: 10384649 }
|
||||||
|
|
||||||
// Get the current suggested gas price (in wei)...
|
// Get the current suggested gas price (in wei)...
|
||||||
gasPrice = await provider.getGasPrice()
|
gasPrice = await provider.getGasPrice()
|
||||||
// { BigNumber: "19470000000" }
|
// { BigNumber: "41000000000" }
|
||||||
|
|
||||||
// ...often this gas price is easier to understand or
|
// ...often this gas price is easier to understand or
|
||||||
// display to the user in gwei (giga-wei, or 1e9 wei)
|
// display to the user in gwei (giga-wei, or 1e9 wei)
|
||||||
utils.formatUnits(gasPrice, "gwei")
|
utils.formatUnits(gasPrice, "gwei")
|
||||||
// '19.47'
|
// '41.0'
|
||||||
```
|
```
|
||||||
|
|
||||||
Transactions Methods
|
Transactions Methods
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -38,7 +38,7 @@ Returns the balance of this wallet at *blockTag*.
|
|||||||
|
|
||||||
#### *signer* . **getChainId**( ) => *Promise< number >*
|
#### *signer* . **getChainId**( ) => *Promise< number >*
|
||||||
|
|
||||||
Returns ths chain ID this wallet is connected to.
|
Returns the chain ID this wallet is connected to.
|
||||||
|
|
||||||
|
|
||||||
#### *signer* . **getGasPrice**( ) => *Promise< [BigNumber](/v5/api/utils/bignumber/) >*
|
#### *signer* . **getGasPrice**( ) => *Promise< [BigNumber](/v5/api/utils/bignumber/) >*
|
||||||
@ -177,7 +177,7 @@ The provider this wallet is connected to, which will ge used for any [Blockchain
|
|||||||
|
|
||||||
#### Note
|
#### Note
|
||||||
|
|
||||||
A **Wallet** instance is immuatable, so if you wish to change the Provider, you may use the [connect](/v5/api/signer/#Signer-connect) method to create a new instance connected to the desired provider.
|
A **Wallet** instance is immutable, so if you wish to change the Provider, you may use the [connect](/v5/api/signer/#Signer-connect) method to create a new instance connected to the desired provider.
|
||||||
|
|
||||||
|
|
||||||
#### *wallet* . **publicKey** => *string< [DataHexString](/v5/api/utils/bytes/#DataHexString)< 65 > >*
|
#### *wallet* . **publicKey** => *string< [DataHexString](/v5/api/utils/bytes/#DataHexString)< 65 > >*
|
||||||
@ -285,7 +285,7 @@ contract = new ethers.Contract("dai.tokens.ethers.eth", abi, signer)
|
|||||||
|
|
||||||
// Get the number of tokens for this account
|
// Get the number of tokens for this account
|
||||||
tokens = await contract.balanceOf(signer.getAddress())
|
tokens = await contract.balanceOf(signer.getAddress())
|
||||||
// { BigNumber: "7712595125722568213383" }
|
// { BigNumber: "8814410125722568213383" }
|
||||||
|
|
||||||
//
|
//
|
||||||
// Pre-flight (check for revert) on DAI from the signer
|
// Pre-flight (check for revert) on DAI from the signer
|
||||||
@ -302,7 +302,7 @@ contract.callStatic.transfer("donations.ethers.eth", tokens)
|
|||||||
|
|
||||||
// This will fail since it is greater than the token balance
|
// This will fail since it is greater than the token balance
|
||||||
contract.callStatic.transfer("donations.ethers.eth", tokens.add(1))
|
contract.callStatic.transfer("donations.ethers.eth", tokens.add(1))
|
||||||
// Error: call revert exception (method="transfer(address,uint256)", errorSignature="Error(string)", errorArgs=["Dai/insufficient-balance"], reason="Dai/insufficient-balance", code=CALL_EXCEPTION, version=abi/5.0.0-beta.156)
|
// Error: call revert exception (method="transfer(address,uint256)", errorSignature="Error(string)", errorArgs=["Dai/insufficient-balance"], reason="Dai/insufficient-balance", code=CALL_EXCEPTION, version=abi/5.0.1)
|
||||||
```
|
```
|
||||||
|
|
||||||
ExternallyOwnedAccount
|
ExternallyOwnedAccount
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -21,7 +21,7 @@ Converting and Verifying
|
|||||||
|
|
||||||
Returns *address* as a Checksum Address.
|
Returns *address* as a Checksum Address.
|
||||||
|
|
||||||
If *address* is an invalid 40-nibble [HexString](/v5/api/utils/bytes/#HexString) or if it contains mixed case and the checksum is invalid, an InvalidArgument Error is throw.
|
If *address* is an invalid 40-nibble [HexString](/v5/api/utils/bytes/#HexString) or if it contains mixed case and the checksum is invalid, an InvalidArgument Error is thrown.
|
||||||
|
|
||||||
The value of *address* may be any supported address format.
|
The value of *address* may be any supported address format.
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -85,7 +85,7 @@ BigNumber.from(42n)
|
|||||||
|
|
||||||
// Numbers outside the safe range fail:
|
// Numbers outside the safe range fail:
|
||||||
BigNumber.from(Number.MAX_SAFE_INTEGER);
|
BigNumber.from(Number.MAX_SAFE_INTEGER);
|
||||||
// Error: overflow (fault="overflow", operation="BigNumber.from", value=9007199254740991, code=NUMERIC_FAULT, version=bignumber/5.0.0-beta.139)
|
// Error: overflow (fault="overflow", operation="BigNumber.from", value=9007199254740991, code=NUMERIC_FAULT, version=bignumber/5.0.2)
|
||||||
```
|
```
|
||||||
|
|
||||||
Methods
|
Methods
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -164,20 +164,20 @@ Return a copy of *array* shuffled using [Fisher-Yates Shuffle](https://en.wikipe
|
|||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
utils.randomBytes(8)
|
utils.randomBytes(8)
|
||||||
// Uint8Array [ 131, 252, 210, 50, 128, 120, 18, 68 ]
|
// Uint8Array [ 95, 9, 0, 81, 176, 49, 211, 225 ]
|
||||||
|
|
||||||
const data = [ 1, 2, 3, 4, 5, 6, 7 ];
|
const data = [ 1, 2, 3, 4, 5, 6, 7 ];
|
||||||
|
|
||||||
// Returns a new Array
|
// Returns a new Array
|
||||||
utils.shuffled(data);
|
utils.shuffled(data);
|
||||||
// [
|
// [
|
||||||
// 7,
|
|
||||||
// 6,
|
// 6,
|
||||||
|
// 7,
|
||||||
// 4,
|
// 4,
|
||||||
// 2,
|
|
||||||
// 3,
|
// 3,
|
||||||
|
// 5,
|
||||||
// 1,
|
// 1,
|
||||||
// 5
|
// 2
|
||||||
// ]
|
// ]
|
||||||
|
|
||||||
// The Original is unscathed...
|
// The Original is unscathed...
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -68,6 +68,13 @@ Returns a new FixedNumber with the value of *fixedvalue* **/** *otherValue*.
|
|||||||
Returns a new FixedNumber with the value of *fixedvalue* rounded to *decimals*.
|
Returns a new FixedNumber with the value of *fixedvalue* rounded to *decimals*.
|
||||||
|
|
||||||
|
|
||||||
|
### Comparison and Equivalence
|
||||||
|
|
||||||
|
#### *FixedNumber* . **isZero**( ) => *boolean*
|
||||||
|
|
||||||
|
Returns true if and only if the value of *FixedNumber* is zero.
|
||||||
|
|
||||||
|
|
||||||
### Conversion
|
### Conversion
|
||||||
|
|
||||||
#### *fixednumber* . **toFormat**( format ) => *[FixedNumber](/v5/api/utils/fixednumber/)*
|
#### *fixednumber* . **toFormat**( format ) => *[FixedNumber](/v5/api/utils/fixednumber/)*
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -52,7 +52,7 @@ utils.keccak256("0x1234")
|
|||||||
|
|
||||||
// Do NOT use UTF-8 strings that are not a DataHexstring
|
// Do NOT use UTF-8 strings that are not a DataHexstring
|
||||||
utils.keccak256("hello world")
|
utils.keccak256("hello world")
|
||||||
// Error: invalid arrayify value (argument="value", value="hello world", code=INVALID_ARGUMENT, version=bytes/5.0.0-beta.138)
|
// Error: invalid arrayify value (argument="value", value="hello world", code=INVALID_ARGUMENT, version=bytes/5.0.1)
|
||||||
|
|
||||||
// If needed, convert strings to bytes first:
|
// If needed, convert strings to bytes first:
|
||||||
utils.keccak256(utils.toUtf8Bytes("hello world"))
|
utils.keccak256(utils.toUtf8Bytes("hello world"))
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
Documentation: [html](https://docs-beta.ethers.io/)
|
Documentation: [html](https://docs.ethers.io/)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user