aries_cloudagent.protocols.endorse_transaction.v1_0 package¶
Subpackages¶
- aries_cloudagent.protocols.endorse_transaction.v1_0.handlers package
- Submodules
- aries_cloudagent.protocols.endorse_transaction.v1_0.handlers.endorsed_transaction_response_handler module
- aries_cloudagent.protocols.endorse_transaction.v1_0.handlers.refused_transaction_response_handler module
- aries_cloudagent.protocols.endorse_transaction.v1_0.handlers.transaction_acknowledgement_handler module
- aries_cloudagent.protocols.endorse_transaction.v1_0.handlers.transaction_cancel_handler module
- aries_cloudagent.protocols.endorse_transaction.v1_0.handlers.transaction_job_to_send_handler module
- aries_cloudagent.protocols.endorse_transaction.v1_0.handlers.transaction_request_handler module
- aries_cloudagent.protocols.endorse_transaction.v1_0.handlers.transaction_resend_handler module
- aries_cloudagent.protocols.endorse_transaction.v1_0.messages package
- Submodules
- aries_cloudagent.protocols.endorse_transaction.v1_0.messages.cancel_transaction module
- aries_cloudagent.protocols.endorse_transaction.v1_0.messages.endorsed_transaction_response module
- aries_cloudagent.protocols.endorse_transaction.v1_0.messages.messages_attach module
- aries_cloudagent.protocols.endorse_transaction.v1_0.messages.refused_transaction_response module
- aries_cloudagent.protocols.endorse_transaction.v1_0.messages.transaction_acknowledgement module
- aries_cloudagent.protocols.endorse_transaction.v1_0.messages.transaction_job_to_send module
- aries_cloudagent.protocols.endorse_transaction.v1_0.messages.transaction_request module
- aries_cloudagent.protocols.endorse_transaction.v1_0.messages.transaction_resend module
- aries_cloudagent.protocols.endorse_transaction.v1_0.models package
Submodules¶
aries_cloudagent.protocols.endorse_transaction.v1_0.controller module¶
Protocol controller for endorse transaction.
aries_cloudagent.protocols.endorse_transaction.v1_0.manager module¶
Class to manage transactions.
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.manager.
TransactionManager
(profile: aries_cloudagent.core.profile.Profile)[source]¶ Bases:
object
Class for managing transactions.
-
cancel_transaction
(transaction: aries_cloudagent.protocols.endorse_transaction.v1_0.models.transaction_record.TransactionRecord, state: str)[source]¶ Cancel a Transaction Request.
Parameters: - transaction – The transaction record which would be cancelled
- state – The state of the transaction record
Returns: The updated transaction and the cancelled transaction response
-
complete_transaction
(transaction: aries_cloudagent.protocols.endorse_transaction.v1_0.models.transaction_record.TransactionRecord, endorser: bool = False)[source]¶ Complete a transaction.
This is the final state where the received ledger transaction is written to the ledger.
Parameters: transaction – The transaction record which would be completed Returns: The updated transaction
-
create_endorse_response
(transaction: aries_cloudagent.protocols.endorse_transaction.v1_0.models.transaction_record.TransactionRecord, state: str, use_endorser_did: str = None)[source]¶ Create a response to endorse a transaction.
Parameters: - transaction – The transaction record which would be endorsed.
- state – The state of the transaction record
Returns: The updated transaction and an endorsed response
-
create_record
(messages_attach: str, connection_id: str, meta_data: dict = None)[source]¶ Create a new Transaction Record.
Parameters: - messages_attach – messages to attach, JSON-dumped
- connection_id – The connection_id of the ConnRecord between author and endorser
Returns: The transaction Record
-
create_refuse_response
(transaction: aries_cloudagent.protocols.endorse_transaction.v1_0.models.transaction_record.TransactionRecord, state: str, refuser_did: str)[source]¶ Create a response to refuse a transaction.
Parameters: - transaction – The transaction record which would be refused
- state – The state of the transaction record
Returns: The updated transaction and the refused response
-
create_request
(transaction: aries_cloudagent.protocols.endorse_transaction.v1_0.models.transaction_record.TransactionRecord, signature: str = None, signed_request: dict = None, expires_time: str = None, endorser_write_txn: bool = None, author_goal_code: str = None, signer_goal_code: str = None)[source]¶ Create a new Transaction Request.
Parameters: - transaction – The transaction from which the request is created.
- expires_time – The time till which the endorser should endorse the transaction.
Returns: The transaction Record and transaction request
-
endorsed_txn_post_processing
(transaction: aries_cloudagent.protocols.endorse_transaction.v1_0.models.transaction_record.TransactionRecord, ledger_response: dict = None, connection_record: aries_cloudagent.connections.models.conn_record.ConnRecord = None)[source]¶ Store record in wallet, and kick off any required post-processing.
Parameters: transaction – The transaction from which the schema/cred_def would be stored in wallet.
-
profile
¶ Accessor for the current Profile.
Returns: The Profile for this transaction manager
-
receive_cancel_transaction
(response: aries_cloudagent.protocols.endorse_transaction.v1_0.messages.cancel_transaction.CancelTransaction, connection_id: str)[source]¶ Update the transaction record to cancel a transaction request.
Parameters: - response – The cancel transaction response
- connection_id – The connection_id related to this Transaction Record
-
receive_endorse_response
(response: aries_cloudagent.protocols.endorse_transaction.v1_0.messages.endorsed_transaction_response.EndorsedTransactionResponse)[source]¶ Update the transaction record with the endorsed response.
Parameters: response – The Endorsed Transaction Response
-
receive_refuse_response
(response: aries_cloudagent.protocols.endorse_transaction.v1_0.messages.refused_transaction_response.RefusedTransactionResponse)[source]¶ Update the transaction record with a refused response.
Parameters: response – The refused transaction response
-
receive_request
(request: aries_cloudagent.protocols.endorse_transaction.v1_0.messages.transaction_request.TransactionRequest, connection_id: str)[source]¶ Receive a Transaction request.
Parameters: - request – A Transaction Request
- connection_id – The connection id related to this transaction record
-
receive_transaction_acknowledgement
(response: aries_cloudagent.protocols.endorse_transaction.v1_0.messages.transaction_acknowledgement.TransactionAcknowledgement, connection_id: str)[source]¶ Update the transaction record after receiving the transaction acknowledgement.
Parameters: - response – The transaction acknowledgement
- connection_id – The connection_id related to this Transaction Record
-
receive_transaction_resend
(response: aries_cloudagent.protocols.endorse_transaction.v1_0.messages.transaction_resend.TransactionResend, connection_id: str)[source]¶ Update the transaction with a resend request.
Parameters: - response – The Resend transaction response
- connection_id – The connection_id related to this Transaction Record
-
set_transaction_my_job
(record: aries_cloudagent.connections.models.conn_record.ConnRecord, transaction_my_job: str)[source]¶ Set transaction_my_job.
Parameters: - record – The connection record in which to set transaction jobs
- transaction_my_job – My transaction job
Returns: The transaction job that is send to other agent
-
set_transaction_their_job
(tx_job_received: aries_cloudagent.protocols.endorse_transaction.v1_0.messages.transaction_job_to_send.TransactionJobToSend, receipt: aries_cloudagent.transport.inbound.receipt.MessageReceipt)[source]¶ Set transaction_their_job.
Parameters: - tx_job_received – The transaction job that is received from the other agent
- receipt – The Message Receipt Object
-
transaction_resend
(transaction: aries_cloudagent.protocols.endorse_transaction.v1_0.models.transaction_record.TransactionRecord, state: str)[source]¶ Resend a transaction request.
Parameters: - transaction – The transaction record which needs to be resend
- state – the state of the transaction record
Returns: The updated transaction and the resend response
-
-
exception
aries_cloudagent.protocols.endorse_transaction.v1_0.manager.
TransactionManagerError
(*args, error_code: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.core.error.BaseError
Transaction error.
aries_cloudagent.protocols.endorse_transaction.v1_0.message_types module¶
Message type identifiers for Transactions.
aries_cloudagent.protocols.endorse_transaction.v1_0.routes module¶
Endorse Transaction handling admin routes.
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
AssignTransactionJobsSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Assign transaction related jobs to connection record.
-
transaction_my_job
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
DateSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Sets Expiry date, till when the transaction should be endorsed.
-
expires_time
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
EndorserDIDInfoSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Path parameters and validators for request Endorser DID.
-
endorser_did
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
EndorserInfoSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Class for user to input the DID associated with the requested endorser.
-
endorser_did
¶ Used by autodoc_mock_imports.
-
endorser_name
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
EndorserWriteLedgerTransactionSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Sets endorser_write_txn. Option for the endorser to write the transaction.
-
endorser_write_txn
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
TranIdMatchInfoSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Path parameters and validators for request taking transaction id.
-
tran_id
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
TransactionConnIdMatchInfoSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Path parameters and validators for request taking connection id.
-
conn_id
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
TransactionJobsSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Transaction jobs metadata on connection record.
-
transaction_my_job
¶ Used by autodoc_mock_imports.
-
transaction_their_job
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
TransactionListSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Result schema for transaction list.
-
results
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
TransactionsListQueryStringSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Parameters and validators for transactions list request query string.
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
cancel_transaction
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Request handler for cancelling a Transaction request.
Parameters: request – aiohttp request object Returns: The updated transaction record details
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
endorse_transaction_response
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Request handler for creating an endorsed transaction response.
Parameters: request – aiohttp request object Returns: The updated transaction record details
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
on_shutdown_event
(profile: aries_cloudagent.core.profile.Profile, event: aries_cloudagent.core.event_bus.Event)[source]¶ Handle any events we need to support.
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
on_startup_event
(profile: aries_cloudagent.core.profile.Profile, event: aries_cloudagent.core.event_bus.Event)[source]¶ Handle any events we need to support.
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
post_process_routes
(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Amend swagger API.
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
refuse_transaction_response
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Request handler for creating a refused transaction response.
Parameters: request – aiohttp request object Returns: The updated transaction record details
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
register
(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Register routes.
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
register_events
(event_bus: aries_cloudagent.core.event_bus.EventBus)[source]¶ Subscribe to any events we need to support.
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
set_endorser_info
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Request handler for assigning endorser information.
Parameters: request – aiohttp request object Returns: The assigned endorser information
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
set_endorser_role
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Request handler for assigning transaction jobs.
Parameters: request – aiohttp request object Returns: The assigned transaction jobs
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
transaction_create_request
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Request handler for creating a new transaction record and request.
Parameters: request – aiohttp request object Returns: The transaction record
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
transaction_resend
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Request handler for resending a transaction request.
Parameters: request – aiohttp request object Returns: The updated transaction record details
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
transaction_write
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Request handler for writing an endorsed transaction to the ledger.
Parameters: request – aiohttp request object Returns: The returned ledger response
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
transactions_list
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Request handler for searching transaction records.
Parameters: request – aiohttp request object Returns: The transaction list response
-
aries_cloudagent.protocols.endorse_transaction.v1_0.routes.
transactions_retrieve
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc044cfdd90>)[source]¶ Request handler for fetching a single transaction record.
Parameters: request – aiohttp request object Returns: The transaction record response
aries_cloudagent.protocols.endorse_transaction.v1_0.transaction_jobs module¶
Class to manage jobs in Connection Record.
aries_cloudagent.protocols.endorse_transaction.v1_0.util module¶
Endorser utilities.
-
aries_cloudagent.protocols.endorse_transaction.v1_0.util.
get_endorser_connection_id
(profile: aries_cloudagent.core.profile.Profile)[source]¶ Determine default endorser connection for author.
Check if agent is running in author mode.