corda/docs/source/tutorial-custom-notary.rst

27 lines
1.4 KiB
ReStructuredText
Raw Normal View History

2017-07-05 11:16:47 +00:00
.. highlight:: kotlin
Writing a custom notary service
===============================
.. warning:: Customising a notary service is an advanced feature and not recommended for most use-cases. Currently,
customising Raft or BFT notaries is not yet fully supported. If you want to write your own Raft notary you will have to
implement a custom database connector (or use a separate database for the notary), and use a custom configuration file.
Similarly to writing an oracle service, the first step is to create a service class in your CorDapp and annotate it
with ``@CordaService``. The Corda node scans for any class with this annotation and initialises them. The only requirement
2017-09-14 08:00:02 +00:00
is that the class provide a constructor with a single parameter of type ``ServiceHub``.
2017-07-05 11:16:47 +00:00
.. literalinclude:: example-code/src/main/kotlin/net/corda/docs/CustomNotaryTutorial.kt
:language: kotlin
:start-after: START 1
:end-before: END 1
The next step is to write a notary service flow. You are free to copy and modify the existing built-in flows such
as ``ValidatingNotaryFlow``, ``NonValidatingNotaryFlow``, or implement your own from scratch (following the
``NotaryFlow.Service`` template). Below is an example of a custom flow for a *validating* notary service:
.. literalinclude:: example-code/src/main/kotlin/net/corda/docs/CustomNotaryTutorial.kt
:language: kotlin
:start-after: START 2
:end-before: END 2