staged-tx

SystemService::StagedTxService

struct SystemService::StagedTxService {
    const psibase::AccountNumber service; 

    init(...);          
    propose(...);       // Proposes a new staged transaction containing the specified actions. Returns the ID of the database record containing the staged transaction.
    remove(...);        // Removes (deletes) a staged transaction
    accept(...);        // Indicates that the caller accepts the specified staged transaction
    reject(...);        // Indicates that the caller rejects the staged transaction
    get_staged_tx(...); // Gets a staged transaction by id.
};

A service for staged transaction proposal and execution.

A staged transaction allows an account (the proposer) to propose a set of actions to be executed by another account (the executor). The set of actions proposed is known as the staged transaction. The staged transaction is not executed unless and until the executor's auth service authorizes the execution.

The rules for authorization may vary depending on the staged-tx policy enforced by the executor's auth service.

This can be used, for example, to propose a transaction on behalf of an account that is only authorized by the combined authorization of multiple other accounts (a.k.a. a "multi-sig" or multi-signature transaction), among many other uses.

SystemService::StagedTxService::init

void SystemService::StagedTxService::init();

SystemService::StagedTxService::propose

uint32_t SystemService::StagedTxService::propose(
    const std::vector<psibase::Action> & actions
);

Proposes a new staged transaction containing the specified actions. Returns the ID of the database record containing the staged transaction..

  • actions - The actions to be staged

SystemService::StagedTxService::remove

void SystemService::StagedTxService::remove(
    uint32_t             id,
    psibase::Checksum256 txid
);

Removes (deletes) a staged transaction.

A staged transaction can only be removed by its proposer.

  • id: The ID of the database record containing the staged transaction
  • txid: The unique txid of the staged transaction

SystemService::StagedTxService::accept

void SystemService::StagedTxService::accept(
    uint32_t             id,
    psibase::Checksum256 txid
);

Indicates that the caller accepts the specified staged transaction.

Depending on the staging rules enforced by the auth service of the sender of the staged transaction, this could result in the execution of the transaction.

  • id: The ID of the database record containing the staged transaction
  • txid: The unique txid of the staged transaction

SystemService::StagedTxService::reject

void SystemService::StagedTxService::reject(
    uint32_t             id,
    psibase::Checksum256 txid
);

Indicates that the caller rejects the staged transaction.

  • id: The ID of the database record containing the staged transaction
  • txid: The unique txid of the staged transaction

SystemService::StagedTxService::get_staged_tx

StagedTx SystemService::StagedTxService::get_staged_tx(
    uint32_t id
);

Gets a staged transaction by id..

  • id: The ID of the database record containing the staged transaction