eth

For more details about the Quorum Privacy APIs

Source:

Methods

(inner) distributePrivateTransaction(privateTxn, privateData) → {String}

Source:
Parameters:
Name Type Description
privateTxn String

Signed private transaction in hex format
privateData Object

Private data to send

Properties
Name Type Attributes Default Description
privateFor Array.<String>

An array of the recipients’ base64-encoded public keys.
privateFrom Array.<String> <optional>

The sending party’s base64-encoded public key to use (Privacy Manager default if not provided).
privacyFlag Number <optional>
 0

0 for SP (default if not provided), 1 for PP, 3 for PSV
mandatoryFor Array.<String> <optional>

an array of the recipients’ base64-encoded public keys
Returns:

Transaction Manager hash to be used as a privacy marker transaction's data when externally signing..

Type
String

(inner) fillTransaction(txObj) → {Object}

Source:
Parameters:
Name Type Description
txObj Object

The transaction object to send:

Properties
Name Type Attributes Description
from String

The address for the sending account.
to String <optional>

The destination address of the message,
value Number | String | BigNumber <optional>

The value transferred for the transaction in Wei, also the endowment if it’s a contract-creation transaction.
data String <optional>

Either a byte string containing the associated data of the message, or in the case of a contract-creation transaction, the initialisation code.
privateFor Array.<String> <optional>

When sending a private transaction, an array of the recipients’ base64-encoded public keys.
Returns:

raw: RLP encoded bytes for the passed transaction object and tx : transaction object

Type
Object

(inner) getContractPrivacyMetadata(contractAddress) → {Object}

Source:
Parameters:
Name Type Description
contractAddress String
Returns:
Type
Object

(inner) getPrivacyPrecompileAddress() → {String}

Source:
Returns:

Contract address for the privacy precompile in hex format.

Type
String

(inner) getPrivateTransactionByHash(hash) → {Transaction}

Source:
Parameters:
Name Type Description
hash String

Privacy marker transaction's hash in HEX format.
Returns:

private transaction (will be nil if caller is not a participant).

Type
Transaction

(inner) getPrivateTransactionReceipt(hash) → {Receipt}

Source:
Parameters:
Name Type Description
hash String

Privacy marker transaction's hash in HEX format.
Returns:

private transaction receipt (will be nil if caller is not a participant).

Type
Receipt

(inner) getPSI() → {String}

Source:
Returns:

the private state identifier (PSI)

Type
String

(inner) getQuorumPayload(id) → {String}

Source:
Parameters:
Name Type Description
id String

the HEX formatted generated Sha3-512 hash of the encrypted payload from the Private Transaction Manager. This is seen in the transaction as the input field
Returns:

unencrypted transaction payload in HEX format.

Type
String

(inner) sendGoQuorumTransaction(transaction, callbackopt) → {Promise.<T>}

Source:

Submit a transaction. This method is similar to web3.eth.sendTransaction(), however it adds support for Privacy Marker Transactions. If the transaction is a Privacy Marker, then the promise will return the receipt for the inner private transaction, rather than the receipt for the Privacy Marker Transaction. Note that this method does not currently support PromiEvent events that are returned by web3.eth.sendTransaction().

Parameters:
Name Type Attributes Description
transaction Object

The transaction object to send (see web3.eth.sendTransaction() for object details)
callback function <optional>

(optional) Optional callback, returns an error object as first parameter and the transaction hash as second.
Returns:

Resolves when the transaction receipt is available.

Type
Promise.<T>

(inner) sendRawPrivateTransaction(Signed, privateData, callbackopt) → {String}

Source:
Parameters:
Name Type Attributes Description
Signed String

transaction data in HEX format
privateData Object

Private data to send

Properties
Name Type Attributes Default Description
privateFor Array.<String>

When sending a private transaction, an array of the recipients’ base64-encoded public keys.
privacyFlag Number <optional>
 0

0 for SP (default if not provided), 1 for PP, 3 for PSV
mandatoryFor Array.<String> <optional>

an array of the recipients’ base64-encoded public keys
callback function <optional>

If you pass a callback the HTTP request is made asynchronous.
Returns:

The 32 Bytes transaction hash as HEX string

Type
String

(inner) sendTransactionAsync(txObj) → {String}

Source:
Parameters:
Name Type Description
txObj Object

Transaction Object to send
Returns:
Type
String

(inner) storageRoot(address, blockopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
address String

The address to fetch the storage root from in hex
block String <optional>
 "latest"

The block number to fetch the storage root from in hex
Returns:

32 Bytes storage root hash as hex string.

Type
String