package token

Get desktop application:
View/edit binary Protocol Buffers messages

Prover provides support to clients for the creation of FabToken transactions, and to query the ledger.

• rpc ProcessCommand (SignedCommand, SignedCommandResponse)

  prover.proto:229

  ProcessCommand processes the passed command ensuring proper access control. The returned response allows the client to understand if the operation was succeffully executed and if not, the response reports the reason of the failure.

  message SignedCommand

  prover.proto:168

  SignedCommand is a command that carries the signature of the command's creator.

  • bytes command = 1

    Command is the serialised version of a Command message

  • bytes signature = 2

    Signature is the signature over command

  message SignedCommandResponse

  prover.proto:214

  SignedCommandResponse is a signed command response

  • bytes response = 1

    Response is the serialised version of a CommandResponse message

  • bytes signature = 2

    Signature is the signature over command

ALlowance defines how many and what tokens a recipient can transfer on behalf of their actual owner

Used in: ApproveRequest

• bytes recipient = 1

  Recipient refers to the entity allowed to spend the specified quantity from the tokens identified by token IDs

• uint64 quantity = 2

  Quantity is how many tokens are delegated to the recipient

ApproveRequest is used to request the creation of allowance from one owner to another

Used in: Command

• bytes credential = 1

  Credential refers to the public credential of the request creator

• repeated AllowanceRecipientShare allowance_shares = 2

  Allowance describes the tokens the creator of the request is willing to delegate

• repeated InputId token_ids = 3

  TokenIds are the token identifiers used to create the allowance

Command describes the type of operation that a client is requesting.

• optional Header header = 1

  Header is the header of this command

• oneof payload

  Payload is the payload of this command. It can assume one of the following value

  • ImportRequest import_request = 2

  • TransferRequest transfer_request = 3

  • ListRequest list_request = 4

  • RedeemRequest redeem_request = 5

  • ApproveRequest approve_request = 6

  • TransferRequest transfer_from_request = 7

  • ExpectationRequest expectation_request = 8

A CommnandResponse is returned from a prover to the command submitter.

• optional CommandResponseHeader header = 1

  Header of the response.

• oneof payload

  Payload of the response.

  • Error err = 2

  • TokenTransaction token_transaction = 3

  • UnspentTokens unspent_tokens = 4

Used in: CommandResponse

• optional google.protobuf.Timestamp timestamp = 1

  Timestamp is the time that the message was created as defined by the sender

• bytes command_hash = 2

  CommandHash is the hash computed on the concatenation of the SignedCommand's command and signature fields. If not specified differently, SHA256 is used The hash is used to link a response with its request, both for bookeeping purposes on an asynchronous system and for security reasons (accountability, non-repudiation)

• bytes creator = 3

  Creator is the identity of the party creating this message

Error reports an application error

Used in: CommandResponse

• string message = 1

  Message associated with this response.

• bytes payload = 2

  Payload that can be used to include metadata with this response.

ExpectationRequest is used to request indirect token import or transfer based on the token expectation

Used in: Command

• bytes credential = 1

  credential contains information for the party who is requesting the operation The content of this field depends on the characteristic of token manager system

• optional TokenExpectation expectation = 2

  expectation contains the expected outputs for token import or transfer

• repeated InputId token_ids = 3

  TokenIds are the token identifiers used to fulfill the expectation

Header is a generic replay prevention and identity message to include in a signed command

Used in: Command

• optional google.protobuf.Timestamp timestamp = 1

  Timestamp is the local time when the message was created by the sender

• string channel_id = 2

  ChannelId identifies the channel this message is bound for

• bytes nonce = 3

  Nonce is a sufficientley long random value used to ensure the request has enough entropy.

• bytes creator = 4

  Creator of the message. Typically, a marshaled msp.SerializedIdentity

• bytes tls_cert_hash = 5

  If mutual TLS is enabled, this represents the hash of the client's TLS certificate

ImportRequest is used to request creation of imports

Used in: Command

• bytes credential = 1

  Credential contains information about the party who is requesting the operation the content of this field depends on the charateristic of the token manager system used.

• repeated TokenToIssue tokens_to_issue = 2

  TokenToIssue contains the information about the tokens to be issued

An InputId specifies an output using the transaction ID and the index of the output in the transaction

Used in: ApproveRequest, ExpectationRequest, PlainApprove, PlainTransfer, PlainTransferFrom, RedeemRequest, TokenOutput, TransferRequest

• string tx_id = 1

  The transaction ID

• uint32 index = 2

  The index of the output in the transaction

ListRequest is used to request a list of unspent tokens

Used in: Command

• bytes credential = 1

PlainApprove specifies an approve of one or more tokens in plaintext format

Used in: PlainTokenAction

• repeated InputId inputs = 1

  The inputs to the transfer transaction are specified by their ID

• repeated PlainDelegatedOutput delegated_outputs = 2

  An approve transaction contains one or more plain delegated outputs

• optional PlainOutput output = 3

  An approve transaction contains one plain output

A PlainDelegatedOutput is the result of approve transactions using plaintext tokens

Used in: PlainApprove, PlainTransferFrom

• bytes owner = 1

  The owner is the serialization of a SerializedIdentity struct

• repeated bytes delegatees = 2

  The delegatees is an arrary of the serialized identities that can spend the output on behalf the owner

• string type = 3

  The token type

• uint64 quantity = 4

  The quantity of tokens

PlainExpectation represent the plain expectation where no confidentiality is provided.

Used in: TokenExpectation

• oneof payload

  • PlainTokenExpectation import_expectation = 1

    ImportExpectation describes an token import expectation

  • PlainTokenExpectation transfer_expectation = 2

    TransferExpectation describes a token transfer expectation

PlainImport specifies an import of one or more tokens in plaintext format

Used in: PlainTokenAction

• repeated PlainOutput outputs = 1

  An import transaction may contain one or more outputs

A PlainOutput is the result of import and transfer transactions using plaintext tokens

Used in: PlainApprove, PlainImport, PlainTokenExpectation, PlainTransfer, PlainTransferFrom

• bytes owner = 1

  The owner is the serialization of a SerializedIdentity struct

• string type = 2

  The token type

• uint64 quantity = 3

  The quantity of tokens

PlainTokenAction governs the structure of a token action that is subjected to no privacy restrictions

Used in: TokenTransaction

• oneof data

  • PlainImport plain_import = 1

    A plaintext token import transaction

  • PlainTransfer plain_transfer = 2

    A plaintext token transfer transaction

  • PlainTransfer plain_redeem = 3

    A plaintext token redeem transaction

  • PlainApprove plain_approve = 4

    A plaintext token approve transaction

  • PlainTransferFrom plain_transfer_From = 5

    A plaintext token transfer from transaction

PlainTokenExpectation represents the expecation that certain outputs will be matched

Used in: PlainExpectation

• repeated PlainOutput outputs = 1

  Outputs contains the expected outputs

PlainTransfer specifies a transfer of one or more plaintext tokens to one or more outputs

Used in: PlainTokenAction

• repeated InputId inputs = 1

  The inputs to the transfer transaction are specified by their ID

• repeated PlainOutput outputs = 2

  A transfer transaction may contain one or more outputs

PlainTransferFrom specifies a transfer of one or more plaintext delegated tokens to one or more outputs an to a delegated output

Used in: PlainTokenAction

• repeated InputId inputs = 1

  The inputs to the transfer transaction are specified by their ID

• repeated PlainOutput outputs = 2

  A transferFrom transaction contains multiple outputs

• optional PlainDelegatedOutput delegated_output = 3

  A transferFrom transaction may contain one delegatable output

RecipientTransferShare describes how much a recipient will receive in a token transfer

Used in: TransferRequest

• bytes recipient = 1

  Recipient refers to the prospective owner of a transferred token

• uint64 quantity = 2

  Quantity refers to the number of token units to be transferred to the recipient

RedeemRequest is used to request token redemption

Used in: Command

• bytes credential = 1

  Credential contains information for the party who is requesting the operation The content of this field depends on the characteristic of token manager system

• repeated InputId token_ids = 2

  token_ids specifies the ids for the tokens that will be redeemed

• uint64 quantity_to_redeem = 3

  quantity refers to the number of units of a given token needs to be redeemed.

TokenExpectation represent the belief that someone should achieve in terms of a token action

Used in: ExpectationRequest

• oneof Expectation

  • PlainExpectation plain_expectation = 1

    PlainExpectation describes a plain token expectation

TokenOutput is used to specify a token returned by ListRequest

Used in: UnspentTokens

• optional InputId id = 1

  ID is used to uniquely identify the token

• string type = 2

  Type is the type of the token

• uint64 quantity = 3

  Quantity represents the number for this type of token

TokenToIssue describes a token to be issued in the system

Used in: ImportRequest

• bytes recipient = 1

  Recipient refers to the owner of the token to be issued

• string type = 2

  Type refers to the token type

• uint64 quantity = 3

  Quantity refers to the number of token units to be issued

TokenTransaction governs the structure of Payload.data, when the transaction's envelope header indicates a transaction of type "Token"

Used in: CommandResponse

• oneof action

  action carries the content of this transaction.

  • PlainTokenAction plain_action = 1

RequestTransfer is used to request creation of transfers

Used in: Command

• bytes credential = 1

• repeated InputId token_ids = 2

• repeated RecipientTransferShare shares = 3

UnspentTokens is used to hold the output of listRequest

Used in: CommandResponse

• repeated TokenOutput tokens = 1