34 lines
23 KiB
HTML
34 lines
23 KiB
HTML
|
<html><head><title>Transactions</title><link rel="stylesheet" type="text/css" href="/static/style.css"></head><body><div class="sidebar"><div class="header"><div class="logo"><a href="/"><div class="image"></div><div class="name">ethers</div><div class="version">v5.0-beta</div></a></div></div><div class="toc"><div><div class="link title"><a href="/">Documentation</a></div><div class="base show link depth-1"><a href="/getting-started/">Getting Started</a></div><div class="hide link depth-2"><a href="/getting-started/#installing">Installing</a></div><div class="hide link depth-2"><a href="/getting-started/#importing">Importing</a></div><div class="base show link depth-1"><a href="/concepts/">Concepts</a></div><div class="hide link depth-2"><a href="/concepts/events/">Events</a></div><div class="hide link depth-3"><a href="/concepts/events/#solidity-topics">Solidity Topics</a></div><div class="hide link depth-2"><a href="/concepts/gas/">Gas</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-price">Gas Price</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-limit">Gas Limit</a></div><div class="base ancestor show link depth-1"><a href="/api/">Application Programming Interface</a></div><div class="show link depth-2"><a href="/api/contract/">Contracts</a></div><div class="hide link depth-3"><a href="/api/contract/#buckets">Buckets</a></div><div class="show link depth-2"><a href="/api/signer/">Signers</a></div><div class="hide link depth-3"><a href="/api/signer/#signer">Signer</a></div><div class="hide link depth-3"><a href="/api/signer/#wallet">Wallet</a></div><div class="hide link depth-3"><a href="/api/signer/#voidsigner">VoidSigner</a></div><div class="hide link depth-3"><a href="/api/signer/#externallyownedaccount">ExternallyOwnedAccount</a></div><div class="show link depth-2"><a href="/api/providers/">Providers</a></div><div class="hide link depth-3"><a href="/api/providers/provider/">Provider</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#accounts-methods">Accounts Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#blocks-methods">Blocks Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#ethereum-naming-service-(ens)-methods">Ethereum Naming Service (ENS) Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#logs-methods">Logs Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#network-status-methods">Network Status Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#transactions-methods">Transactions Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#event-emitter-methods">Event Emitter Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#inspection-methods">Inspection Methods</a></div><div class="hide link depth-3"><a href="/api/providers/jsonrpc-provider/">JsonRpcProvider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcsigner">JsonRpcSigner</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcuncheckedsigner">JsonRpcUncheckedSigner</a></div><div class="hide link depth-3"><a href="/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#etherscanprovider">EtherscanProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#infuraprovider">InfuraProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#alchemyprovider">AlchemyProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#cloudfrontprovider">CloudfrontProvider</a></div><div class="hide link depth-3"><a href="/api/providers/other/">Other Providers</a></div><div class="hide link depth-4"><a href="/api/providers/other/#fallbackprovider">FallbackProvider</a></div><div class="hide link depth-4"><a href="/api/providers/other/#ipcprovider">IpcProvider</a></div><div class
|
||
|
|
<a name="utils-transactions"></a><a name="transactions"></a><h1 class="show-anchors"><div>Transactions<div class="anchors"><a class="self" href="#utils-transactions"></a></div></div></h1>
|
||
|
|
|
||
|
|
<a name="types"></a><h2 class="show-anchors"><div>Types<div class="anchors"><a class="self" href="#types"></a></div></div></h2>
|
||
|
|
|
||
|
|
<a name="types-unsignedtransaction"></a><a name="unsignedtransaction"></a><h3 class="show-anchors"><div>UnsignedTransaction<div class="anchors"><a class="self" href="#types-unsignedtransaction"></a></div></div></h3>
|
||
|
|
<p>An unsigned transaction represents a transaction that has not been signed.</p>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">to</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="/api/utils/address/#address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">nonce</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">gasLimit</span> <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">gasPrice</span> <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">data</span> <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/bytes/#byteslike">BytesLike</a></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">value</span> <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">chainId</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<a name="types-transaction"></a><a name="transaction"></a><h3 class="show-anchors"><div>Transaction<div class="anchors"><a class="self" href="#types-transaction"></a></div></div></h3>
|
||
|
|
<p>A generic object to represent a transaction.</p>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">hash</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="/api/utils/bytes/#datahexstring">DataHexstring</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">to</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="/api/utils/address/#address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">from</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="/api/utils/address/#address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">nonce</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">gasLimit</span> <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">gasPrice</span> <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">data</span> <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/bytes/#byteslike">BytesLike</a></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">value</span> <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">chainId</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">r</span> <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/bytes/#byteslike">BytesLike</a></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">s</span> <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/bytes/#byteslike">BytesLike</a></span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span> . <span class="method">v</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p></p></div></div>
|
||
|
|
<a name="functions"></a><h2 class="show-anchors"><div>Functions<div class="anchors"><a class="self" href="#functions"></a></div></div></h2>
|
||
|
|
|
||
|
|
<a name="utils-computeaddress"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span> . <span class="path">utils</span> . <span class="method">computeAddress</span> ( <span class="param">publicOrPrivateKey</span> ) <span class="arrow">⇒</span> <span class="returns">string< <a href="/api/utils/address/#address">Address</a> ></span><div class="anchors"><a class="self" href="#utils-computeaddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/transactions/src.ts/index.ts#L75">source</a></div></div><div class="body"><p>Compute the address of <i>publicOrPrivateKey</i>. If a public key is provided, it may be either compressed or uncompressed.</p></div></div>
|
||
|
|
<a name="utils-parse"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span> . <span class="path">utils</span> . <span class="method">parse</span> ( <span class="param">aBytesLike</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/transactions/#types-transaction">Transaction</a></span><div class="anchors"><a class="self" href="#utils-parse"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/transactions/src.ts/index.ts#L145">source</a></div></div><div class="body"><p>Parses the transaction properties from a serialized transactions.</p></div></div>
|
||
|
|
<a name="utils-recoveraddress"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span> . <span class="path">utils</span> . <span class="method">recoverAddress</span> ( <span class="param">digest</span> , <span class="param">aSignatureLike</span> ) <span class="arrow">⇒</span> <span class="returns">string< <a href="/api/utils/address/#address">Address</a> ></span><div class="anchors"><a class="self" href="#utils-recoveraddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/transactions/src.ts/index.ts#L80">source</a></div></div><div class="body"><p>Computes the address that signed <i>digest</i> to get <i>aSignatureLike</i> using the ecrecover algorithm.</p></div></div>
|
||
|
|
<a name="utils-serialize"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span> . <span class="path">utils</span> . <span class="method">serialize</span> ( <span class="param">transaction</span> [ , <span class="param">signature</span> ] ) <span class="arrow">⇒</span> <span class="returns">string< <a href="/api/utils/bytes/#datahexstring">DataHexstring</a> ></span><div class="anchors"><a class="self" href="#utils-serialize"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/transactions/src.ts/index.ts#L85">source</a></div></div><div class="body"><p>Computes the serialized <i>transaction/, optionally signed with </i>signature//. If signature is not presented, the unsigned serialized transaction is returned, which can be used to compute the hash necessary to sign.</p><p>This function uses EIP-155 if a chainId is provided, otherwise legacy serialization is used. It is <b>highly</b> recommended to always specify a <i>chainId</i>.</p></div></div><div class="footer"><div class="nav previous"><a href="/api/utils/strings/"><span class="arrow">←</span>Strings</a></div> <div class="nav next"><a href="/api/other/">Other Libraries<span class="arrow">→</span></a></div></div><div class="copyright">The content of this site is licensed under the <a href="https://choosealicense.com/licenses/cc-by-4.0/">Creative Commons Attribution 4.0 International License</a>.</div></div><script src="/script.js" type="text/javascript"></script></body></html><!-- ContentHash:131c0b6295d573abf14c576c430b849cc344adf42f30cdb1866b5958502b1173 -->
|