24 lines
15 KiB
HTML
24 lines
15 KiB
HTML
<html><head><title>Hashing</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-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-inherits-signer">Wallet inherits Signer</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/">JSON-RPC Provider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcprovider">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/#nodesmithprovider">NodesmithProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#alchemyprovider">AlchemyProvider</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="hide link depth-3"><a href="/api/providers/types/">Types</a></div><div class="hide link depth-4"><a href="/api/providers/types/#blocks">Blocks</a></div><div class="hide link depth-4"><a href="/api/providers/types/#events-and-logs">Events and Logs</a></div><div class="hide link depth-4"><a href="/api/providers/types/#transactions">Transactions</a></div><div class="ancestor show link depth-2"><a href="/api/utils/">Utilities</a></div><div class="show link depth-3"><a href="/api/utils/address/">Addresses</a></div><div class="show link depth-3"><a href="/api/utils/bignumber/">BigNumber</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#creating-instances">Creating Instances</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#methods">Methods</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#notes">Notes</a></div><div class="show link depth-3"><a href="/api/utils/bytes/">Byte Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#inspection">Inspection</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#converting-between-arrays-and-hexstrings">Converting between Arrays and Hexstrings</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#array-manipulation">Array Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#hexstring-manipulation">Hexstring Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#signature-conversion">Signature Conversion</a></div><div class="show link depth-3"><a href="/api/utils/constants/">Constants</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#bytes">Bytes</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#strings">Strings</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#bignumber">BigNumber</a></div><div class="show link depth-3"><a href="/api/utils/display-logic/">Display Logic and Input</a></div><div class="hide link depth-4"><a href="/api/utils/display-logic/#units">Units</a></div><div class="hide link depth-4"><a href="/api/utils/display-logic/#functions">Functions</a></div><div class="show link depth-3"><a href="/api/utils/fixednumber/">FixedNumber</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#creating-instances">Creating Instances</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#properties">Properties</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#methods">Methods</a></div><div class="myself ancestor ancestor show link depth-3"><a href="/api/utils/hashing/">Hashing Algorithms</a></div><div class="child link depth-4"><a href="/api/utils/hashing/#cryptographic-hashing">Cryptographic Hashing</a></div><div class="child link depth-4"><a href="/api/utils/hashing/#common-hashing-helpers">Common Hashing Helpers</a></div><div class="child link depth-4"><a href="/api/utils/hashing/#solidity-hashing-algorithms">Solidity Hashing Algorithms</a></div><div class="show link depth-3"><a href="/api/utils/strings/">Strings</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#bytes32string">Bytes32String</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#utf-8-strings">UTF-8 Strings</a></div><div class="base show link depth-1"><a href="/cookbook/">Cookbook</a></div><div class="base show link depth-1"><a href="/migration/">Migration Guide</a></div><div class="hide link depth-2"><a href="/migration/#from-web3">From Web3</a></div><div class="hide link depth-2"><a href="/migration/#from-ethers-v4">From ethers v4</a></div><div class="base show link depth-1"><a href="/testing/">Testing</a></div><div class="base show link depth-1"><a href="/contributing/">Contributing and Hacking</a></div><div class="hide link depth-2"><a href="/contributing/#building">Building</a></div><div class="base show link depth-1"><a href="/documentation/">Flatworm Docs</a></div><div class="hide link depth-2"><a href="/documentation/#fragments">Fragments</a></div><div class="hide link depth-2"><a href="/documentation/#markdown">Markdown</a></div><div class="base show link depth-1"><a href="/license/">License and Copyright</a></div></div></div></div><div class="content"><div class="breadcrumbs"><a href="/">Documentation</a> » <a href="/api/">Application Programming Interface</a> » <a href="/api/utils/">Utilities</a> » <span class="current">Hashing</span></div>
|
|
<a name="hashing-algorithms"></a><h1>Hashing Algorithms</h1>
|
|
<p>Explain what hash functions are?</p>
|
|
<a name="cryptographic-hashing"></a><h2>Cryptographic Hashing</h2>
|
|
<p>The <a href="https://en.wikipedia.org/wiki/Cryptographic_hash_function">Cryptographic Hash Functions</a> are a specific family of hash functions.</p>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">keccak256</span> ( <span class="param">aBytesLike</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns the <a href="https://en.wikipedia.org/wiki/SHA-3">KECCAK256</a> digest <i>aBytesLike</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">ripemd160</span> ( <span class="param">aBytesLike</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns the <a href="https://en.m.wikipedia.org/wiki/RIPEMD">RIPEMD-160</a> digest of <i>aBytesLike</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">sha256</span> ( <span class="param">aBytesLike</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns the <a href="https://en.wikipedia.org/wiki/SHA-2">SHA2-256</a> digest of <i>aBytesLike</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">sha512</span> ( <span class="param">aBytesLike</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns the <a href="https://en.wikipedia.org/wiki/SHA-2">SHA2-512</a> digest of <i>aBytesLike</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">computeHmac</span> ( <span class="param">algorithm</span> , <span class="param">key</span> , <span class="param">data</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns the <a href="https://en.wikipedia.org/wiki/HMAC">HMAC</a> of <i>data</i> with <i>key</i> using the <a href="/api/utils/hashing/#supported-algorithm">Algorithm</a> <i>algorithm</i>.</p></div></div>
|
|
<a name="supported-algorithm"></a><a name="hmac-supported-algorithms"></a><h3>HMAC Supported Algorithms</h3>
|
|
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="path">SupportedAlgorithms</span> . <span class="method">sha256</span></div><div class="body"><p>Use the <a href="https://en.wikipedia.org/wiki/SHA-2">SHA2-256</a> hash algorithm.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="path">SupportedAlgorithms</span> . <span class="method">sha512</span></div><div class="body"><p>Use the <a href="https://en.wikipedia.org/wiki/SHA-2">SHA2-512</a> hash algorithm.</p></div></div>
|
|
<a name="common-hashing-helpers"></a><h2>Common Hashing Helpers</h2>
|
|
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">hashMessage</span> ( <span class="param">message</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Computes the Ethereum message digest of <i>message</i>. Ethereum messages are converted to UTF-8 bytes and prefixed with <code class="inline">x19Ethereum Signed Message:</code> and the length of <i>message</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">id</span> ( <span class="param">text</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>The Ethereum Identity function computs the keccak256 hash of the <i>text</i> bytes.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">namehash</span> ( <span class="param">name</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns the <a href="https://docs.ens.domains/contract-api-reference/name-processing#hashing-names">ENS Namehash</a> of <i>name</i>.</p></div></div>
|
|
<a name="solidity-hashing-algorithms"></a><h2>Solidity Hashing Algorithms</h2>
|
|
<p>When using the Solidity <code class="inline">abi.packEncoded(...)</code> function, a non-standard <i>tightly packed</i> version of encoding is used. These functions implement the tightly packing algorithm.</p>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">solidityPack</span> ( <span class="param">arrayOfTypes</span> , <span class="param">arrayOfValues</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns the non-standard encoded <i>arrayOfValues</i> packed according to their respecive type in <i>arrayOfTypes</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">solidityKeccak256</span> ( <span class="param">arrayOfTypes</span> , <span class="param">arrayOfValues</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns the KECCAK256 of the non-standard encoded <i>arrayOfValues</i> packed according to their respective type in <i>arrayOfTypes</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">utils</span> . <span class="method">soliditySha256</span> ( <span class="param">arrayOfTypes</span> , <span class="param">arrayOfValues</span> ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns the SHA2-256 of the non-standard encoded <i>arrayOfValues</i> packed according to their respective type in <i>arrayOfTypes</i>.</p></div></div><div class="footer"><div class="nav previous"><a href="/api/utils/fixednumber/"><span class="arrow">←</span>FixedNumber</a></div> <div class="nav next"><a href="/api/utils/strings/">Strings<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:885e1ee0fab58b8e56750d5b3bb6ad32269314e5dba2dd2b9698f9e1ca2c0b96 --> |