@dcspark/carp-client - npm Package Compare versions

Comparing version 2.4.1 to 3.0.0

client/src/paginated.js

@@ -75,3 +75,3 @@ "use strict";
         for (const [assetName, cbor] of Object.entries(assetNames)) {
-            const metadatum = cmlTransactioMetadatum.from_bytes(Buffer.from(cbor, "hex"));
+            const metadatum = cmlTransactioMetadatum.from_cbor_bytes(Buffer.from(cbor, "hex"));
             const json = decode_metadatum_to_json_str(metadatum, conversionType);
@@ -78,0 +78,0 @@ newAssetNameMap[assetName] = json;

package.json

 {
   "name": "@dcspark/carp-client",
-  "version": "2.4.1",
+  "version": "3.0.0",
   "description": "Web client for the Carp server",
@@ -30,3 +30,3 @@ "main": "app/index.js",
   "devDependencies": {
-    "@dcspark/cardano-multiplatform-lib-nodejs": "3.0.1",
+    "@dcspark/cardano-multiplatform-lib-nodejs": "5.2.0",
     "@types/eslint": "8.4.6",
@@ -33,0 +33,0 @@ "@types/eslint-plugin-prettier": "3.1.0",

shared/constants.d.ts

@@ -26,11 +26,14 @@ export declare const ADDRESS_LIMIT: {
 export declare const PROJECTED_NFT_LIMIT: {
-    SLOT_RANGE: number;
-    SINGLE_USER_SLOT_RANGE: number;
+    DEFAULT_PAGE_SIZE: number;
 };
 export declare const POOL_DELEGATION_LIMIT: {
     POOLS: number;
-    SLOT_RANGE: number;
+    DEFAULT_PAGE_SIZE: number;
 };
 export declare const ASSET_UTXOS_LIMIT: {
     ASSETS: number;
+    DEFAULT_PAGE_SIZE: number;
 };
+export declare const MINT_BURN_HISTORY_LIMIT: {
+    DEFAULT_PAGE_SIZE: number;
+};

shared/constants.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ASSET_UTXOS_LIMIT = exports.POOL_DELEGATION_LIMIT = exports.PROJECTED_NFT_LIMIT = exports.DEX_PRICE_LIMIT = exports.BLOCK_LIMIT = exports.CREDENTIAL_LIMIT = exports.ASSET_LIMIT = exports.UTXO_LIMIT = exports.ADDRESS_LIMIT = void 0;
+exports.MINT_BURN_HISTORY_LIMIT = exports.ASSET_UTXOS_LIMIT = exports.POOL_DELEGATION_LIMIT = exports.PROJECTED_NFT_LIMIT = exports.DEX_PRICE_LIMIT = exports.BLOCK_LIMIT = exports.CREDENTIAL_LIMIT = exports.ASSET_LIMIT = exports.UTXO_LIMIT = exports.ADDRESS_LIMIT = void 0;
 // TODO: make these a mapping from out to object instead of standalone structs
@@ -30,11 +30,14 @@ exports.ADDRESS_LIMIT = {
 exports.PROJECTED_NFT_LIMIT = {
-    SLOT_RANGE: 100000,
-    SINGLE_USER_SLOT_RANGE: 10000000000,
+    DEFAULT_PAGE_SIZE: 50,
 };
 exports.POOL_DELEGATION_LIMIT = {
     POOLS: 50,
-    SLOT_RANGE: 10000,
+    DEFAULT_PAGE_SIZE: 50,
 };
 exports.ASSET_UTXOS_LIMIT = {
     ASSETS: 50,
+    DEFAULT_PAGE_SIZE: 50,
 };
+exports.MINT_BURN_HISTORY_LIMIT = {
+    DEFAULT_PAGE_SIZE: 50,
+};

shared/models/AssetUtxos.d.ts

 import { AssetName, PolicyId } from "./PolicyIdAssetMap";
+import { Pagination, SlotLimits } from "./common";
 /**
@@ -7,27 +8,30 @@ * @example "asset1c43p68zwjezc7f6w4w9qkhkwv9ppwz0f7c3amw"
 export declare type AssetUtxosRequest = {
-    range: {
-        minSlot: number;
-        maxSlot: number;
-    };
     fingerprints?: Cip14Fingerprint[];
     policyIds?: PolicyId[];
-};
+    /** This limits the transactions in the result to this range of slots.
+     * Everything else is filtered out */
+    slotLimits?: SlotLimits;
+    limit?: number;
+} & Pagination;
 export declare type AssetUtxosResponse = {
-    /**
-     * If the utxo is created, this has the amount. It's undefined if the utxo
-     * is spent.
-     *
-     * @example '1031423725351'
-     */
-    amount: string | undefined;
-    utxo: {
-        tx: string;
-        index: number;
-    };
-    cip14Fingerprint: string;
-    policyId: string;
-    assetName: AssetName;
-    paymentCred: string;
-    slot: number;
+    payload: {
+        /**
+         * If the utxo is created, this has the amount. It's undefined if the utxo
+         * is spent.
+         *
+         * @example '1031423725351'
+         */
+        amount: string | undefined;
+        cip14Fingerprint: string;
+        policyId: string;
+        assetName: AssetName;
+        paymentCred: string;
+        slot: number;
+        utxo: {
+            tx: string;
+            index: number;
+        };
+    }[];
     txId: string;
+    block: string;
 }[];

shared/models/common.d.ts

@@ -107,1 +107,5 @@ import { AssetName, PolicyId } from "./PolicyIdAssetMap";
 export declare type Amount = string;
+export declare type SlotLimits = {
+    from: number;
+    to: number;
+};

shared/models/DelegationForPool.d.ts

@@ -0,1 +1,2 @@
+import type { Pagination, SlotLimits } from "./common";
 import { Address } from "./Address";
@@ -5,12 +6,15 @@ import { Pool, PoolHex } from "./Pool";
     pools: Pool[];
-    range: {
-        minSlot: number;
-        maxSlot: number;
-    };
-};
+    /** This limits the transactions in the result to this range of slots.
+     * Everything else is filtered out */
+    slotLimits?: SlotLimits;
+    limit?: number;
+} & Pagination;
 export declare type DelegationForPoolResponse = {
-    credential: Address;
-    pool: PoolHex | null;
+    payload: {
+        credential: Address;
+        pool: PoolHex | null;
+        slot: number;
+    }[];
     txId: string;
-    slot: number;
+    block: string;
 }[];

shared/models/ProjectedNftRange.d.ts

@@ -0,21 +1,7 @@
+import { Pagination, SlotLimits } from "./common";
 export declare type ProjectedNftRangeRequest = {
-    /**
-     * Projected NFT events in this slot range will be returned
-     */
-    range: {
-        /**
-         * Minimal slot from which the events should be returned (not inclusive)
-         *
-         * @example 46154769
-         */
-        minSlot: number;
-        /**
-         * Maximal slot from which the events should be returned (inclusive)
-         *
-         * @example 46154860
-         */
-        maxSlot: number;
-    };
     address: string | undefined;
-};
+    slotLimits?: SlotLimits;
+    limit?: number;
+} & Pagination;
 export declare enum ProjectedNftStatus {
@@ -28,16 +14,80 @@ Lock = "Lock",
 export declare type ProjectedNftRangeResponse = {
+    payload: {
+        /**
+         * 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;
+        /**
+         * 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 policy id that relates to Projected NFT event
+         *
+         * @pattern [0-9a-fA-F]{56}
+         * @example "96f7dc9749ede0140f042516f4b723d7261610d6b12ccb19f3475278"
+         */
+        policyId: string;
+        /**
+         * Asset name that relates to Projected NFT event
+         *
+         * @pattern ([0-9a-fA-F]{2}){0,32}
+         * @example "415045"
+         */
+        assetName: string;
+        /**
+         * Number of assets of `asset` type used in this Projected NFT event.
+         *
+         * @example "1"
+         */
+        amount: string;
+        /**
+         * Projected NFT status: Lock / Unlocking / Claim / Invalid
+         *
+         * @example "Lock"
+         */
+        status: ProjectedNftStatus;
+        /**
+         * Projected NFT datum: serialized state of the Projected NFT
+         *
+         * @pattern [0-9a-fA-F]+
+         * @example "d8799fd8799f581c9040f057461d9adc09108fe5cb630077cf75c6e981d3ed91f6fb18f6ffd87980ff"
+         */
+        plutusDatum: string;
+        /**
+         * 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: string | null;
+    }[];
+    block: string;
     /**
-     * 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
@@ -48,64 +98,3 @@ *
      */
-    actionTxId: string;
-    /**
-     * 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 policy id that relates to Projected NFT event
-     *
-     * @pattern [0-9a-fA-F]{56}
-     * @example "96f7dc9749ede0140f042516f4b723d7261610d6b12ccb19f3475278"
-     */
-    policyId: string;
-    /**
-     * Asset name that relates to Projected NFT event
-     *
-     * @pattern ([0-9a-fA-F]{2}){0,32}
-     * @example "415045"
-     */
-    assetName: string;
-    /**
-     * Number of assets of `asset` type used in this Projected NFT event.
-     *
-     * @example "1"
-     */
-    amount: string;
-    /**
-     * Projected NFT status: Lock / Unlocking / Claim / Invalid
-     *
-     * @example "Lock"
-     */
-    status: ProjectedNftStatus;
-    /**
-     * Projected NFT datum: serialized state of the Projected NFT
-     *
-     * @pattern [0-9a-fA-F]+
-     * @example "d8799fd8799f581c9040f057461d9adc09108fe5cb630077cf75c6e981d3ed91f6fb18f6ffd87980ff"
-     */
-    plutusDatum: string;
-    /**
-     * 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: string | null;
+    txId: string;
 }[];

shared/models/ProjectedNftRange.js

@@ -11,2 +11,1 @@ "use strict";
 })(ProjectedNftStatus = exports.ProjectedNftStatus || (exports.ProjectedNftStatus = {}));
-;

shared/models/TransactionHistory.d.ts

 import type { Address } from "./Address";
 import type { BlockSubset } from "./BlockLatest";
-import type { Pagination, RelationFilter } from "./common";
+import type { Pagination, RelationFilter, SlotLimits } from "./common";
 export declare type TransactionHistoryRequest = {
@@ -10,2 +10,8 @@ addresses: Address[];
     limit?: number;
+    /** This limits the transactions in the result to this range of slots.
+     * Everything else is filtered out */
+    slotLimits?: SlotLimits;
+    /** If this is set to true, the result includes the input addresses (which are
+     * not part of the tx), and the metadata (if any) */
+    withInputContext?: boolean;
 } & Pagination;
@@ -31,2 +37,4 @@ export declare type BlockInfo = BlockSubset & {
     payload: string;
+    metadata?: string | null;
+    inputCredentials?: string[];
 };
@@ -33,0 +41,0 @@ export declare type TxAndBlockInfo = {

shared/routes.d.ts

@@ -14,2 +14,3 @@ import type { AddressUsedRequest, AddressUsedResponse } from "./models/AddressUsed";
 import { AssetUtxosRequest, AssetUtxosResponse } from "./models/AssetUtxos";
+import type { MintBurnHistoryRequest, MintBurnHistoryResponse } from "./models/MintBurn";
 export declare enum Routes {
@@ -28,3 +29,4 @@ transactionHistory = "transaction/history",
     projectedNftEventsRange = "projected-nft/range",
-    assetUtxos = "asset/utxos"
+    assetUtxos = "asset/utxos",
+    mintBurnHistory = "asset/mint-burn-history"
 }
@@ -97,2 +99,7 @@ export declare type EndpointTypes = {
     };
+    [Routes.mintBurnHistory]: {
+        name: typeof Routes.mintBurnHistory;
+        input: MintBurnHistoryRequest;
+        response: MintBurnHistoryResponse;
+    };
 };

shared/routes.js

@@ -19,2 +19,3 @@ "use strict";
     Routes["assetUtxos"] = "asset/utxos";
+    Routes["mintBurnHistory"] = "asset/mint-burn-history";
 })(Routes = exports.Routes || (exports.Routes = {}));

No alert changes

Improved metrics

Total package byte prevSize

49686

increased by6.42%

Number of package files

46

increased by4.55%

Lines of code

1267

increased by5.85%

No dependency changes