joins.adoc

The joins configuration object

The joins configuration object appears within a static chain configuration object. It describes the join configuration for static chains.

See Chain Joins for more information.

{% include "joins.js" %}

The above example includes the entire staticChains configuration, so that you can see how the joins configuration objects relate to the overall configuration.

There are four types of joins:

• read join, consume state

• read join, provide state

• write join, send actions

• write join, receive actions

Each type of join is configured with specialized join specifications:

consume Array Optional	A list of consumer configuration objects, defining which blockchains to consume state from. alias String Required The chain alias to consume state from. path Array Required A list of state keys describing where, in this blockchain’s state, the consumed state is to be placed. joinName String Required A string identifier for this join, matching the name configured for the provider blockchain.
provide Array Optional	A list of provider configuration objects, defining which blockchains to provide state to. alias String Required The chain alias to provide state to. path Array Required A list of state keys describing which part of the state should be provided to the consuming blockchain. joinName String Required A string identifier for this join, matching the name configured for the consumer blockchain.
receiveActionFrom Array Optional	A list of receiver configuration objects, defining which actions are permitted to be received from a sender blockchain. alias String Required The chain alias of the sender blockchain. authorizedActions Array Required The list of actions that are permitted to be received from the sender blockchain.
sendActionTo Array Optional	The list of actions that should be sent to receiver blockchains. alias String Required The chain alias of the receiver blockchain.