Struct OperatorServer

pub struct OperatorServer<C: CitreaClientT> {
    pub operator: Operator<C>,
    background_tasks: BackgroundTaskManager,
}

Fields

operator: Operator<C>

background_tasks: BackgroundTaskManager

Implementations

impl<C> OperatorServer<C>

where C: CitreaClientT,

pub async fn new(config: BridgeConfig) -> Result<Self, BridgeError>

pub async fn start_background_tasks(&self) -> Result<(), BridgeError>

Starts the background tasks for the operator. If called multiple times, it will restart only the tasks that are not already running.

pub async fn get_current_status(&self) -> Result<EntityStatus, BridgeError>

pub async fn shutdown(&mut self)

Trait Implementations

impl<C> ClementineOperator for OperatorServer<C>

where C: CitreaClientT,

type DepositSignStream = ReceiverStream<Result<SchnorrSig, Status>>

Server streaming response type for the DepositSign method.

type GetParamsStream = ReceiverStream<Result<OperatorParams, Status>>

Server streaming response type for the GetParams method.

fn get_compatibility_params<'life0, 'async_trait>( &'life0 self, _request: Request<Empty>, ) -> Pin<Box<dyn Future<Output = Result<Response<CompatibilityParamsRpc>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the protocol params that can affect the transactions in the contract, syncing with citrea and version number for checking compatibility

fn vergen<'life0, 'async_trait>( &'life0 self, _request: Request<Empty>, ) -> Pin<Box<dyn Future<Output = Result<Response<VergenResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn restart_background_tasks<'life0, 'async_trait>( &'life0 self, _request: Request<Empty>, ) -> Pin<Box<dyn Future<Output = Result<Response<Empty>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Restarts the background tasks for the operator.

fn get_params<'life0, 'async_trait>( &'life0 self, _request: Request<Empty>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::GetParamsStream>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns an operator’s parameters. It will be called once, by the aggregator, to set all the public keys.

fn deposit_sign<'life0, 'async_trait>( &'life0 self, request: Request<DepositSignSession>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::DepositSignStream>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Signs everything that includes Operator’s burn connector.

fn internal_withdraw<'life0, 'async_trait>( &'life0 self, request: Request<WithdrawParams>, ) -> Pin<Box<dyn Future<Output = Result<Response<RawSignedTx>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Prepares a withdrawal if it’s profitable and the withdrawal is correct and registered in Citrea bridge contract. If withdrawal is accepted, the payout tx will be added to the TxSender and success is returned, otherwise an error is returned. If automation is disabled, the withdrawal will not be accepted and an error will be returned. Note: This is intended for operator’s own use, so it doesn’t include a signature from aggregator.

fn withdraw<'life0, 'async_trait>( &'life0 self, request: Request<WithdrawParamsWithSig>, ) -> Pin<Box<dyn Future<Output = Result<Response<RawSignedTx>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

First, if verification address in operator’s config is set, the signature in rpc is checked to see if it was signed by the verification address. Then prepares a withdrawal if it’s profitable and the withdrawal is correct and registered in Citrea bridge contract. If withdrawal is accepted, the payout tx will be added to the TxSender and success is returned, otherwise an error is returned. If automation is disabled, the withdrawal will not be accepted and an error will be returned.

fn internal_create_assert_commitment_txs<'life0, 'async_trait>( &'life0 self, request: Request<TransactionRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<SignedTxsWithType>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates all assert transactions (AssertBegin, MiniAsserts, AssertEnd), signs them, and returns the raw txs in the same order.

fn get_deposit_keys<'life0, 'async_trait>( &'life0 self, request: Request<DepositParams>, ) -> Pin<Box<dyn Future<Output = Result<Response<OperatorKeys>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns an operator’s deposit keys. Deposit keys include Assert BitVM winternitz keys, and challenge ACK hashes.

fn internal_create_signed_txs<'life0, 'async_trait>( &'life0 self, request: Request<TransactionRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<SignedTxsWithType>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Signs all tx’s it can according to given transaction type (use it with AllNeededForDeposit to get almost all tx’s) Creates the transactions denoted by the deposit and operator_idx, round_idx, and kickoff_idx. It will create the transaction and sign it with the operator’s private key and/or saved nofn signatures.

fn internal_finalized_payout<'life0, 'async_trait>( &'life0 self, request: Request<FinalizedPayoutParams>, ) -> Pin<Box<dyn Future<Output = Result<Response<Txid>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn internal_end_round<'life0, 'async_trait>( &'life0 self, _request: Request<Empty>, ) -> Pin<Box<dyn Future<Output = Result<Response<Empty>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn get_x_only_public_key<'life0, 'async_trait>( &'life0 self, _request: Request<Empty>, ) -> Pin<Box<dyn Future<Output = Result<Response<XOnlyPublicKeyRpc>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the operator’s xonly public key

fn get_current_status<'life0, 'async_trait>( &'life0 self, _request: Request<Empty>, ) -> Pin<Box<dyn Future<Output = Result<Response<EntityStatus>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the current status of tasks running on the operator and their last synced heights.

fn get_reimbursement_txs<'life0, 'async_trait>( &'life0 self, request: Request<Outpoint>, ) -> Pin<Box<dyn Future<Output = Result<Response<SignedTxsWithType>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

For a given deposit outpoint, determines the next step in the kickoff process the operator is in, and returns the raw signed txs that the operator needs to send next, for enabling reimbursement process without automation.