哈希算法

在整个区块链空间中使用了许多哈希算法,对于一些复杂的用法可以使用utilities工具来简化这些操作。

加密哈希函数

加密哈希函数是一个特定的哈希函数家族。

ethers.utils.id( text ) string< DataHexString< 32 > >

以太坊身份函数(Ethereum Identity function)计算文本字节KECCAK256哈希值。

ethers.utils.keccak256( aBytesLike ) string< DataHexString< 32 > >

返回aBytesLikeKECCAK256摘要(digest)。

ethers.utils.ripemd160( aBytesLike ) string< DataHexString< 20 > >

返回aBytesLikeRIPEMD-160摘要(digest)。

ethers.utils.sha256( aBytesLike ) string< DataHexString< 32 > >

返回aBytesLikeSHA2-256摘要(digest)。

ethers.utils.sha512( aBytesLike ) string< DataHexString< 64 > >

返回aBytesLikeSHA2-512摘要(digest)。

KECCAK256
utils.keccak256([ 0x12, 0x34 ]) // '0x56570de287d73cd1cb6092bb8fdee6173974955fdef345ae579ee9f475ea7432' utils.keccak256("0x") // '0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470' utils.keccak256("0x1234") // '0x56570de287d73cd1cb6092bb8fdee6173974955fdef345ae579ee9f475ea7432' // value 必须是 data,比如: // - numbers数组 // - 十六进制字符串 (如 "0x1234") // - Uint8Array // 不要使用非十六进制的 UTF-8 字符串 utils.keccak256("hello world") // [Error: invalid arrayify value] { // argument: 'value', // code: 'INVALID_ARGUMENT', // reason: 'invalid arrayify value', // value: 'hello world' // } // 如果确实要使用非十六进制的 UTF-8 字符串,请先转换成字节(bytes): utils.keccak256(utils.toUtf8Bytes("hello world")) // '0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad' // 等价于使用身份函数(identity function): utils.id("hello world") // '0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad' // 请记住字符串 "0x1234" 表示两个字节(即 [ 0x12, 0x34 ]. If you wish to compute the // 如果你想要计算6个字符("0x1234")的哈希,请先通过utils.toUtf8Bytes转换成 UTF-8 字节 // 参考下述例子: // 2个字节的哈希 utils.keccak256("0x1234") // '0x56570de287d73cd1cb6092bb8fdee6173974955fdef345ae579ee9f475ea7432' // 2个字节的哈希,与上结果相同 utils.keccak256([ 0x12, 0x34 ]) // '0x56570de287d73cd1cb6092bb8fdee6173974955fdef345ae579ee9f475ea7432' bytes = utils.toUtf8Bytes("0x1234") // Uint8Array [ 48, 120, 49, 50, 51, 52 ] // 6个字符的哈希,与上结果不同 utils.keccak256(bytes) // '0x1ac7d1b81b7ba1025b36ccb86723da6ee5a87259f1c2fd5abe69d3200b512ec8' // 6个字符的哈希 utils.id("0x1234") // '0x1ac7d1b81b7ba1025b36ccb86723da6ee5a87259f1c2fd5abe69d3200b512ec8'
RIPEMD160
utils.ripemd160("0x") // '0x9c1185a5c5e9fc54612808977ee8f548b2258d31' utils.ripemd160("0x1234") // '0xc39867e393cb061b837240862d9ad318c176a96d'
SHA-2
utils.sha256("0x") // '0xe3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' utils.sha256("0x1234") // '0x3a103a4e5729ad68c02a678ae39accfbc0ae208096437401b7ceab63cca0622f' utils.sha512("0x") // '0xcf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e' utils.sha512("0x1234") // '0x4c54886c9821195522d88ff4705c3e0c686b921054421e6ea598739c29c26e1ee75419aaceec94dd2e3c0dbb82ecf895c9f61215f375de6d800d9b99d3d4b816'

HMAC

ethers.utils.computeHmac( algorithm , key , data ) string< DataHexString >

使用Algorithm算法返回 带有key的 HMACdata数据。

HMAC Supported Algorithms

ethers.utils.SupportedAlgorithm.sha256 string

使用SHA2-256哈希算法。

ethers.utils.SupportedAlgorithm.sha512 string

使用SHA2-512哈希算法。

HMAC
const key = "0x0102" const data = "0x1234" utils.computeHmac("sha256", key, data) // '0x7553df81c628815cf569696cad13a37c606c5058df13d9dff4fee2cf5e9b5779'

Hashing Helpers

ethers.utils.hashMessage( message ) string< DataHexString< 32 > >

计算messageEIP-191个人信息摘要。 个人消息被转换为UTF-8字节,并以\x19Ethereum Signed Message:message的length为前缀。

Hashing Messages
// 对字符串信息进行哈希 utils.hashMessage("Hello World") // '0xa1de988600a42c4b4ab089b619297c17d53cffae5d5120d82d8a92d0bb3b78f2' // 对二进制数据进行哈希 (以下是字节类型的"Hello World") utils.hashMessage( [ 72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100 ]) // '0xa1de988600a42c4b4ab089b619297c17d53cffae5d5120d82d8a92d0bb3b78f2' // 注意:理解字符串和二进制数据的不同处理方式是很重要的 // 字符串总是作为字符串形式的字节进行处理,所以必须首先将十六进制字符串转换为类似数组的对象 //首先转换为类数组对象。 // 对一个十六进制字符串哈希等同于对字符串直接哈希 // 注意: 这是对4个字符 [ '0', 'x', '4', '2' ] 进行哈希 utils.hashMessage("0x42") // '0xf0d544d6e4a96e1c08adc3efabe2fcb9ec5e28db1ad6c33ace880ba354ab0fce' // 对二进制数据进行哈希 // 注意: 这是对一个字节 [ 0x42 ] 进行哈希 utils.hashMessage([ 0x42 ]) // '0xd18c12b87124f9ceb7e1d3a5d06a5ac92ecab15931417e8d1558d9a263f99d63' // 对二进制数据进行哈希 // 注意: 这也等同于对一个字节 [ 0x42 ] 进行哈希 utils.hashMessage(utils.arrayify("0x42")) // '0xd18c12b87124f9ceb7e1d3a5d06a5ac92ecab15931417e8d1558d9a263f99d63'
ethers.utils.namehash( name ) string< DataHexString< 32 > >

返回ENS Namehashname

Namehash
utils.namehash("") // '0x0000000000000000000000000000000000000000000000000000000000000000' utils.namehash("eth") // '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae' utils.namehash("ricmoo.firefly.eth") // '0x0bcad17ecf260d6506c6b97768bdc2acfb6694445d27ffd3f9c1cfbee4a9bd6d' utils.namehash("ricmoo.xyz") // '0x7d56aa46358ba2f8b77d8e05bcabdd2358370dcf34e87810f8cea77ecb3fc57d'

Typed Data Encoder

TypedDataEncoder用于计算EIP-712签名的各种编码数据。

签名数据需要域(domain)、结构成员列表和数据本身。

domain是一个具有任何标准域属性值的对象。

types是一个对象,每个属性都是一个结构的名称,映射到一个字段描述数组。 它不应该包含EIP712Domain属性,除非它需要作为另一个签名数据的子结构。

实验特性 (导出的类名将会改变)

这是一个实验特性。如果你要使用,请指定 ethers 确切的版本 (例如指定"5.0.18", 而不是 "^5.0.18") 一旦它在字段中被使用,导出的类名将_TypedDataEncoder重命名为TypedDataEncoder

ethers.utils._TypedDataEncoder.from( types ) [TypedDataEncoder]

types创建一个新的TypedDataEncoder。 这个对象是一个相当低级的对象,大多数开发人员不应该直接使用实例。

大多数开发人员会发现下面的静态类方法更有用。

TypedDataEncoder.encode( domain , types , values ) string

编码并返回经过哈希处理的EIP-712 domain。

TypedDataEncoder.getPayload( domain , types , value ) any

返回各种JSON-RPC eth_signTypedData*调用所使用的标准payload。

domain和value的值都会被标准化(normalized),并对types的内容进行验证。

TypedDataEncoder.getPrimaryType( types ) string

构造一个types的有向无环图并返回root type,root type可以用作EIP-712payloads的primaryType

TypedDataEncoder.hash( domain , types , values ) string< DataHexString< 32 > >

返回计算后的EIP-712哈希。

TypedDataEncoder.hashDomain( domain ) string< DataHexString< 32 > >

返回EIP-712 domain的哈希。

TypedDataEncoder.resolveNames( domain , types , value , resolveName ) Promise< any >

返回value的副本,其中任何具有地址(address)类型的leaf value都将被递归地替换为value的resolveName调用的值。

Typed Data 例子
domain = { name: 'Ether Mail', version: '1', chainId: 1, verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC' }; // 所有types定义的name列表 types = { Person: [ { name: 'name', type: 'string' }, { name: 'wallet', type: 'address' } ], Mail: [ { name: 'from', type: 'Person' }, { name: 'to', type: 'Person' }, { name: 'contents', type: 'string' } ] }; // 待签名的数据 value = { from: { name: 'Cow', wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826' }, to: { name: 'Bob', wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB' }, contents: 'Hello, Bob!' }; TypedDataEncoder.encode(domain, types, value) // '0x1901f2cee375fa42b42143804025fc449deafd50cc031ca257e0b194a650a912090fc52c0ee5d84264471806290a3f2c4cecfc5490626bf912d01f240d7a274b371e' TypedDataEncoder.getPayload(domain, types, value) // { // domain: { // chainId: '1', // name: 'Ether Mail', // verifyingContract: '0xcccccccccccccccccccccccccccccccccccccccc', // version: '1' // }, // message: { // contents: 'Hello, Bob!', // from: { // name: 'Cow', // wallet: '0xcd2a3d9f938e13cd947ec05abc7fe734df8dd826' // }, // to: { // name: 'Bob', // wallet: '0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb' // } // }, // primaryType: 'Mail', // types: { // EIP712Domain: [ // { // name: 'name', // type: 'string' // }, // { // name: 'version', // type: 'string' // }, // { // name: 'chainId', // type: 'uint256' // }, // { // name: 'verifyingContract', // type: 'address' // } // ], // Mail: [ // { // name: 'from', // type: 'Person' // }, // { // name: 'to', // type: 'Person' // }, // { // name: 'contents', // type: 'string' // } // ], // Person: [ // { // name: 'name', // type: 'string' // }, // { // name: 'wallet', // type: 'address' // } // ] // } // } TypedDataEncoder.getPrimaryType(types) // 'Mail' TypedDataEncoder.hash(domain, types, value) // '0xbe609aee343fb3c4b28e1df9e632fca64fcfaede20f02e86244efddf30957bd2' TypedDataEncoder.hashDomain(domain) // '0xf2cee375fa42b42143804025fc449deafd50cc031ca257e0b194a650a912090f'

Solidity 哈希算法

当使用Solidity abi.packEncoded(...)函数时,将使用非标准(non-standard)的紧密打包(tightly packed)的编码版本。 这些函数实现了紧密打包算法(tightly packing algorithm)。

ethers.utils.solidityPack( types , values ) string< DataHexString >

返回types中对应类型打包的非标准编码值。

ethers.utils.solidityKeccak256( types , values ) string< DataHexString< 32 > >

返回types中对应类型打包的非标准编码KECCAK256值。

ethers.utils.soliditySha256( types , values ) string< DataHexString< 32 > >

返回types中对应类型打包的非标准编码SHA2-256值。

Solidity 哈希
utils.solidityPack([ "int16", "uint48" ], [ -1, 12 ]) // '0xffff00000000000c' utils.solidityPack([ "string", "uint8" ], [ "Hello", 3 ]) // '0x48656c6c6f03' utils.solidityKeccak256([ "int16", "uint48" ], [ -1, 12 ]) // '0x81da7abb5c9c7515f57dab2fc946f01217ab52f3bd8958bc36bd55894451a93c' utils.soliditySha256([ "int16", "uint48" ], [ -1, 12 ]) // '0xa5580fb602f6e2ba9c588011dc4e6c2335e0f5d970dc45869db8f217efc6911a' // 作为一个简单的例子,说明了solid 紧密打包不具有区分度(这就是为什么从安全的角度来看它对很多事情都不合适), // 下面的例子打包输出的结果是相同的,尽管它们表示的值和布局都不同。 utils.solidityPack([ "string", "string" ], [ "hello", "world01" ]) // '0x68656c6c6f776f726c643031' utils.solidityPack([ "string", "string" ], [ "helloworld", "01" ]) // '0x68656c6c6f776f726c643031' utils.solidityPack([ "string", "string", "uint16" ], [ "hell", "oworld", 0x3031 ]) // '0x68656c6c6f776f726c643031' utils.solidityPack([ "uint96" ], [ "32309054545061485574011236401" ]) // '0x68656c6c6f776f726c643031'