wip getAssetSignatures

Author: MarkSackerberg

clients/js/src/decorator.ts

@@ -11,6 +11,7 @@ import {
   SearchAssetsRpcInput,
   GetAssetSignaturesRpcResponse,
   GetAssetProofsRpcResponse,
+  GetAssetSignaturesRpcInput,
 } from './types';
 
 export interface DasApiInterface {
@@ -84,10 +85,10 @@ export interface DasApiInterface {
   /**
    * Return the transaction signatures for a compressed asset
    *
-   * @param assetId the id of the asset to fetch the signatures for
+   * @param input the input parameters for the RPC call
    */
   getAssetSignatures(
-    assetId: PublicKey
+    input: GetAssetSignaturesRpcInput
   ): Promise<GetAssetSignaturesRpcResponse>;
 }
 
@@ -256,13 +257,22 @@ export const createDasApiDecorator = (
     }
     return assetList;
   },
-  getAssetSignatures: async (assetId: PublicKey) => {
+  getAssetSignatures: async (input: GetAssetSignaturesRpcInput) => {
     const signatures = await rpc.call<GetAssetSignaturesRpcResponse | null>(
       'getAssetSignaturesV2',
-      [assetId]
+      [ input.assetId,
+        input.limit ?? null,
+        input.page ?? null,
+        input.before ?? null,
+        input.after ?? null,
+        input.tree ?? null,
+        input.leaf_index ?? null,
+        input.cursor ?? null,
+        input.sort_direction ?? null,
+      ]
     );
     if (!signatures)
-      throw new DasApiError(`No signatures found for asset: ${assetId}`);
+      throw new DasApiError(`No signatures found for asset: ${input.assetId}`);
     return signatures;
   },
 });

clients/js/src/types.ts

@@ -1,7 +1,6 @@
 import {
   Nullable,
   PublicKey,
-  TransactionSignature,
 } from '@metaplex-foundation/umi';
 
 // ---------------------------------------- //
@@ -451,6 +450,59 @@ export type GetAssetProofsRpcResponse = Record<
   GetAssetProofRpcResponse
 >;
 
+export type GetAssetSignaturesRpcInput = {
+  /**
+   * The Asset ID to retrieve signatures for.
+   */
+  assetId?: Nullable<PublicKey>;
+
+  /**
+   * The maximum number of assets to retrieve.
+   */
+  limit?: Nullable<number>; 
+
+  /**
+   * The page number of the signatures.
+   */
+  page?: Nullable<number>;
+
+  /**
+   * Retrieve signatures before the specified `ID` value.
+   */
+  before?: Nullable<string>;
+
+  /**
+   * Retrieve signatures after the specified `ID` value.
+   */
+  after?: Nullable<string>;
+
+  /**
+   * The tree ID to retrieve signatures for.
+   */
+  tree?: Nullable<PublicKey>;
+
+  /**
+   * The leaf index to retrieve signatures for.
+   */
+  leaf_index?: Nullable<number>;
+
+  /**
+   * 
+   */
+  cursor?: Nullable<string>;
+
+  /**
+   * The sort direction.
+   */
+  sort_direction?: Nullable<'asc' | 'desc'>;
+};
+
+export type DasApiTransactionSignature = {
+  signature: string;
+  instruction: string;
+  slot: number;
+};
+
 export type GetAssetSignaturesRpcResponse = {
   /**
    * total number of signatures in the list.
@@ -464,13 +516,16 @@ export type GetAssetSignaturesRpcResponse = {
    */
   limit: number;
 
+  before: string,
+  after: string,
+
   /**
    * The page number of the signatures.
    */
-  page: number;
+  page?: number;
 
   /**
    * List of individual signatures.
    */
-  signatures: TransactionSignature[];
+  items: DasApiTransactionSignature[];
 };

clients/js/test/getAssetSignatures.test.ts

@@ -1,20 +1,34 @@
 import { publicKey } from '@metaplex-foundation/umi';
 import test from 'ava';
-import { GetAssetSignaturesRpcResponse } from '../src';
+import {
+  DasApiTransactionSignature,
+} from '../src';
 import { DAS_API_ENDPOINTS, createUmi } from './_setup';
 
 DAS_API_ENDPOINTS.forEach((endpoint) => {
-  test(`it can fetch the proof of a compressed asset by ID (${endpoint.name})`, async (t) => {
+  test(`it can fetch the signatures of a compressed asset by ID (${endpoint.name})`, async (t) => {
     // Given a minted NFT on mainnet.
     const umi = createUmi(endpoint.url);
-    const assetId = publicKey('5equc6uNZj75zb6yYLUUyy3WnAUmuuwmGZthz2oxUCtx');
+    const assetId = publicKey('GGRbPQhwmo3dXBkJSAjMFc1QYTKGBt8qc11tTp3LkEKA');
 
-    // When we fetch the proof of the asset using its ID.
-    const signatures = await umi.rpc.getAssetSignatures(assetId);
+    // When we fetch the Signatures for the asset.
+    const signatures = await umi.rpc.getAssetSignatures({ assetId });
 
-    console.log(signatures);
-
-    // Then we expect the following data.
-    t.like(signatures, <GetAssetSignaturesRpcResponse>{});
+    // Then we expect to find 2 signatures.
+    t.is(signatures.total, 2);
+    t.is(signatures.limit, 1000);
+    t.is(signatures.items.length, 2);
+    t.like(signatures.items[0], <DasApiTransactionSignature>{
+      signature:
+        '3Ki9QJTC2V1oNhkkhvJAJ4DEBRdMMrvKqctsyPhGL5JGkZz72xAsgTQh4vAEuJNtkxTxdmWg7RhkSXwU2JNRdSVh',
+      instruction: 'MintToCollectionV1',
+      slot: 356098299,
+    });
+    t.like(signatures.items[1], <DasApiTransactionSignature>{
+      signature:
+        '4rNhZukEBfuGxWxesRgStu1PqvStycu1fhNiftXVUcCygazXLpz6BubNCMywBW9eQLKtLa58FSqgyjDxHSTuFYy8',
+      instruction: 'CreateTree',
+      slot: 356098214,
+    });
   });
 });