51 lines
12 KiB
HTML
51 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html class="paged">
|
|
<head>
|
|
<title>AbiCoder</title>
|
|
<link rel="stylesheet" type="text/css" href="/v5/static/style.css">
|
|
</head>
|
|
<body>
|
|
<div class="sidebar">
|
|
<div class="header">
|
|
<div class="logo"><a href="/v5/"><div class="image"></div><div class="name">ethers</div><div class="version">v5.0</div></a></div>
|
|
</div>
|
|
<div class="toc"><div>
|
|
<div class="link title"><a href="/v5/">Documentation</a></div><div class="base show link depth-1"><a href="/v5/getting-started/">Getting Started</a></div><div class="base show link depth-1"><a href="/v5/concepts/">Ethereum Basics</a></div><div class="hide link depth-2"><a href="/v5/concepts/events/">Events</a></div><div class="hide link depth-2"><a href="/v5/concepts/gas/">Gas</a></div><div class="hide link depth-2"><a href="/v5/concepts/security/">Security</a></div><div class="base ancestor show link depth-1"><a href="/v5/api/">Application Programming Interface</a></div><div class="show link depth-2"><a href="/v5/api/contract/">Contract Interaction</a></div><div class="hide link depth-3"><a href="/v5/api/contract/contract/">Contract</a></div><div class="hide link depth-3"><a href="/v5/api/contract/contract-factory/">ContractFactory</a></div><div class="hide link depth-3"><a href="/v5/api/contract/example/">Example: ERC-20 Contract</a></div><div class="show link depth-2"><a href="/v5/api/signer/">Signers</a></div><div class="show link depth-2"><a href="/v5/api/providers/">Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/provider/">Provider</a></div><div class="hide link depth-3"><a href="/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></div><div class="hide link depth-3"><a href="/v5/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/other/">Other Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/types/">Types</a></div><div class="ancestor show link depth-2"><a href="/v5/api/utils/">Utilities</a></div><div class="ancestor show link depth-3"><a href="/v5/api/utils/abi/">Application Binary Interface</a></div><div class="myself ancestor ancestor show link depth-4"><a href="/v5/api/utils/abi/coder/">AbiCoder</a></div><div class="show link depth-4"><a href="/v5/api/utils/abi/formats/">ABI Formats</a></div><div class="show link depth-4"><a href="/v5/api/utils/abi/fragments/">Fragments</a></div><div class="show link depth-4"><a href="/v5/api/utils/abi/interface/">Interface</a></div><div class="show link depth-3"><a href="/v5/api/utils/address/">Addresses</a></div><div class="show link depth-3"><a href="/v5/api/utils/bignumber/">BigNumber</a></div><div class="show link depth-3"><a href="/v5/api/utils/bytes/">Byte Manipulation</a></div><div class="show link depth-3"><a href="/v5/api/utils/constants/">Constants</a></div><div class="show link depth-3"><a href="/v5/api/utils/display-logic/">Display Logic and Input</a></div><div class="show link depth-3"><a href="/v5/api/utils/encoding/">Encoding Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/fixednumber/">FixedNumber</a></div><div class="show link depth-3"><a href="/v5/api/utils/hashing/">Hashing Algorithms</a></div><div class="show link depth-3"><a href="/v5/api/utils/hdnode/">HD Wallet</a></div><div class="show link depth-3"><a href="/v5/api/utils/logger/">Logging</a></div><div class="show link depth-3"><a href="/v5/api/utils/properties/">Property Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/signing-key/">Signing Key</a></div><div class="show link depth-3"><a href="/v5/api/utils/strings/">Strings</a></div><div class="show link depth-3"><a href="/v5/api/utils/transactions/">Transactions</a></div><div class="show link depth-3"><a href="/v5/api/utils/web/">Web Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/wordlists/">Wordlists</a></div><div class="show link depth-2"><a href="/v5/api/other/">Other Libraries</a></div><div class="hide link depth-3"><a href="/v5/api/other/assembly/">Assembly</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/dialect/">Ethers ASM Dialect</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/api/">Utilities</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/ast/">Abstract Syntax Tree</a></div><div class="hide link depth-3"><a href="/v5/api/other/hardware/">Hardware Wallets</a></div><div class="show link depth-2"><a href="/v5/api/experimental/">Experimental</a></div><div class="base show link depth-1"><a href="/v5/cli/">Command Line Interfaces</a></div><div class="hide link depth-2"><a href="/v5/cli/ethers/">Sandbox Utility</a></div><div class="hide link depth-2"><a href="/v5/cli/asm/">Assembler</a></div><div class="hide link depth-2"><a href="/v5/cli/ens/">Ethereum Naming Service</a></div><div class="hide link depth-2"><a href="/v5/cli/typescript/">TypeScript</a></div><div class="hide link depth-2"><a href="/v5/cli/plugin/">Making Your Own</a></div><div class="base show link depth-1"><a href="/v5/cookbook/">Cookbook</a></div><div class="base show link depth-1"><a href="/v5/migration/">Migration Guide</a></div><div class="hide link depth-2"><a href="/v5/migration/web3/">Migration: From Web3.js</a></div><div class="hide link depth-2"><a href="/v5/migration/ethers-v4/">Migration: From Ethers v4</a></div><div class="base show link depth-1"><a href="/v5/testing/">Testing</a></div><div class="base show link depth-1"><a href="/v5/contributing/">Contributing and Hacking</a></div><div class="base show link depth-1"><a href="/v5/documentation/">Flatworm Docs</a></div><div class="base show link depth-1"><a href="/v5/license/">License and Copyright</a></div>
|
|
</div></div>
|
|
</div>
|
|
<div class="content">
|
|
<div class="breadcrumbs"><a href="/v5/">Documentation</a> » <a href="/v5/api/">API</a> » <a href="/v5/api/utils/">Utilities</a> » <a href="/v5/api/utils/abi/">ABI</a> » <span class="current">AbiCoder</span></div>
|
|
|
|
<a name="AbiCoder"></a><a name="AbiCoder"></a><h1 class="show-anchors"><div>AbiCoder<div class="anchors"><a class="self" href="/v5/api/utils/abi/coder/#AbiCoder"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/abi-coder.ts#L32">source</a></div></div></h1><p>The <b>AbiCoder</b> is a collection of Coders which can be used to encode and decode the binary data formats used to interoperate between the EVM and higher level libraries.</p>
|
|
|
|
<p>Most developers will never need to use this class directly, since the <a href="/v5/api/utils/abi/interface/">Interface</a> class greatly simplifies these operations.</p>
|
|
|
|
<a name="AbiCoder--creating"></a><a name="AbiCoder--AbiCoder--creating"></a><h2 class="show-anchors"><div>Creating Instance<div class="anchors"><a class="self" href="/v5/api/utils/abi/coder/#AbiCoder--creating"></a></div></div></h2><p>For the most part, there should never be a need to manually create an instance of an <a href="/v5/api/utils/abi/coder/">AbiCoder</a>, since one is created with the default coersion function when the library is loaded which can be used universally.</p>
|
|
|
|
<p>This is likely only needed by those with specific needs to override how values are coerced after they are decoded from their binary format.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">AbiCoder</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">coerceFunc</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/abi-coder.ts#L35">source</a></div></div><div class="body"><p>Create a new AbiCoder instance, which will call the <i>coerceFunc</i> on every decode, where the result of the call will be used in the Result.</p>
|
|
|
|
<p>The function signature is `(type, value)`, where the <i>type</i> is the string describing the type and the <i>value</i> is the processed value from the underlying Coder.</p>
|
|
|
|
<p>If the callback throws, the Result will contain a property that when accessed will throw, allowing for higher level libraries to recover from data errors.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">defaultAbiCoder</span> <span class="arrow">⇒</span> <span class="returns"><a href="/v5/api/utils/abi/coder/">AbiCoder</a></span><div class="anchors"></div></div><div class="body"><p>An <a href="/v5/api/utils/abi/coder/">AbiCoder</a> created when the library is imported which is used by the <a href="/v5/api/utils/abi/interface/">Interface</a>.</p>
|
|
|
|
</div></div><a name="AbiCoder--methods"></a><a name="AbiCoder--AbiCoder--methods"></a><h2 class="show-anchors"><div>Coding Methods<div class="anchors"><a class="self" href="/v5/api/utils/abi/coder/#AbiCoder--methods"></a></div></div></h2>
|
|
<a name="AbiCoder-encode"></a><div class="property show-anchors"><div class="signature"><span class="path">abiCoder</span><span class="symbol">.</span><span class="method">encode</span><span class="symbol">(</span> <span class="param">types</span> <span class="symbol">,</span> <span class="param">values</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="/v5/api/utils/bytes/#DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="/v5/api/utils/abi/coder/#AbiCoder-encode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/abi-coder.ts#L94">source</a></div></div><div class="body"><p>Encode the array <i>values</i> according the array of <i>types</i>, each of which may be a string or a <a href="/v5/api/utils/abi/fragments/#ParamType">ParamType</a>.</p>
|
|
|
|
</div></div><a name="AbiCoder-decode"></a><div class="property show-anchors"><div class="signature"><span class="path">abiCoder</span><span class="symbol">.</span><span class="method">decode</span><span class="symbol">(</span> <span class="param">types</span> <span class="symbol">,</span> <span class="param">data</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="/v5/api/utils/abi/interface/#Result">Result</a></span><div class="anchors"><a class="self" href="/v5/api/utils/abi/coder/#AbiCoder-decode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/abi-coder.ts#L110">source</a></div></div><div class="body"><p>Decode the <i>data</i> according to the array of <i>types</i>, each of which may be a string or <a href="/v5/api/utils/abi/fragments/#ParamType">ParamType</a>.</p>
|
|
|
|
</div></div>
|
|
|
|
<div class="footer">
|
|
<div class="nav previous"><a href="/v5/api/utils/abi/"><span class="arrow">←</span>Application Binary Interface</a></div>
|
|
<div class="nav next"><a href="/v5/api/utils/abi/formats/">ABI Formats<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 License</a>. Generated on July 3, 2020, 1:44am.</div>
|
|
</div>
|
|
<script src="/v5/static/script.js" type="text/javascript"></script>
|
|
</body>
|
|
</html>
|