transactions package

public struct NotifyRequest

Field Name Data Type Description Default Value
transactionId string
message string
  • <NotifyRequest> NotifyRequest.<init>()

public struct NotifyResponse

Field Name Data Type Description Default Value
message string
  • <NotifyResponse> NotifyResponse.<init>()

public struct Participant2pcClient

Field Name Data Type Description Default Value
clientEP Participant2pcClientEP []
  • <Participant2pcClient> notify(string transactionId, string message) returns (string | error)

    Parameter Name Data Type Description
    transactionId string
    message string

    Return Variable Data Type Description
    string | error
  • <Participant2pcClient> prepare(string transactionId) returns (string | error)

    Parameter Name Data Type Description
    transactionId string

    Return Variable Data Type Description
    string | error
  • <Participant2pcClient> Participant2pcClient.<init>()

public struct Participant2pcClientConfig

Field Name Data Type Description Default Value
participantURL string
endpointTimeout int
retryConfig struct {int count, int interval} []
  • <Participant2pcClientConfig> Participant2pcClientConfig.<init>()

public struct Participant2pcClientEP

Field Name Data Type Description Default Value
httpClient ClientEndpoint []
conf Participant2pcClientConfig []
  • <Participant2pcClientEP> getClient() returns (Participant2pcClient)

    Return Variable Data Type Description
    Participant2pcClient
  • <Participant2pcClientEP> init(Participant2pcClientConfig conf)

    Parameter Name Data Type Description
    conf Participant2pcClientConfig
  • <Participant2pcClientEP> Participant2pcClientEP.<init>()

public struct PrepareRequest

Field Name Data Type Description Default Value
transactionId string
  • <PrepareRequest> PrepareRequest.<init>()

public struct PrepareResponse

Field Name Data Type Description Default Value
message string
  • <PrepareResponse> PrepareResponse.<init>()

public struct Protocol

Field Name Data Type Description Default Value
name string
url string
transactionBlockId int
protocolFn function(string, int, string)returns(boolean) | null
  • <Protocol> Protocol.<init>()

public struct RegistrationRequest

Field Name Data Type Description Default Value
transactionId string
participantId string
participantProtocols Protocol[] []
  • <RegistrationRequest> RegistrationRequest.<init>()

public struct RegistrationResponse

Field Name Data Type Description Default Value
transactionId string
coordinatorProtocols Protocol[] []
  • <RegistrationResponse> RegistrationResponse.<init>()

public struct RequestError

Field Name Data Type Description Default Value
errorMessage string
  • <RequestError> RequestError.<init>()

public struct TransactionContext

Field Name Data Type Description Default Value
contextVersion string 1.0
transactionId string
transactionBlockId int
coordinationType string
registerAtURL string
  • <TransactionContext> TransactionContext.<init>()

public function jsonToRegResponse(json j) returns (RegistrationResponse)

Parameter Name Data Type Description
j json

Return Variable Data Type Description
RegistrationResponse

public function regRequestToJson(RegistrationRequest req) returns (json)

Parameter Name Data Type Description
req RegistrationRequest

Return Variable Data Type Description
json

public function regResponseToJson(RegistrationResponse res) returns (json)

Parameter Name Data Type Description
res RegistrationResponse

Return Variable Data Type Description
json

public function registerParticipantWithRemoteInitiator(string transactionId, int transactionBlockId, string registerAtURL, Protocol[] participantProtocols) returns (TransactionContext | error)

Parameter Name Data Type Description
transactionId string
transactionBlockId int
registerAtURL string
participantProtocols Protocol[]

Return Variable Data Type Description
TransactionContext | error

public enum TransactionState

Name Description
ACTIVE
PREPARED
COMMITTED
ABORTED

COMMAND_PREPARE

Attribute Name Data Type Description
COMMAND_PREPARE string

COMMAND_COMMIT

Attribute Name Data Type Description
COMMAND_COMMIT string

COMMAND_ABORT

Attribute Name Data Type Description
COMMAND_ABORT string

OUTCOME_PREPARED

Attribute Name Data Type Description
OUTCOME_PREPARED string

OUTCOME_NOT_PREPARED

Attribute Name Data Type Description
OUTCOME_NOT_PREPARED string

OUTCOME_MIXED

Attribute Name Data Type Description
OUTCOME_MIXED string

OUTCOME_ABORTED

Attribute Name Data Type Description
OUTCOME_ABORTED string

OUTCOME_COMMITTED

Attribute Name Data Type Description
OUTCOME_COMMITTED string

OUTCOME_HAZARD

Attribute Name Data Type Description
OUTCOME_HAZARD string

OUTCOME_FAILED_EOT

Attribute Name Data Type Description
OUTCOME_FAILED_EOT string

OUTCOME_READ_ONLY

Attribute Name Data Type Description
OUTCOME_READ_ONLY string