net.corda.v5.membership heading-link-icon

The corda-membership package defines interfaces that provide information about a member Corda identity that has been granted admission to a membership group. Synonym for a virtual node. Same as a group member. and a membership group A logical grouping of multiple Corda identities, which communicate and transact with each other using a specific set of CorDapps. . The interfaces in this module should not be implemented by CorDapp Corda Distributed Application. A Java (or any JVM targeting language) application built using the Corda build toolchain and CorDapp API to solve some problem that is best solved in a decentralized manner. Developers. Instead, instances can be retrieved through lookup services. For more information, see the documentation for the package in the Java API documentation.

This package consists primarily of the following two root classes:

The MemberInfo interface exposes properties of a virtual node’s membership. This includes the X.500 A series of international standards defining a global directory service protocol for computer networks. It provides a structured framework for storing, accessing, and managing information about network resources and users in a hierarchical and distributed manner. name, ledger keys A key which can be used to sign for transactions. This key may be held confidentially and signatures may be used as evidence of authority to sign transactions. Alternatively, it may be published in the virtual nodes's MemberInfo to act as a published fact to prove the identity of the virtual node on the ledger. , and status. This information is a combination of information provided during network registration and metadata assigned to the member by the MGM Membership Group Manager. May also be referred to as the Network Manager. It is a virtual node and Corda identity that acts as a central registrar for group membership. .

Information provided by the virtual node operator at time of registration is the content of the MemberContext and the information provided by the MGM is the source of the MGMContext content.

Instances of MemberInfo must be retrieved through a lookup API. MemberLookup from the corda-application module, is the lookup API which provides membership information to CorDapps. This can be used to look up the information of the member executing a flow Communication between participants in an application network is peer-to-peer using flows. or other members available to transact with within the group.

The MemberInfo interface extends the LayeredPropertyMap interface, which means that membership information is key-value String pairs that are parsed and returned through properties. Generally, any properties required for use within a CorDapp are exposed through the MemberInfo interface. Other properties may only be relevant internally or at certain layers within the codebase so these are exposed through extension functions.

The GroupParameters interface is also a type of LayeredPropertyMap which exposes properties of the group as distributed by the network manager (MGM). These properties define the parameters under which all members must operate during transactions and are exposed for Network Operators by GET methods. For more information, see Updating Group Parameters.

The GroupParametersLookup interface allows flows to access GroupParameters for further verification.

Was this page helpful?

Thanks for your feedback!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

We're sorry this page wasn't helpful. Let us know how we can make it better!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Create an issue

Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.