mirror of https://github.com/embarklabs/embark.git
Updated API Documentation (markdown)
parent
11d74e945b
commit
481bc641ea
|
@ -23,7 +23,7 @@
|
|||
* namesystem
|
||||
* pipeline
|
||||
* process-logs-api-manager
|
||||
* proxy
|
||||
* [proxy](#proxy)
|
||||
* storage
|
||||
* test-runner
|
||||
* watcher
|
||||
|
@ -76,3 +76,39 @@
|
|||
|
||||
### accounts-manager
|
||||
|
||||
module type: plugin
|
||||
|
||||
#### Description
|
||||
|
||||
* generates wallet from accounts configuration
|
||||
* fund accounts according to the accounts configuration
|
||||
* signs transactions for accounts present in its wallet
|
||||
* if it's a node account it just ignores it (since it will be processed at the node)
|
||||
* overrides eth_getAccounts to return the correct list of accounts
|
||||
|
||||
**actions used**
|
||||
|
||||
* `blockchain:proxy:request` - to sign the transactions
|
||||
* `blockchain:proxy:response` - to modify accounts list
|
||||
|
||||
### proxy
|
||||
|
||||
module type: stack
|
||||
|
||||
##### requests
|
||||
|
||||
name: `proxy:endpoint`
|
||||
arguments: no arguments
|
||||
|
||||
returns the endpoint (string)
|
||||
|
||||
##### actions
|
||||
|
||||
name: `blockchain:proxy:request`
|
||||
params: {reqData: <Object>}
|
||||
description: actions run when a request is made to the blockchain node. In case the plugin hangs (5 seconds), the action continues.
|
||||
|
||||
name: `blockchain:proxy:response`
|
||||
params: {respData: <Object>, reqData: <Object>}
|
||||
description: actions run when a response is returned from the blockchain node. In case the plugin hangs (5 seconds), the action continues.
|
||||
|
||||
|
|
Loading…
Reference in New Issue