Merge pull request #914 from 0xProject/feature/0x.js/ec-signature-string

0x.js Return signature as a hex encoded string

packages/0x.js/CHANGELOG.json

@@ -1,4 +1,13 @@
 [
+    {
+        "version": "1.0.1-rc.4",
+        "changes": [
+            {
+                "pr": 914,
+                "note": "Update ecSignOrderHashAsync to return the signature as a string for immediate use in contracts"
+            }
+        ]
+    },
     {
         "version": "1.0.1-rc.3",
         "changes": [

packages/0x.js/src/0x.ts

@@ -14,13 +14,12 @@ import {
     ecSignOrderHashAsync,
     generatePseudoRandomSalt,
     isValidSignatureAsync,
-    MessagePrefixOpts,
     orderHashUtils,
 } from '@0xproject/order-utils';
 // HACK: Since we export assetDataUtils from ZeroEx and it has AssetProxyId, ERC20AssetData and ERC721AssetData
 // in it's public interface, we need to import these types here.
 // tslint:disable-next-line:no-unused-variable
-import { AssetProxyId, ECSignature, ERC20AssetData, ERC721AssetData, Order, SignedOrder } from '@0xproject/types';
+import { AssetProxyId, ERC20AssetData, ERC721AssetData, Order, SignedOrder, SignerType } from '@0xproject/types';
 import { BigNumber } from '@0xproject/utils';
 import { Web3Wrapper } from '@0xproject/web3-wrapper';
 import { Provider, TransactionReceiptWithDecodedLogs } from 'ethereum-types';
@@ -238,19 +237,21 @@ export class ZeroEx {
      * @param   orderHash       Hex encoded orderHash to sign.
      * @param   signerAddress   The hex encoded Ethereum address you wish to sign it with. This address
      *          must be available via the Provider supplied to 0x.js.
-     * @param   MessagePrefixOpts  Options regarding the desired prefix and whether to add it before calling `eth_sign`
-     * @return  An object containing the Elliptic curve signature parameters generated by signing the orderHash.
+     * @param   signerType the signer type that will perform the `eth_sign` operation. E.g Default, Metamask, Ledger or Trezor.
+     *          Some implementations exhibit different behaviour. Default will assume a spec compliant eth_sign implementation.
+     *          This parameter is defaulted to `SignerType.Default`.
+     * @return  A hex encoded string of the Elliptic curve signature parameters generated by signing the orderHash and signature type.
      */
     public async ecSignOrderHashAsync(
         orderHash: string,
         signerAddress: string,
-        messagePrefixOpts: MessagePrefixOpts,
-    ): Promise<ECSignature> {
+        signerType: SignerType = SignerType.Default,
+    ): Promise<string> {
         const signature = await ecSignOrderHashAsync(
             this._contractWrappers.getProvider(),
             orderHash,
             signerAddress,
-            messagePrefixOpts,
+            signerType,
         );
         return signature;
     }

packages/0x.js/src/index.ts

@@ -1,12 +1,12 @@
 export { ZeroEx } from './0x';
 
-export { MessagePrefixType, MessagePrefixOpts } from '@0xproject/order-utils';
 export { Web3ProviderEngine, RPCSubprovider } from '@0xproject/subproviders';
 
 export {
     ExchangeContractErrs,
     Order,
     SignedOrder,
+    SignerType,
     ECSignature,
     OrderStateValid,
     OrderStateInvalid,