com.chain.util

Class TxBuilderWithRules

java.lang.Object

com.chain.api.Transaction.Builder

com.chain.util.TxBuilderWithRules

public class TxBuilderWithRules
extends com.chain.api.Transaction.Builder

A transaction builder that enables new off-chain rules functionality. Use this class instead of Transaction.Builder to engage the rules engine for your transactions. This transaction builder requires that recipient accounts be present in a special whitelist present in asset tags. The whitelist tag key is "account_whitelist". The value should be formatted as follows:

 [
   {"account_id": "an-account-ID"},
   {"account_alias": "an-account-alias"},
   ...
 ]
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TxBuilderWithRules.Helper
static class	TxBuilderWithRules.WhitelistViolationException A special case of APIException that indicates that an asset is being received by an account that is not included in the asset's whitelist.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	whitelistTag

Fields inherited from class com.chain.api.Transaction.Builder

actions, baseTransaction, ttl

Constructor Summary

Constructors

Constructor and Description
TxBuilderWithRules()

Method Summary

Modifier and Type	Method and Description
com.chain.api.Transaction.Template	build(com.chain.http.Client client) Constructs a single transaction template.
static com.chain.http.BatchResponse<com.chain.api.Transaction.Template>	buildBatch(com.chain.http.Client client, List<com.chain.api.Transaction.Builder> builders) Builds a batch of transaction templates.
protected void	validate(com.chain.http.Client client)

Methods inherited from class com.chain.api.Transaction.Builder

addAction, setBaseTransaction, setTtl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

whitelistTag

protected static final String whitelistTag

See Also:

Constant Field Values

Constructor Detail

TxBuilderWithRules

public TxBuilderWithRules()

Method Detail

buildBatch

public static com.chain.http.BatchResponse<com.chain.api.Transaction.Template> buildBatch(com.chain.http.Client client,
                                                                                          List<com.chain.api.Transaction.Builder> builders)
                                                                                   throws com.chain.exception.ChainException

Builds a batch of transaction templates. Use this instead of Transaction.buildBatch to engage the rules engine for the contents of your batch.

Parameters:

client - client object which makes server requests

builders - list of transaction builders

Returns:

a list of transaction templates

Throws:

com.chain.exception.ChainException

build

public com.chain.api.Transaction.Template build(com.chain.http.Client client)
                                         throws com.chain.exception.ChainException

Constructs a single transaction template.

Overrides:

build in class com.chain.api.Transaction.Builder

Parameters:

client - client object which makes requests to the server

Returns:

a transaction template

Throws:

com.chain.exception.ChainException

validate

protected void validate(com.chain.http.Client client)
                 throws com.chain.exception.ChainException

Throws:

com.chain.exception.ChainException