ethwallet

README

Ethereum Wallet

Manage Ethereum accounts and sign transactions.

Contents

• Installation
• Definitions
  • Tasks
    • Create a new account
    • Delete an account
    • Export an account
    • Import an account
    • List accounts
    • Sign transaction
• Test

Installation

MESG Engine

This service requires MESG Engine to be installed first.

You can install MESG Engine by running the following command or follow the installation guide.

bash <(curl -fsSL https://mesg.com/install)

Service

Download the source code of this service, and then in the service's folder, run the following command:

mesg-core service deploy

Definitions

Tasks

Create a new account

Task key: create

Create a new account with a passphrase. Make sure to backup the passphrase.

Inputs

Name	Key	Type	Description
Passphrase	passphrase	String	Passphrase to use to encrypt the account.

Outputs

Error

Output key: error

Output when an error occurs.

Name	Key	Type	Description
Message	message	String	The error message.

Success

Output key: success

Output when the task executes successfully.

Name	Key	Type	Description
Address	address	String	The public address of the account.

Delete an account

Task key: delete

Delete an account from the wallet. Need the address and its associated passphrase.

Inputs

Name	Key	Type	Description
Address	address	String	The public address of the account.
Passphrase	passphrase	String	Passphrase to use to unlock the account.

Outputs

Error

Output key: error

Output when an error occurs.

Name	Key	Type	Description
Message	message	String	The error message.

Success

Output key: success

Output when the task executes successfully.

Name	Key	Type	Description
Address	address	String	The public address of the account.

Export an account

Task key: export

Export an existing account in order to backup it and import it in an other wallet. Respect the Web3 Secret Storage specification. See https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition for more information.

Inputs

Name	Key	Type	Description
Address	address	String	The public address of the account.
Passphrase	passphrase	String	Passphrase to use to unlock the account.

Outputs

Error

Output key: error

Output when an error occurs.

Name	Key	Type	Description
Message	message	String	The error message.

Success

Output key: success

Output when the task executes successfully.

Name	Key	Type	Description
Address	address	String	The public address of the account.
Crypto	crypto	Object	The encrypted account.
ID	id	String	The id of the account.
Version	version	Number	The version used to export the account.

Import an account

Task key: import

Import an account. The account have to respect the Web3 Secret Storage specification. See https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition for more information.

Inputs

Name	Key	Type	Description
Account	account	Object	The JSON encoded account.
Passphrase	passphrase	String	Passphrase to use to unlock the account.

Outputs

Error

Output key: error

Output when an error occurs.

Name	Key	Type	Description
Message	message	String	The error message.

Success

Output key: success

Output when the task executes successfully.

Name	Key	Type	Description
Address	address	String	The public address of the account.

Import an account from a private key

Task key: importFromPrivateKey

Import an account from a private key.

Inputs

Name	Key	Type	Description
Private key	privateKey	String	The private key to import.
Passphrase	passphrase	String	Passphrase to use to unlock the account.

Outputs

Error

Output key: error

Output when an error occurs.

Name	Key	Type	Description
Message	message	String	The error message.

Success

Output key: success

Output when the task executes successfully.

Name	Key	Type	Description
Address	address	String	The public address of the account.

List accounts

Task key: list

Return the addresses of existing account.

Outputs

Error

Output key: error

Output when an error occurs.

Name	Key	Type	Description
Message	message	String	The error message.

Success

Output key: success

Output when the task executes successfully.

Name	Key	Type	Description
Addresses	addresses	String	List of addresses.

Sign transaction

Task key: sign

Sign a transaction with the specified account.

Inputs

Name	Key	Type	Description
Address	address	String	The public address of the account.
Passphrase	passphrase	String	Passphrase to use to unlock the account.
Transaction	transaction	Object	The transaction to sign.

Outputs

Error

Output key: error

Output when an error occurs.

Name	Key	Type	Description
Message	message	String	The error message.

Success

Output key: success

Output when the task executes successfully.

Name	Key	Type	Description
Signed transaction	signedTransaction	String	The signed transaction.

Test

A folder test-data contains test payloads to easily test the service. Adapt their content accordingly.

create

mesg-core service execute ethwallet --task create --json ./test-data/create.json

Lost

mesg-core service execute ethwallet --task list --json ./empty.json

Delete

mesg-core service execute ethwallet --task delete --json ./test-data/delete.json

Export

mesg-core service execute ethwallet --task export --json ./test-data/export.json

Import

mesg-core service execute ethwallet --task import --json ./test-data/import.json

Sign

mesg-core service execute ethwallet --task sign --json ./test-data/sign.json