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

docs: Fix wrong method name for order signature generation (#128)

Browse Source 
Co-authored-by: Lawrence Forman <me@merklejerk.com>
This commit is contained in:
Lawrence Forman 2021-02-02 23:30:26 -05:00 committed by GitHub
parent f4e5b6e38d
commit 48f8bea460
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/basics/orders.rst
View File

@ -123,19 +123,27 @@ In both cases, the ``@0x/protocol-utils`` package simplifies generating these si
takerToken: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', // WETH takerToken: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', // WETH
... // Other fields ... // Other fields
}); });
// Generate an EIP712 signature // Generate an EthSign signature with a provider.
const signature = await order.eip712SignTypedDataWithProviderAsync( const signature = await order.getSignatureWithProviderAsync(
web3.currentProvider, web3.currentProvider,
makerAddress,
); );
// Generate an EthSign signature // Generate an EthSign signature with a private key.
const signature = await order.ethSignHashWithProviderAsync( const signature = await order.getSignatureWithKey(
'0x123456...', // Maker's 32-byte private key, in hex.
);
// Generate an EIP712 signature with a provider (e.g., metamask).
const signature = await order.getSignatureWithProviderAsync(
web3.currentProvider, web3.currentProvider,
makerAddress, utils.SignatureType.EIP712,
);
// Generate an EIP712 signature with a private key.
const signature = await order.getSignatureWithKey(
'0x123456...', // Maker's 32-byte private key, in hex.
utils.SignatureType.EIP712,
); );
The Orderbook The Orderbook
======================= =======================
Orders are shared through a decentralized and permissionless network, called `0x Mesh <https://0x.org/mesh>`_. The simplest way to post and discover orders is through `0x API <https://0x.org/api>`_. See `this guide <https://0x.org/docs/guides/market-making-on-0x>`_ tailored for Market Makers. Orders are shared through a decentralized and permissionless network, called `0x Mesh <https://0x.org/mesh>`_. The simplest way to post and discover orders is through `0x API <https://0x.org/api>`_. See `this guide <https://0x.org/docs/guides/market-making-on-0x>`_ tailored for Market Makers.
@ -167,4 +175,4 @@ A ``RFQOrder`` should be serialized to JSON as following:
"s": string, "s": string,
"r": string, "r": string,
} }
} }