ethers.js/docs.wrm/api/utils/abi/coder.wrm

49 lines
1.9 KiB
Plaintext
Raw Normal View History

2020-06-12 10:38:55 +03:00
_section: AbiCoder @<AbiCoder> @SRC<abi:class.AbiCoder>
The **AbiCoder** 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.
Most developers will never need to use this class directly, since
the [[Interface]] class greatly simplifies these operations.
_subsection: Creating Instance @<AbiCoder--creating>
For the most part, there should never be a need to manually create
an instance of an [[AbiCoder]], since one is created with the
2020-10-03 19:30:15 +03:00
default coercion function when the library is loaded which can
2020-06-12 10:38:55 +03:00
be used universally.
This is likely only needed by those with specific needs to override
how values are coerced after they are decoded from their binary format.
_property: new ethers.utils.AbiCoder([coerceFunc]) @SRC<abi:constructor.AbiCoder>
Create a new AbiCoder instance, which will call the //coerceFunc// on every
decode, where the result of the call will be used in the Result.
The function signature is `(type, value)`, where the //type// is the string
describing the type and the //value// is the processed value from the underlying
Coder.
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.
_property: ethers.utils.defaultAbiCoder => [[AbiCoder]]
An [[AbiCoder]] created when the library is imported which is used by
the [[Interface]].
_subsection: Coding Methods @<AbiCoder--methods>
_property: abiCoder.encode(types, values) => string<[[DataHexString]]> @<AbiCoder-encode> @SRC<abi/abi-coder>
2020-11-23 07:03:50 +03:00
Encode the array //values// according to the array of //types//, each of which may be a
2020-06-12 10:38:55 +03:00
string or a [[ParamType]].
_property: abiCoder.decode(types, data) => [[Result]] @<AbiCoder-decode> @SRC<abi/abi-coder>
Decode the //data// according to the array of //types//, each of which may be a
string or [[ParamType]].