tornado-packages/ethers.js

Fork 1

Richard Moore 184c459fab

Updating docs.

2019-12-13 22:05:10 -05:00

5.0 KiB

Raw Blame History

Documentation: html

Byte Manipulation

Tra la la...

Types

Bytes

A Bytes is any object which is an Array or TypedArray with each value in the valid byte range (i.e. between 0 and 255 inclusive), or is an Object with a length property where each indexed property is in the valid byte range.

BytesLike

A BytesLike can be either a Bytes or a DataHexstring.

DataHexstring

A DataHexstring is identical to a Hexstring except that it has an even number of nibbles, and therefore is a valid representation of binary data as a string.

Hexstring

A hexstring is a string which has a 0x prefix followed by any number of nibbles (i.e. case-insensitive hexidecumal characters, 0-9 and a-f).

Signature

r and s --- The x co-ordinate of r and the s value of the signature
v --- The parity of the y co-ordinate of r
_vs --- The compact representation of the (r, s) and v
recoveryParam --- The normalized (i.e. 0 or 1) value of v

SignatureLike

A SignatureLike is similar to a Signature, except redundant properties may be omitted.

For example, if _vs is specified, s and v may be omitted. Likewise, if recoveryParam is provided, v may be omitted (as in these cases the missing values can be computed).

Inspection

utils . isBytes ( object ) => boolean

Returns true if and only if object is a valid Bytes.

utils . isBytesLike ( object ) => boolean

Returns true if and only if object is a Bytes or DataHexstring.

utils . isHexString ( object , [ length ] ) => boolean

Returns true if and only if object is a valid hex string. If length is specified and object is not a valid DataHexstring of length bytes, an InvalidArgument error is thrown.

Converting between Arrays and Hexstrings

utils . arrayify ( datahexstringOrArrayish [ , options ] ) => Uint8Array

Converts datahexstringOrArrayish to a Uint8Array.

utils . hexlify ( hexstringOrArrayish ) => string

Converts hexstringOrArrayish to a DataHexstring.

utils . hexValue ( aBigNumberish ) => string

Converts aBigNumberish to a Hexstring, with no unnecessary leading zeros.

Examples

Skipping JavaScript Evaluation.

Array Manipulation

utils . concat ( arrayOfBytesLike ) => Uint8Array

Concatenates all the BytesLike in arrayOfBytesLike into a single Uint8Array.

utils . stripZeros ( aBytesLike ) => Uint8Array

Returns a Uint8Array with all leading 0 bytes of aBtyesLike removed.

utils . zeroPad ( aBytesLike , length ) => Uint8Array

Retutns a Uint8Array of the data in aBytesLike with 0 bytes prepended to length bytes long.

If aBytesLike is already longer than length bytes long, an InvalidArgument error will be thrown.

Hexstring Manipulation

utils . hexConcat ( arrayOfBytesLike ) => DataHexstring

Concatenates all the BytesLike in arrayOfBytesLike into a single DataHexstring

utils . hexDataLength ( aBytesLike ) => DataHexstring

Returns the length (in bytes) of aBytesLike.

utils . hexDataSlice ( aBytesLike , offset [ , endOffset ] ) => DataHexstring

Returns a DataHexstring representation of a slice of aBytesLike, from offset (in bytes) to endOffset (in bytes). If endOffset is omitted, the length of aBytesLike is used.

utils . hexStripZeros ( aBytesLike ) => Hexstring

Returns a Hexstring representation of aBytesLike with all leading zeros removed.

utils . hexZeroPad ( aBytesLike , length ) => DataHexstring

Returns a DataHexstring representation of aBytesLike padded to length bytes.