init.proto

/*
 * It is __mandatory__ that every plugin must implement this RPC service
 *
 * Via this service, plugins receive a raw configuration sent by `geth`.
 * It's up to the plugin to interpret and parse the configuration then do the initialization
 * to make sure the plugin is ready to serve
 */
syntax = "proto3";

package proto_common;

option go_package = "proto_common";
option java_package = "com.quorum.plugin.proto";
option java_outer_classname = "Initializer";

/**
 * A wrapper message to logically group other messages
 */
message PluginInitialization {
    /*
     * Initialization data for the plugin
     */
    message Request {
        // `geth` node identity
        string hostIdentity = 1;
        // Raw configuration to be processed by the plugin
        bytes rawConfiguration = 2;
    }
    message Response {
    }
}

/*
 * `Required`
 * RPC service to initialize the plugin after plugin process is started successfully
 */
service PluginInitializer {
    rpc Init(PluginInitialization.Request) returns (PluginInitialization.Response);
}