feat(tee): add error handling for unstable_getTeeProofs API endpoint

[pbeza]

What ❔

This PR adds more information to the response of the unstable_getTeeProofs API endpoint, enabling the client that sent the request to determine whether it makes sense to retry fetching the TEE proof for a particular batch number.

Why ❔

Currently, the TEE verifier – the tool for continuous SGX attestation and batch signature verification – is stuck on batches that failed to be proven and are marked as permanently_ignored. The tool should be able to distinguish between batches that are permanently ignored (and should be skipped) and batches that have failed but will be retried. This PR enables that distinction.

Example use cases:

• requesting TEE proof for a batch with the permanently_ignored status

  $ curl -i -X POST -H "Content-Type: application/json" --data '{"jsonrpc": "2.0", "id": 1, "method": "unstable_getTeeProofs", "params": [14, "sgx"] }' 'http://localhost:3152'
  HTTP/1.1 200 OK
  content-type: application/json; charset=utf-8
  vary: origin, access-control-request-method, access-control-request-headers
  access-control-allow-origin: *
  content-length: 207
  date: Tue, 26 Nov 2024 12:42:48 GMT
  
  {"jsonrpc":"2.0","result":[{"l1BatchNumber":14,"teeType":"sgx","pubkey":null,"signature":null,"proof":null,"provedAt":"2024-11-20T15:43:46.112146Z","status":"permanently_ignored","attestation":null}],"id":1}
  

• requesting TEE proof for a batch with the failed status

  $ curl -i -X POST -H "Content-Type: application/json" --data '{"jsonrpc": "2.0", "id": 1, "method": "unstable_getTeeProofs", "params": [15, "sgx"] }' 'http://localhost:3152'
  HTTP/1.1 200 OK
  content-type: application/json; charset=utf-8
  vary: origin, access-control-request-method, access-control-request-headers
  access-control-allow-origin: *
  content-length: 194
  date: Tue, 26 Nov 2024 12:44:19 GMT
  
  {"jsonrpc":"2.0","result":[{"l1BatchNumber":15,"teeType":"sgx","pubkey":null,"signature":null,"proof":null,"provedAt":"2024-11-20T15:43:46.121432Z","status":"failed","attestation":null}],"id":1}
  

• requesting TEE proof for a batch with the generated status

  $ curl -i  -X POST -H "Content-Type: application/json"     --data '{"jsonrpc": "2.0", "id": 1, "method": "unstable_getTeeProofs", "params": [28, "sgx"] }' 'http://localhost:3152'
  HTTP/1.1 200 OK
  content-type: application/json; charset=utf-8
  vary: origin, access-control-request-method, access-control-request-headers
  access-control-allow-origin: *
  content-length: 229
  date: Tue, 26 Nov 2024 12:45:27 GMT
  
  {"jsonrpc":"2.0","result":[{"l1BatchNumber":28,"teeType":"sgx","pubkey":"0506070809","signature":"0001020304","proof":"1011121314","provedAt":"2024-11-20T15:21:16.129128Z","status":"generated","attestation":"0403020100"}],"id":1}
  

• requesting TEE proof for a non-existent batch

  $ curl -i -X POST -H "Content-Type: application/json" --data '{"jsonrpc": "2.0", "id": 1, "method": "unstable_getTeeProofs", "params": [1337, "sgx"] }' 'http://localhost:3152'
  HTTP/1.1 200 OK
  content-type: application/json; charset=utf-8
  vary: origin, access-control-request-method, access-control-request-headers
  access-control-allow-origin: *
  content-length: 36
  date: Tue, 26 Nov 2024 12:46:08 GMT
  
  {"jsonrpc":"2.0","result":[],"id":1}
  

Relevant database entries for the use cases mentioned above:

zksync_server_localhost_legacy=# SELECT * FROM tee_proof_generation_details WHERE l1_batch_number IN (14, 15, 28, 1337);
 l1_batch_number |       status        |  signature   |    pubkey    |    proof     | tee_type |         created_at         |         updated_at         |      prover_taken_at       
-----------------+---------------------+--------------+--------------+--------------+----------+----------------------------+----------------------------+----------------------------
              14 | permanently_ignored |              |              |              | sgx      | 2023-11-20 15:27:47.281293 | 2024-11-20 15:43:46.112146 | 2024-11-20 15:43:46.106042
              15 | failed              |              |              |              | sgx      | 2024-11-20 15:27:47.287777 | 2024-11-20 15:43:46.121432 | 2024-11-20 15:43:46.115853
              28 | generated           | \x0001020304 | \x0506070809 | \x1011121314 | sgx      | 2024-11-20 12:56:33.055642 | 2024-11-20 15:21:16.129128 | 2024-11-20 14:53:14.25949
(3 rows)

Checklist

• PR title corresponds to the body of PR (we generate changelog entries from PRs).
• Tests for the changes have been added / updated.
• Documentation comments have been added / updated.
• Code has been formatted via zkstack dev fmt and zkstack dev lint.

[pbeza]

I get that exposing the status directly from the database (line 58 below) might not be the best idea, since any changes to the status types would instantly show up on the client side, making the API unstable. That said, I’m not sure how to handle this in a cleaner way. Open to any suggestions you've got, @slowli @haraldh.

zksync-era/core/node/api_server/src/web3/namespaces/unstable.rs

Lines 39 to 68 in 41ce9d0

	pub async fn get_tee_proofs_impl(
	&self,
	l1_batch_number: L1BatchNumber,
	tee_type: Option<TeeType>,
	) -> Result<Vec<TeeProof>, Web3Error> {
	let mut storage = self.state.acquire_connection().await?;
	let proofs = storage
	.tee_proof_generation_dal()
	.get_tee_proofs(l1_batch_number, tee_type)
	.await
	.map_err(DalError::generalize)?
	.into_iter()
	.map(|proof| TeeProof {
	l1_batch_number,
	tee_type,
	pubkey: proof.pubkey,
	signature: proof.signature,
	proof: proof.proof,
	proved_at: DateTime::<Utc>::from_naive_utc_and_offset(proof.updated_at, Utc),
	status: proof.status,
	attestation: proof.attestation,
	})
	.collect::<Vec<_>>();
	if proofs.is_empty() {
	return Err(Web3Error::NoBlock);
	}
	Ok(proofs)
	}

[slowli]

Regarding the status field: I don't think this is a large concern as long as the corresponding RPC method is unstable.

[pbeza]

JFYI: this commit goes hand in hand with the following PR: matter-labs/teepot#221 (feel free to review it).

@haraldh pls review/merge when you get a chance. Thanks!