Function indyrs::ledger::build_txn_author_agreement_request[−][src]

pub fn build_txn_author_agreement_request(
    submitter_did: &str, 
    text: Option<&str>, 
    version: &str, 
    ratification_ts: Option<u64>, 
    retirement_ts: Option<u64>
) -> Box<dyn Future<Item = String, Error = IndyError>>

Builds a TXN_AUTHR_AGRMT request. Request to add a new version of Transaction Author Agreement to the ledger.

Arguments

  • submitter_did - Identifier (DID) of the transaction author as base58-encoded string. Actual request sender may differ if Endorser is used (look at append_request_endorser)
  • text: (Optional) a content of the TTA. Mandatory in case of adding a new TAA. An existing TAA text can not be changed. for Indy Node version <= 1.12.0: Use empty string to reset TAA on the ledger for Indy Node version > 1.12.0 Should be omitted in case of updating an existing TAA (setting retirement_ts)
  • version: a version of the TTA (unique UTF-8 string).
  • ratification_ts: (Optional) the date (timestamp) of TAA ratification by network government. for Indy Node version <= 1.12.0: Must be omitted for Indy Node version > 1.12.0: Must be specified in case of adding a new TAA Can be omitted in case of updating an existing TAA
  • retirement_ts: (Optional) the date (timestamp) of TAA retirement. for Indy Node version <= 1.12.0: Must be omitted for Indy Node version > 1.12.0: Must be omitted in case of adding a new (latest) TAA. Should be used for updating (deactivating) non-latest TAA on the ledger.

Note: Use build_disable_all_txn_author_agreements_request to disable all TAA's on the ledger.

Returns

Request result as json.