Merge pull request #2471 from joshstevens19/@types/sign

`Sign` needed to have a signature on typing's + fix incorrect docs
web3 · Mar 18, 2019 · 4bd1410 · 4bd1410
2 parents f66e080 + 88ad4c2
commit 4bd1410
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/web3-eth-accounts.rst b/docs/web3-eth-accounts.rst
@@ -306,7 +306,7 @@ Parameters
 Returns
 -------
 
-``String|Object``: The signed data RLP encoded signature, or if ``returnSignature`` is ``true`` the signature values as follows:
+``Object``: The signed data RLP encoded signature, or if ``returnSignature`` is ``true`` the signature values as follows:
     - ``message`` - ``String``: The the given message.
     - ``messageHash`` - ``String``: The hash of the given message.
     - ``r`` - ``String``: First 32 bytes of the signature

diff --git a/packages/web3-eth-accounts/types/index.d.ts b/packages/web3-eth-accounts/types/index.d.ts
@@ -108,4 +108,5 @@ export interface EncryptedKeystoreV3Json {
 
 export interface Sign extends SignedTransaction {
     message: string;
+    signature: string;
 }