Add comments to projected nft fields

dcSpark · Dec 1, 2023 · 012ce13 · 012ce13
1 parent 1d0ba09
commit 012ce13
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 1 deletion.
diff --git a/indexer/migration/src/m20231025_000017_projected_nft.rs b/indexer/migration/src/m20231025_000017_projected_nft.rs
@@ -6,7 +6,7 @@ pub struct Migration;
 
 impl MigrationName for Migration {
     fn name(&self) -> &str {
-        "m20231025_000016_projected_nft"
+        "m20231025_000017_projected_nft"
     }
 }
 

diff --git a/webserver/shared/models/ProjectedNftRange.ts b/webserver/shared/models/ProjectedNftRange.ts
@@ -3,19 +3,83 @@ export type ProjectedNftRangeRequest = {
 };
 
 export type ProjectedNftRangeResponse = {
+    /**
+     * Slot at which the transaction happened
+     *
+     * @example 512345
+     */
     actionSlot: number,
 
+    /**
+     * Projected NFT owner address. Not null only if owned by Public Key Hash.
+     *
+     * @pattern [0-9a-fA-F]+
+     * @example "9040f057461d9adc09108fe5cb630077cf75c6e981d3ed91f6fb18f6"
+     */
     ownerAddress: string | null,
 
+    /**
+     * Transaction id of related Projected NFT event
+     *
+     * @pattern [0-9a-fA-F]{64}
+     * @example "28eb069e3e8c13831d431e3b2e35f58525493ab2d77fde83184993e4aa7a0eda"
+     */
     actionTxId: string | null,
+
+    /**
+     * Output index of related Projected NFT event. Null if it is claim event (No new UTxO is created).
+     *
+     * @example 1
+     */
     actionOutputIndex: number | null,
 
+    /**
+     * Transaction id of related previous Projected NFT event.
+     * E.g. you locked the NFT and get unlocking event: you will see previousTxHash = transaction hash of lock event.
+     * Null if event has `status` Lock.
+     *
+     * @pattern [0-9a-fA-F]{64}
+     * @example "28eb069e3e8c13831d431e3b2e35f58525493ab2d77fde83184993e4aa7a0eda"
+     */
     previousTxHash: string | null,
+    /**
+     * Output index of related previous Projected NFT event. Null if event has `status` Lock.
+     *
+     * @example 1
+     */
     previousTxOutputIndex: number | null,
 
+    /**
+     * Asset that relates to Projected NFT event. Consists of 2 parts: PolicyId and AssetName
+     *
+     * @pattern [0-9a-fA-F]+.[0-9a-fA-F]+
+     * @example "96f7dc9749ede0140f042516f4b723d7261610d6b12ccb19f3475278.415045"
+     */
     asset: string,
+    /**
+     * Number of assets of `asset` type used in this Projected NFT event.
+     *
+     * @example 1
+     */
     amount: number,
+    /**
+     * Projected NFT status: Lock / Unlocking / Claim / Invalid
+     *
+     * @example "Lock"
+     */
     status: string | null,
+    /**
+     * Projected NFT datum: serialized state of the Projected NFT
+     *
+     * @pattern [0-9a-fA-F]+
+     * @example "d8799fd8799f581c9040f057461d9adc09108fe5cb630077cf75c6e981d3ed91f6fb18f6ffd87980ff"
+     */
     plutusDatum: string | null,
+    /**
+     * UNIX timestamp till which the funds can't be claimed in the Unlocking state.
+     * If the status is not Unlocking this is always null.
+     *
+     * @example 1701266986000
+     */
     forHowLong: number | null,
 }[];