Module for Whiteflag message retrieval from datastores and blockchains
- Source:
- Tutorials:
Methods
(inner) getAuthMessages(originatorAddress, blockchainopt, callback)
Retrieves authentication messages for a specific blockchain address from database or blockchain
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
originatorAddress |
string | the originator address of the authentication message |
|
blockchain |
string |
<optional> |
the blockchain on which the transaction is stored |
callback |
wfMessagesCb | function called on completion |
- Source:
- To Do:
-
- Remove semantic refs and superseded messages from sequence
(inner) getMessage(transactionHash, blockchainopt, callback)
Retrieves a message from database or blockchain
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
transactionHash |
string | the hash of the transaction to look up |
|
blockchain |
string |
<optional> |
the blockchain on which the transaction is stored |
callback |
wfMessagesCb | function called on completion |
- Source:
(inner) getQuery(wfQuery, callback)
Retrieves a message from database or blockchain
Parameters:
| Name | Type | Description |
|---|---|---|
wfQuery |
Object | the query to be performed |
callback |
wfMessagesCb | function called on completion |
- Source:
(inner) getReferences(transactionHash, blockchainopt, callback)
Retrieves referencing messages from database or blockchain
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
transactionHash |
string | the transaction hash of the referenced message |
|
blockchain |
string |
<optional> |
the blockchain on which the transaction is stored |
callback |
wfMessagesCb | function called on completion |
- Source:
(inner) getSequence(transactionHash, blockchain, callback)
Retrieves and evaluates message sequence starting with the message identified by the transaction hash
Parameters:
| Name | Type | Description |
|---|---|---|
transactionHash |
string | the hash of the transaction to look up |
blockchain |
string | the blockchain on which the transaction is stored |
callback |
wfMessagesCb | function called on completion |
- Source:
- To Do:
-
- Clean up retrieved sequence
Type Definitions
bcGetMessageCb(err, wfMessage)
Parameters:
| Name | Type | Description |
|---|---|---|
err |
Error | any error |
wfMessage |
Object | a Whiteflag message |
- Source:
wfMessagesCb(err, message)
Parameters:
| Name | Type | Description |
|---|---|---|
err |
error | any error |
message |
Array.<wfMessage> | an array with the Whiteflag messages |
- Source: