@fairmint/canton-node-sdk 0.0.114 → 0.0.115
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.d.ts +27 -0
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.js +31 -2
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.js.map +1 -1
- package/package.json +1 -1
|
@@ -2,6 +2,32 @@ import { z } from 'zod';
|
|
|
2
2
|
import type { LedgerJsonApiClient } from '../../../LedgerJsonApiClient.generated';
|
|
3
3
|
import { type JsCantonErrorSchema, type WsCantonErrorSchema } from '../../../schemas/api/errors';
|
|
4
4
|
import { type JsUpdateSchema, type WsUpdateSchema } from '../../../schemas/api/updates';
|
|
5
|
+
/**
|
|
6
|
+
* The `TransactionShape` enum defines the event shape for `Transaction`s and can have two different flavors AcsDelta
|
|
7
|
+
* and LedgerEffects.
|
|
8
|
+
*
|
|
9
|
+
* ```protobuf
|
|
10
|
+
* enum TransactionShape {
|
|
11
|
+
* TRANSACTION_SHAPE_ACS_DELTA = 1;
|
|
12
|
+
* TRANSACTION_SHAPE_LEDGER_EFFECTS = 2;
|
|
13
|
+
* }
|
|
14
|
+
* ```
|
|
15
|
+
*
|
|
16
|
+
* - AcsDelta
|
|
17
|
+
*
|
|
18
|
+
* The transaction shape that is sufficient to maintain an accurate ACS view. This translates to create and archive
|
|
19
|
+
* events. The field witness_parties in events are populated as stakeholders, transaction filter will apply
|
|
20
|
+
* accordingly.
|
|
21
|
+
* - LedgerEffects
|
|
22
|
+
*
|
|
23
|
+
* The transaction shape that allows maintaining an ACS and also conveys detailed information about all exercises. This
|
|
24
|
+
* translates to create, consuming exercise and non-consuming exercise. The field witness_parties in events are
|
|
25
|
+
* populated as cumulative informees, transaction filter will apply accordingly.
|
|
26
|
+
*/
|
|
27
|
+
export declare enum TransactionShape {
|
|
28
|
+
TRANSACTION_SHAPE_ACS_DELTA = "TRANSACTION_SHAPE_ACS_DELTA",
|
|
29
|
+
TRANSACTION_SHAPE_LEDGER_EFFECTS = "TRANSACTION_SHAPE_LEDGER_EFFECTS"
|
|
30
|
+
}
|
|
5
31
|
declare const SubscribeToUpdatesParamsSchema: z.ZodObject<{
|
|
6
32
|
parties: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
7
33
|
templateIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
@@ -10,6 +36,7 @@ declare const SubscribeToUpdatesParamsSchema: z.ZodObject<{
|
|
|
10
36
|
endInclusive: z.ZodOptional<z.ZodNumber>;
|
|
11
37
|
includeReassignments: z.ZodOptional<z.ZodBoolean>;
|
|
12
38
|
includeTopologyEvents: z.ZodOptional<z.ZodBoolean>;
|
|
39
|
+
transactionShape: z.ZodOptional<z.ZodEnum<typeof TransactionShape>>;
|
|
13
40
|
}, z.core.$strip>;
|
|
14
41
|
export type SubscribeToUpdatesParams = z.infer<typeof SubscribeToUpdatesParamsSchema> & {
|
|
15
42
|
/** Optional per-message callback to consume updates as they arrive. */
|
package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscribe-to-updates.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAKxF,QAAA,MAAM,8BAA8B
|
|
1
|
+
{"version":3,"file":"subscribe-to-updates.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAKxF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,oBAAY,gBAAgB;IAC1B,2BAA2B,gCAAgC;IAC3D,gCAAgC,qCAAqC;CACtE;AAED,QAAA,MAAM,8BAA8B;;;;;;;;;iBAiBlC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,GAAG;IACtF,uEAAuE;IACvE,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB;IAAE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;CAAE,GAC1C;IAAE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;CAAE,GAC1C,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,GACnC,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAExC,qBAAa,kBAAkB;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,mBAAmB;IAE3C,OAAO,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;CA2HtE"}
|
|
@@ -1,10 +1,37 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SubscribeToUpdates = void 0;
|
|
3
|
+
exports.SubscribeToUpdates = exports.TransactionShape = void 0;
|
|
4
4
|
const zod_1 = require("zod");
|
|
5
5
|
const WebSocketClient_1 = require("../../../../../core/ws/WebSocketClient");
|
|
6
6
|
const event_format_builder_1 = require("../utils/event-format-builder");
|
|
7
7
|
const path = '/v2/updates';
|
|
8
|
+
/**
|
|
9
|
+
* The `TransactionShape` enum defines the event shape for `Transaction`s and can have two different flavors AcsDelta
|
|
10
|
+
* and LedgerEffects.
|
|
11
|
+
*
|
|
12
|
+
* ```protobuf
|
|
13
|
+
* enum TransactionShape {
|
|
14
|
+
* TRANSACTION_SHAPE_ACS_DELTA = 1;
|
|
15
|
+
* TRANSACTION_SHAPE_LEDGER_EFFECTS = 2;
|
|
16
|
+
* }
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
19
|
+
* - AcsDelta
|
|
20
|
+
*
|
|
21
|
+
* The transaction shape that is sufficient to maintain an accurate ACS view. This translates to create and archive
|
|
22
|
+
* events. The field witness_parties in events are populated as stakeholders, transaction filter will apply
|
|
23
|
+
* accordingly.
|
|
24
|
+
* - LedgerEffects
|
|
25
|
+
*
|
|
26
|
+
* The transaction shape that allows maintaining an ACS and also conveys detailed information about all exercises. This
|
|
27
|
+
* translates to create, consuming exercise and non-consuming exercise. The field witness_parties in events are
|
|
28
|
+
* populated as cumulative informees, transaction filter will apply accordingly.
|
|
29
|
+
*/
|
|
30
|
+
var TransactionShape;
|
|
31
|
+
(function (TransactionShape) {
|
|
32
|
+
TransactionShape["TRANSACTION_SHAPE_ACS_DELTA"] = "TRANSACTION_SHAPE_ACS_DELTA";
|
|
33
|
+
TransactionShape["TRANSACTION_SHAPE_LEDGER_EFFECTS"] = "TRANSACTION_SHAPE_LEDGER_EFFECTS";
|
|
34
|
+
})(TransactionShape || (exports.TransactionShape = TransactionShape = {}));
|
|
8
35
|
const SubscribeToUpdatesParamsSchema = zod_1.z.object({
|
|
9
36
|
/** Optional list of parties to scope the filter. */
|
|
10
37
|
parties: zod_1.z.array(zod_1.z.string()).optional(),
|
|
@@ -20,6 +47,8 @@ const SubscribeToUpdatesParamsSchema = zod_1.z.object({
|
|
|
20
47
|
includeReassignments: zod_1.z.boolean().optional(),
|
|
21
48
|
/** Include topology events in the stream (default false). */
|
|
22
49
|
includeTopologyEvents: zod_1.z.boolean().optional(),
|
|
50
|
+
/** Transaction shape (default TRANSACTION_SHAPE_LEDGER_EFFECTS). */
|
|
51
|
+
transactionShape: zod_1.z.nativeEnum(TransactionShape).optional(),
|
|
23
52
|
});
|
|
24
53
|
class SubscribeToUpdates {
|
|
25
54
|
constructor(client) {
|
|
@@ -47,7 +76,7 @@ class SubscribeToUpdates {
|
|
|
47
76
|
const updateFormat = {
|
|
48
77
|
includeTransactions: {
|
|
49
78
|
eventFormat,
|
|
50
|
-
transactionShape:
|
|
79
|
+
transactionShape: validated.transactionShape ?? TransactionShape.TRANSACTION_SHAPE_LEDGER_EFFECTS,
|
|
51
80
|
},
|
|
52
81
|
};
|
|
53
82
|
// Add reassignments if enabled (default true)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscribe-to-updates.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,4EAAyE;AAIzE,wEAAiE;AAEjE,MAAM,IAAI,GAAG,aAAsB,CAAC;AAEpC,MAAM,8BAA8B,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9C,oDAAoD;IACpD,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,qDAAqD;IACrD,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,4EAA4E;IAC5E,uBAAuB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/C,yFAAyF;IACzF,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,sDAAsD;IACtD,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,0DAA0D;IAC1D,oBAAoB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5C,6DAA6D;IAC7D,qBAAqB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;
|
|
1
|
+
{"version":3,"file":"subscribe-to-updates.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,4EAAyE;AAIzE,wEAAiE;AAEjE,MAAM,IAAI,GAAG,aAAsB,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,+EAA2D,CAAA;IAC3D,yFAAqE,CAAA;AACvE,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B;AAED,MAAM,8BAA8B,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9C,oDAAoD;IACpD,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,qDAAqD;IACrD,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,4EAA4E;IAC5E,uBAAuB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/C,yFAAyF;IACzF,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,sDAAsD;IACtD,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,0DAA0D;IAC1D,oBAAoB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5C,6DAA6D;IAC7D,qBAAqB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7C,oEAAoE;IACpE,gBAAgB,EAAE,OAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;CAC5D,CAAC,CAAC;AAaH,MAAa,kBAAkB;IAC7B,YAA6B,MAA2B;QAA3B,WAAM,GAAN,MAAM,CAAqB;IAAG,CAAC;IAErD,KAAK,CAAC,OAAO,CAAC,MAAgC;QACnD,MAAM,SAAS,GAAG,8BAA8B,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/D,oEAAoE;QACpE,IAAI,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;QACnC,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACrD,cAAc,GAAG,SAAS,CAAC,MAAM,CAAC;QACpC,CAAC;QAED,mBAAmB;QACnB,MAAM,SAAS,GACb,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QAEvG,qBAAqB;QACrB,MAAM,WAAW,GAAG,IAAA,uCAAgB,EAAC;YACnC,OAAO,EAAE,SAAS;YAClB,GAAG,CAAC,SAAS,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;YAClF,GAAG,CAAC,SAAS,CAAC,uBAAuB,KAAK,SAAS,IAAI;gBACrD,uBAAuB,EAAE,SAAS,CAAC,uBAAuB;aAC3D,CAAC;SACH,CAAC,CAAC;QAEH,6CAA6C;QAC7C,MAAM,YAAY,GAcd;YACF,mBAAmB,EAAE;gBACnB,WAAW;gBACX,gBAAgB,EAAE,SAAS,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,gCAAgC;aAClG;SACF,CAAC;QAEF,8CAA8C;QAC9C,IAAI,SAAS,CAAC,oBAAoB,KAAK,KAAK,EAAE,CAAC;YAC7C,YAAY,CAAC,oBAAoB,GAAG;gBAClC,cAAc,EAAE,WAAW,CAAC,cAAc;gBAC1C,OAAO,EAAE,KAAK;aACf,CAAC;QACJ,CAAC;QAED,iDAAiD;QACjD,IAAI,SAAS,CAAC,qBAAqB,KAAK,IAAI,EAAE,CAAC;YAC7C,YAAY,CAAC,qBAAqB,GAAG;gBACnC,qCAAqC,EAAE;oBACrC,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC;QACJ,CAAC;QAED,wBAAwB;QACxB,MAAM,cAAc,GAAG;YACrB,cAAc;YACd,YAAY,EAAE,SAAS,CAAC,YAAY;YACpC,OAAO,EAAE,KAAK;YACd,YAAY;SACb,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAElD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,IAAI,OAAO,GAAG,KAAK,CAAC;YAEpB,KAAK,QAAQ;iBACV,OAAO,CAAiC,IAAI,EAAE,cAAc,EAAE;gBAC7D,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;oBACjB,IAAI,CAAC;wBACH,wEAAwE;wBACxE,6DAA6D;wBAC7D,MAAM,MAAM,GAAG,GAAuB,CAAC;wBAEvC,6CAA6C;wBAC7C,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;4BAC3C,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;wBAC3B,CAAC;wBAED,yBAAyB;wBACzB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,QAAQ,IAAI,MAAM,IAAI,OAAO,IAAI,MAAM,CAAC,EAAE,CAAC;4BAC5E,IAAI,CAAC,OAAO,EAAE,CAAC;gCACb,OAAO,GAAG,IAAI,CAAC;gCACf,MAAM,CAAC,MAA0B,CAAC,CAAC;4BACrC,CAAC;wBACH,CAAC;oBACH,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,IAAI,CAAC,OAAO,EAAE,CAAC;4BACb,OAAO,GAAG,IAAI,CAAC;4BACf,MAAM,CAAC,CAAU,CAAC,CAAC;wBACrB,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;oBACf,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,OAAO,GAAG,IAAI,CAAC;wBACf,MAAM,CAAC,GAAY,CAAC,CAAC;oBACvB,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,GAAG,EAAE;oBACZ,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,OAAO,GAAG,IAAI,CAAC;wBACf,OAAO,EAAE,CAAC;oBACZ,CAAC;gBACH,CAAC;aACF,CAAC;iBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACb,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,OAAO,GAAG,IAAI,CAAC;oBACf,MAAM,CAAC,GAAY,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA9HD,gDA8HC"}
|