Update Aug 29th 2019: Hyperledger Composer has been deprecated. Please see the README for more information.

Transactions

Transaction Functions Detail

Transaction

The fully qualified name is org.hyperledger.composer.system.Transaction

Additional Information

The base transaction is implicitly extended by all other transactions. Transaction is an abstract meaning that no instances of it can be created, however, it does contain the transactionId and timestamp properties, which are extended to all other transactions.

abstract transaction Transaction identified by transactionId {
  o String transactionId
  o DateTime timestamp
Name Type Description
transactionId string Identifier for this transaction
timestamp string Timestamp for this transaction

RegistryTransaction

The fully qualified name is org.hyperledger.composer.system.RegistryTransaction

Additional Information

RegistryTransaction is a system transaction for a transaction which affects a registry. RegistryTransaction is an abstract, meaning instances of it cannot be used. RegistryTransaction has the targetRegistry property, which contains a relationship to a registry.

abstract transaction RegistryTransaction {
  --> Registry targetRegistry
}
Name Type Description
targetRegistry string Registry that will be manipulated

AssetTransaction

The fully qualified name is org.hyperledger.composer.system.AssetTransaction

Additional Information

AssetTransaction is a system transaction for a transaction which affects an asset. AssetTransaction is an abstract, meaning instances of it cannot be used. AssetTransaction has the resources property.

abstract transaction AssetTransaction extends RegistryTransaction {
   o Asset[] resources
}
Name Type Description
resources array Resources that will be manipulated

ParticipantTransaction

The fully qualified name is org.hyperledger.composer.system.ParticipantTransaction

Additional Information

ParticipantTransaction is a system transaction for a transaction which affects a participant. ParticipantTransaction is an abstract, meaning instances of it cannot be used. ParticipantTransaction has the resources property.

abstract transaction ParticipantTransaction extends RegistryTransaction {
  o Participant[] resources
}
Name Type Description
resources array participants that will be manipulated

AddAsset

The fully qualified name is org.hyperledger.composer.system.AddAsset

Additional Information

Name Type Description

UpdateAsset

The fully qualified name is org.hyperledger.composer.system.UpdateAsset

Additional Information

Name Type Description

RemoveAsset

The fully qualified name is org.hyperledger.composer.system.RemoveAsset

Additional Information

Name Type Description
resourceIds array Identifiers of the assets to remove

AddParticipant

The fully qualified name is org.hyperledger.composer.system.AddParticipant

Additional Information

Name Type Description

UpdateParticipant

The fully qualified name is org.hyperledger.composer.system.UpdateParticipant

Additional Information

Name Type Description

RemoveParticipant

The fully qualified name is org.hyperledger.composer.system.RemoveParticipant

Additional Information

Name Type Description
resourceIds array Identifiers of the participants to remove

IssueIdentity

The fully qualified name is org.hyperledger.composer.system.IssueIdentity

Additional Information

IssueIdentity is a system transaction which issues an identity to a participant.

transaction IssueIdentity {
    --> Participant participant
    o String identityName
}
Name Type Description
participant string to issue the identity to
identityName string name to use for this identity

BindIdentity

The fully qualified name is org.hyperledger.composer.system.BindIdentity

Additional Information

BindIdentity is a system transaction which binds an issued identity to a participant. BindIdentity contains a participant property, specifying a relationship to a participant.

transaction BindIdentity {
    --> Participant participant
    o String certificate
}
Name Type Description
participant string to issue bind identity to
certificate string to use

ActivateCurrentIdentity

The fully qualified name is org.hyperledger.composer.system.ActivateCurrentIdentity

Additional Information

ActivateCurrentIdentity* is a system transaction which activates the identity currently being used.

transaction ActivateCurrentIdentity { }
Name Type Description

RevokeIdentity

The fully qualified name is org.hyperledger.composer.system.RevokeIdentity

Additional Information

RevokeIdentity is a system transaction which revokes a specified identity.

transaction RevokeIdentity {
    --> Identity identity
}
Name Type Description
identity string to revoke

StartBusinessNetwork

The fully qualified name is org.hyperledger.composer.system.StartBusinessNetwork

Additional Information

StartBusinessNetwork is a system transaction that starts a business network. Both the logLevel and bootstrapTransactions properties are optional.

transaction StartBusinessNetwork {
  o String logLevel optional
  o Transaction[] bootstrapTransactions optional
}
Name Type Description
logLevel string Log level to use optionally
bootstrapTransactions array optional transactions to use to bootstrap the network

ResetBusinessNetwork

The fully qualified name is org.hyperledger.composer.system.ResetBusinessNetwork

Additional Information

ResetBusinessNetwork is a system transaction which deletes all data in a business network, while leaving the business network definition intact.

transaction ResetBusinessNetwork {

}
Name Type Description

SetLogLevel

The fully qualified name is org.hyperledger.composer.system.SetLogLevel

Additional Information

SetLogLevel is a system transaction which sets the logging level for the business network. The possible logging levels can be found in the problem diagnosis documentation.

transaction SetLogLevel {
  o String newLogLevel
}
Name Type Description
newLogLevel string a valid debug string