crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added documentation for additional parameters

Browse Source
This commit is contained in:
Jan-Gerrit Harms
2019-07-30 15:18:08 +02:00
parent 3e88f820b8
commit 11e2fc5bc4
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
packages/order-utils/src/signature_utils.ts
View File

@@ -31,6 +31,7 @@ export const signatureUtils = {
* @param signature A hex encoded 0x Protocol signature made up of: [TypeSpecificData][SignatureType].
* E.g [vrs][SignatureType.EIP712]
* @param signerAddress The hex encoded address that signed the data, producing the supplied signature.
* @param signatureValidationOpts Optional additional information to pass to signature validation functions.
* @return Whether the signature is valid for the supplied signerAddress and data.
*/
async isValidSignatureAsync(
@@ -103,6 +104,7 @@ export const signatureUtils = {
* @param supportedProvider Web3 provider to use for all JSON RPC requests
* @param data The hex encoded data signed by the supplied signature
* @param signerAddress The hex encoded address that signed the data, producing the supplied signature.
* @param exchangeAddress The address of the Exchange contract to validate the signature against.
* @return Whether the data was preSigned by the supplied signerAddress
*/
async isValidPresignedSignatureAsync(
@@ -159,6 +161,7 @@ export const signatureUtils = {
* @param data The hex encoded data signed by the supplied signature.
* @param signature A hex encoded presigned 0x Protocol signature made up of: [SignatureType.Presigned]
* @param signerAddress The hex encoded address that signed the data, producing the supplied signature.
* @param exchangeAddress The address of the Exchange contract to validate the signature against.
* @return Whether the data was preSigned by the supplied signerAddress.
*/
async isValidValidatorSignatureAsync(