chronicle/tasks/
mod.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
use crate::admin::AdminMsg;
use crate::runtime::Runtime;
use anyhow::{Context, Result};
use futures::channel::{mpsc, oneshot};
use futures::SinkExt;
use polkadot_sdk::sp_runtime::BoundedVec;
use scale_codec::Encode;
use std::collections::BTreeMap;
use std::sync::Arc;
use time_primitives::{
	Address32, BlockHash, BlockNumber, ErrorMsg, GmpEvent, GmpEvents, GmpParams, IConnector,
	NetworkId, ShardId, Task, TaskId, TaskResult, TssSignature, TssSigningRequest, MAX_GMP_EVENTS,
};
use tokio::sync::Mutex;
use tokio::task::JoinHandle;
use tracing::{event, span, Instrument, Level, Span};

#[derive(Clone)]
pub struct TaskParams {
	tss: mpsc::Sender<TssSigningRequest>,
	runtime: Arc<dyn Runtime>,
	connector: Arc<dyn IConnector>,
	admin: mpsc::Sender<AdminMsg>,
}

impl TaskParams {
	pub fn new(
		runtime: Arc<dyn Runtime>,
		connector: Arc<dyn IConnector>,
		tss: mpsc::Sender<TssSigningRequest>,
		admin: mpsc::Sender<AdminMsg>,
	) -> Self {
		Self { runtime, connector, tss, admin }
	}

	pub fn network(&self) -> NetworkId {
		self.connector.chain().network_id()
	}

	async fn finalized_block(&self) -> Result<u64> {
		let block = self.connector.finalized_block().await?;
		if let Err(e) = self.admin.clone().send(AdminMsg::NewTargetBlock(block as _)).await {
			event!(Level::ERROR, "Admin request error: {e:?}");
		};
		Ok(block)
	}

	async fn gas_price(&self) -> Result<u128> {
		let gas_price = self.connector.gas_price().await?;
		if let Err(e) = self.admin.clone().send(AdminMsg::NewGasPrice(gas_price)).await {
			event!(Level::ERROR, "Admin request error: {e:?}");
		};
		Ok(gas_price)
	}

	async fn tss_sign(
		&self,
		block: BlockNumber,
		shard_id: ShardId,
		task_id: TaskId,
		data: Vec<u8>,
		span: &Span,
	) -> Result<TssSignature> {
		tracing::debug!(parent: span, "tss_sign");
		let (tx, rx) = oneshot::channel();
		self.tss
			.clone()
			.send(TssSigningRequest {
				task_id,
				shard_id,
				block,
				data,
				tx,
			})
			.await?;
		let (_, sig) = rx.await?;
		Ok(sig)
	}

	async fn submit_events(
		&self,
		block_number: BlockNumber,
		shard_id: ShardId,
		task_id: TaskId,
		events: Vec<GmpEvent>,
		span: &Span,
	) -> Result<()> {
		let span = span!(parent: span, Level::INFO, "submit_events", gmp_events = ?events);
		let payload = time_primitives::encode_gmp_events(task_id, &events);
		let signature = self.tss_sign(block_number, shard_id, task_id, payload, &span).await?;
		let result = TaskResult::ReadGatewayEvents {
			events: GmpEvents(BoundedVec::truncate_from(events)),
			signature,
		};
		event!(parent: span, Level::DEBUG, "submitting task result");
		self.runtime.submit_task_result(task_id, result).await
	}

	#[allow(clippy::too_many_arguments)]
	async fn execute(
		self,
		block_hash: BlockHash,
		block_number: BlockNumber,
		network_id: NetworkId,
		gateway: Address32,
		gas_price: u128,
		shard_id: ShardId,
		task_id: TaskId,
		task: Task,
		span: Span,
	) -> Result<()> {
		let span = span!(
			parent: &span,
			Level::INFO,
			"executing task",
			gmp_task_id = task_id,
			gmp_task = %task,
		);
		event!(parent: &span, Level::DEBUG, "executing task");
		match task {
			Task::ReadGatewayEvents { blocks } => {
				tracing::info!(parent: &span, "Starting ReadGatewayEvents({:?})", &blocks);
				let events = self
					.connector
					.read_events(gateway, blocks)
					.instrument(span.clone())
					.await
					.context("read_events")?;
				tracing::info!(parent: &span, "Completed read {} events", events.len());
				let mut remaining = true;
				for chunk in events.chunks(MAX_GMP_EVENTS as _) {
					remaining = chunk.len() != MAX_GMP_EVENTS as usize;
					self.submit_events(block_number, shard_id, task_id, chunk.to_vec(), &span)
						.await?;
				}
				if remaining {
					self.submit_events(block_number, shard_id, task_id, vec![], &span).await?;
				}
			},
			Task::SubmitGatewayMessage { batch_id } => {
				let span =
					span!(parent: &span, Level::INFO, "submit_batch", gmp_batch_id = batch_id);
				let msg = self
					.runtime
					.batch_message(batch_id, block_hash)
					.await?
					.context("invalid task")?;
				let payload = GmpParams::new(network_id, gateway).hash(&msg.hash(batch_id));
				let signature =
					self.tss_sign(block_number, shard_id, task_id, payload, &span).await?;
				let signer = self
					.runtime
					.shard_commitment(shard_id, block_hash)
					.await?
					.context("invalid shard")?
					.0[0];
				tracing::info!(parent: &span, "submitting batch");
				if let Err(mut e) = self
					.connector
					.submit_commands(gateway, batch_id, msg, gas_price, signer, signature)
					.await
				{
					tracing::error!(parent: &span, "Error while executing batch: {e}");
					e.truncate(time_primitives::MAX_ERROR_LEN as usize - 4);
					let result = TaskResult::SubmitGatewayMessage {
						error: ErrorMsg(BoundedVec::truncate_from(e.encode())),
					};
					tracing::debug!(parent: &span, "submitting task result");
					self.runtime.submit_task_result(task_id, result).await?;
				}
			},
		}
		Ok(())
	}
}

pub struct TaskExecutor {
	params: TaskParams,
	running_tasks: BTreeMap<TaskId, JoinHandle<()>>,
}

impl TaskExecutor {
	pub fn new(params: TaskParams) -> Self {
		Self {
			params,
			running_tasks: Default::default(),
		}
	}

	pub async fn process_tasks(
		&mut self,
		block_hash: BlockHash,
		block_number: BlockNumber,
		shard_id: ShardId,
		span: &Span,
	) -> Result<(Vec<TaskId>, Vec<TaskId>, u64)> {
		let network = self.params.network();
		let gateway = self
			.params
			.runtime
			.gateway(network, block_hash)
			.await?
			.context("no gateway registered")?;
		let mut start_sessions = vec![];
		let tasks = self.params.runtime.shard_tasks(shard_id, block_hash).await?;

		let failed_tasks: Arc<Mutex<u64>> = Default::default();

		let max_gas_price =
			self.params.runtime.network_gas_price(self.params.network(), block_hash).await?;
		let current_gas_price = self.params.gas_price().await?;
		for task_id in tasks.iter().copied() {
			if current_gas_price > max_gas_price {
				tracing::warn!("Skipping {task_id} due to current gas_price: {current_gas_price} > max gas_price: {max_gas_price}");
				continue;
			}
			let total_failed = failed_tasks.clone();
			if self.running_tasks.contains_key(&task_id) {
				continue;
			}
			let task =
				self.params.runtime.task(task_id, block_hash).await?.context("invalid task")?;

			let chain_block = self.params.finalized_block().await?;

			let span = tracing::span!(
				parent: span,
				Level::INFO,
				"task",
				gmp_task_id = task_id,
				gmp_task = %task,
				chain_block,
			);

			if chain_block < task.start_block() {
				tracing::debug!(
					parent: &span,
					"task scheduled for future {:?}/{:?}",
					chain_block,
					task.start_block(),
				);
				continue;
			}

			tracing::info!(parent: &span, "task started");

			let exec = self.params.clone();
			let span2 = span.clone();
			let handle = tokio::task::spawn(async move {
				let _enter = span2.enter();
				match exec
					.execute(
						block_hash,
						block_number,
						network,
						gateway,
						current_gas_price,
						shard_id,
						task_id,
						task,
						span2.clone(),
					)
					.await
				{
					Ok(()) => {
						tracing::info!(parent: &span, "task completed");
					},
					Err(error) => {
						*total_failed.lock().await += 1;
						tracing::error!(parent: &span, ?error, "task failed");
					},
				};
			});
			start_sessions.push(task_id);
			self.running_tasks.insert(task_id, handle);
		}
		let mut completed_sessions = Vec::with_capacity(self.running_tasks.len());
		// remove from running task if task is completed or we dont receive anymore from pallet
		self.running_tasks.retain(|task_id, handle| {
			if tasks.contains(task_id) {
				true
			} else {
				if !handle.is_finished() {
					event!(
						parent: span,
						Level::DEBUG,
						gmp_task_id = task_id,
						"task aborted",
					);
					handle.abort();
				}
				completed_sessions.push(*task_id);
				false
			}
		});
		let failed_tasks = *failed_tasks.lock().await;
		Ok((start_sessions, completed_sessions, failed_tasks))
	}
}

#[cfg(test)]
mod tests {
	#[test]
	fn test_event_chunking_preserves_all_events() {
		const MAX_EVENTS: usize = 4;

		// Create a sample list of events
		let events: Vec<u32> = (1..=11).collect();

		// Perform chunking
		let event_chunks: Vec<Vec<_>> =
			events.chunks(MAX_EVENTS).map(|chunk| chunk.to_vec()).collect();

		// Flatten the chunks back into a single vector
		let flattened_events: Vec<_> = event_chunks.iter().flatten().copied().collect();

		// Ensure the original and reconstructed lists match
		assert_eq!(events, flattened_events, "Chunking should not lose any events");
	}
}