feat: x-ar-io-root-transaction-id header

src/constants.ts

@@ -24,6 +24,7 @@ export const headerNames = {
   stable: 'X-AR-IO-Stable',
   verified: 'X-AR-IO-Verified',
   cache: 'X-Cache',
+  rootTransactionId: 'X-AR-IO-Root-Transaction-Id',
   arnsTtlSeconds: 'X-ArNS-TTL-Seconds',
   arnsResolvedId: 'X-ArNS-Resolved-Id',
   arnsProcessId: 'X-ArNS-Process-Id',

src/database/sql/core/data-attributes.sql

@@ -1,19 +1,19 @@
 -- selectDataAttributes
 SELECT *
 FROM (
-  SELECT data_root, data_size, content_type, content_encoding, true AS stable
+  SELECT data_root, data_size, content_type, content_encoding, null AS root_transaction_id, true AS stable
   FROM stable_transactions
   WHERE id = @id
   UNION
-  SELECT data_root, data_size, content_type, content_encoding, false AS stable
+  SELECT data_root, data_size, content_type, content_encoding, null AS root_transaction_id, false AS stable
   FROM new_transactions
   WHERE id = @id
   UNION
-  SELECT null, data_size, content_type, content_encoding, true AS stable
+  SELECT null AS data_root, data_size, content_type, content_encoding, root_transaction_id, true AS stable
   FROM bundles.stable_data_items
   WHERE id = @id
   UNION
-  SELECT null, data_size, content_type, content_encoding, false AS stable
+  SELECT null AS data_root, data_size, content_type, content_encoding, root_transaction_id, false AS stable
   FROM bundles.new_data_items
   WHERE id = @id
 )

src/database/standalone-sqlite.ts

@@ -981,12 +981,19 @@ export class StandaloneSqliteDatabaseWorker {
     const hash = dataRow?.hash;
     const dataRoot = coreRow?.data_root;
 
+    const rootTransactionId =
+      coreRow?.root_transaction_id !== null &&
+      coreRow?.root_transaction_id !== undefined
+        ? toB64Url(coreRow.root_transaction_id)
+        : undefined;
+
     return {
       hash: hash ? toB64Url(hash) : undefined,
       dataRoot: dataRoot ? toB64Url(dataRoot) : undefined,
       size: coreRow?.data_size ?? dataRow?.data_size,
-      contentType,
       contentEncoding: coreRow?.content_encoding,
+      contentType,
+      rootTransactionId,
       isManifest: contentType === MANIFEST_CONTENT_TYPE,
       stable: coreRow?.stable === true,
       verified: dataRow?.verified === 1,

src/routes/data/handlers.test.ts

@@ -672,6 +672,65 @@ st
             });
         });
       });
+
+      describe('X-AR-IO-Root-Transaction-Id', () => {
+        it("shouldn't return root transaction id for transactions", async () => {
+          app.get(
+            '/:id',
+            createDataHandler({
+              log,
+              dataIndex,
+              dataSource,
+              blockListValidator,
+              manifestPathResolver,
+            }),
+          );
+
+          return request(app)
+            .get('/not-a-real-id')
+            .expect(200)
+            .then((res: any) => {
+              assert.equal(
+                res.headers['x-ar-io-root-transaction-id'],
+                undefined,
+              );
+            });
+        });
+
+        it('should return root transaction id for data items', async () => {
+          dataIndex.getDataAttributes = () =>
+            Promise.resolve({
+              size: 10,
+              contentType: 'application/octet-stream',
+              rootTransactionId: 'root-tx',
+              isManifest: false,
+              stable: true,
+              verified: true,
+              signature: null,
+            });
+
+          app.get(
+            '/:id',
+            createDataHandler({
+              log,
+              dataIndex,
+              dataSource,
+              blockListValidator,
+              manifestPathResolver,
+            }),
+          );
+
+          return request(app)
+            .get('/not-a-real-id')
+            .expect(200)
+            .then((res: any) => {
+              assert.equal(
+                res.headers['x-ar-io-root-transaction-id'],
+                'root-tx',
+              );
+            });
+        });
+      });
     });
   });
 });

src/routes/data/handlers.ts

@@ -73,9 +73,6 @@ const setDataHeaders = ({
   dataAttributes: ContiguousDataAttributes | undefined;
   data: ContiguousData;
 }) => {
-  // TODO add etag
-  // TODO add header indicating stability
-  // TODO add header indicating whether data is verified
   // TODO cached header for zero length data (maybe...)
 
   // Allow range requests
@@ -123,6 +120,10 @@ const setDataHeaders = ({
     res.header('Content-Encoding', dataAttributes.contentEncoding);
   }
 
+  if (dataAttributes?.rootTransactionId !== undefined) {
+    res.header(headerNames.rootTransactionId, dataAttributes.rootTransactionId);
+  }
+
   setDigestStableVerifiedHeaders({ res, dataAttributes, data });
 };
 

src/types.d.ts

@@ -506,7 +506,8 @@ export interface ContiguousDataAttributes {
   dataRoot?: string;
   size: number;
   contentEncoding?: string;
-  contentType: string | undefined;
+  contentType?: string;
+  rootTransactionId?: string;
   isManifest: boolean;
   stable: boolean;
   verified: boolean;

test/end-to-end/data.test.ts

@@ -46,6 +46,8 @@ const tx3 = 'lbeIMUvoEqR2q-pKsT4Y5tz6mm9ppemReyLnQ8P7XpM';
 // manifest with paths without trailing slash
 const tx4 = 'sYaO7sklQ8FyObQNLy7kDbEvwUNKKes7mUnv-_Ri9bE';
 
+const bundle1 = '73QwVewKc0hXmuiaahtGJqHEY5pb85SoqCC33VE0Teg';
+
 describe('Data', function () {
   let compose: StartedDockerComposeEnvironment;
 
@@ -277,6 +279,60 @@ describe('X-Cache header', function () {
   });
 });
 
+describe('X-AR-IO-Root-Transaction-Id header', function () {
+  let compose: StartedDockerComposeEnvironment;
+
+  before(async function () {
+    await rimraf(`${projectRootPath}/data/sqlite/*.db*`, { glob: true });
+
+    compose = await new DockerComposeEnvironment(
+      projectRootPath,
+      'docker-compose.yaml',
+    )
+      .withEnvironment({
+        START_HEIGHT: '1',
+        STOP_HEIGHT: '1',
+        GET_DATA_CIRCUIT_BREAKER_TIMEOUT_MS: '100000',
+        ANS104_UNBUNDLE_FILTER: '{"always": true}',
+        ANS104_INDEX_FILTER: '{"always": true}',
+        ADMIN_API_KEY: 'secret',
+      })
+      .withBuild()
+      .withWaitStrategy('core-1', Wait.forHttp('/ar-io/info', 4000))
+      .up(['core']);
+
+    await axios.post(
+      'http://localhost:4000/ar-io/admin/queue-bundle',
+      { id: bundle1 },
+      {
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: 'Bearer secret',
+        },
+      },
+    );
+
+    // hopefully enough time to unbundle it
+    await wait(10000);
+  });
+
+  after(async function () {
+    await compose.down();
+  });
+
+  it('Verifying header for trascation', async function () {
+    const bundleRes = await axios.head(`http://localhost:4000/raw/${bundle1}`);
+
+    assert.equal(bundleRes.headers['x-ar-io-root-transaction-id'], undefined);
+  });
+
+  it('Verifying header for data item', async function () {
+    const datasItemRes = await axios.head(`http://localhost:4000/raw/${tx1}`);
+
+    assert.equal(datasItemRes.headers['x-ar-io-root-transaction-id'], bundle1);
+  });
+});
+
 describe('X-AR-IO headers', function () {
   describe('with ARNS_ROOT_HOST', function () {
     let compose: StartedDockerComposeEnvironment;