@canton-network/core-ledger-proto 0.1.0

package/dist/_proto/com/digitalasset/canton/protocol/v30/traffic_control_parameters.d.ts

@@ -0,0 +1,278 @@
+import type { BinaryWriteOptions } from '@protobuf-ts/runtime';
+import type { IBinaryWriter } from '@protobuf-ts/runtime';
+import type { BinaryReadOptions } from '@protobuf-ts/runtime';
+import type { IBinaryReader } from '@protobuf-ts/runtime';
+import type { PartialMessage } from '@protobuf-ts/runtime';
+import { MessageType } from '@protobuf-ts/runtime';
+import { Duration } from '../../../../../google/protobuf/duration.js';
+/**
+ * @generated from protobuf message com.digitalasset.canton.protocol.v30.TrafficControlParameters
+ */
+export interface TrafficControlParameters {
+    /**
+     * In bytes, the maximum amount of base traffic that can be accumulated
+     *
+     * @generated from protobuf field: uint64 max_base_traffic_amount = 1
+     */
+    maxBaseTrafficAmount: bigint;
+    /**
+     * Maximum duration over which the base rate can be accumulated
+     * Consequently, base_traffic_rate = max_base_traffic_amount / max_base_traffic_accumulation_duration
+     *
+     * @generated from protobuf field: google.protobuf.Duration max_base_traffic_accumulation_duration = 3
+     */
+    maxBaseTrafficAccumulationDuration?: Duration;
+    /**
+     * Read scaling factor to compute the event cost. In parts per 10 000.
+     *
+     * @generated from protobuf field: uint32 read_vs_write_scaling_factor = 4
+     */
+    readVsWriteScalingFactor: number;
+    /**
+     * Window size used to compute the max sequencing time of a submission request
+     * This impacts how quickly a submission is expected to be accepted before a retry should be attempted by the caller
+     * Default is 5 minutes
+     *
+     * @generated from protobuf field: google.protobuf.Duration set_balance_request_submission_window_size = 5
+     */
+    setBalanceRequestSubmissionWindowSize?: Duration;
+    /**
+     * If true, submission requests without enough traffic credit will not be delivered
+     *
+     * @generated from protobuf field: bool enforce_rate_limiting = 6
+     */
+    enforceRateLimiting: boolean;
+    /**
+     * In bytes, base event cost added to all sequenced events.
+     * Optional
+     *
+     * @generated from protobuf field: optional uint64 base_event_cost = 7
+     */
+    baseEventCost?: bigint;
+}
+/**
+ * Message representing a traffic receipt included in SequencedEvent receipts to update sender about
+ * the traffic consumed state after sequencing of the event
+ *
+ * @generated from protobuf message com.digitalasset.canton.protocol.v30.TrafficReceipt
+ */
+export interface TrafficReceipt {
+    /**
+     * Cost effectively consumed by this specific event
+     *
+     * @generated from protobuf field: uint64 consumed_cost = 1
+     */
+    consumedCost: bigint;
+    /**
+     * Total amount of extra traffic consumed
+     *
+     * @generated from protobuf field: uint64 extra_traffic_consumed = 2
+     */
+    extraTrafficConsumed: bigint;
+    /**
+     * Remaining free base traffic
+     *
+     * @generated from protobuf field: uint64 base_traffic_remainder = 3
+     */
+    baseTrafficRemainder: bigint;
+}
+/**
+ * Message representing traffic consumed by a member at a given point in time
+ *
+ * @generated from protobuf message com.digitalasset.canton.protocol.v30.TrafficConsumed
+ */
+export interface TrafficConsumed {
+    /**
+     * Member consuming the traffic
+     *
+     * @generated from protobuf field: string member = 1
+     */
+    member: string;
+    /**
+     * Total extra traffic consumed
+     *
+     * @generated from protobuf field: uint64 extra_traffic_consumed = 2
+     */
+    extraTrafficConsumed: bigint;
+    /**
+     * Remaining free base traffic
+     *
+     * @generated from protobuf field: uint64 base_traffic_remainder = 3
+     */
+    baseTrafficRemainder: bigint;
+    /**
+     * Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0
+     *
+     * @generated from protobuf field: uint64 last_consumed_cost = 4
+     */
+    lastConsumedCost: bigint;
+    /**
+     * Timestamp at which this state is valid - this timestamp is used to compute the base traffic remainder above
+     *
+     * @generated from protobuf field: int64 sequencing_timestamp = 5
+     */
+    sequencingTimestamp: bigint;
+}
+/**
+ * Message representing a traffic purchase made on behalf of a member
+ *
+ * @generated from protobuf message com.digitalasset.canton.protocol.v30.TrafficPurchased
+ */
+export interface TrafficPurchased {
+    /**
+     * Member receiving the traffic
+     *
+     * @generated from protobuf field: string member = 1
+     */
+    member: string;
+    /**
+     * Serial of the update
+     *
+     * @generated from protobuf field: uint32 serial = 2
+     */
+    serial: number;
+    /**
+     * New total extra traffic purchased
+     *
+     * @generated from protobuf field: uint64 extra_traffic_purchased = 3
+     */
+    extraTrafficPurchased: bigint;
+    /**
+     * Timestamp at which this state is valid
+     *
+     * @generated from protobuf field: int64 sequencing_timestamp = 4
+     */
+    sequencingTimestamp: bigint;
+}
+/**
+ * Traffic state of a member at a given timestamp
+ *
+ * @generated from protobuf message com.digitalasset.canton.protocol.v30.TrafficState
+ */
+export interface TrafficState {
+    /**
+     * Total amount of extra traffic purchased
+     *
+     * @generated from protobuf field: int64 extra_traffic_purchased = 1
+     */
+    extraTrafficPurchased: bigint;
+    /**
+     * Total amount of extra traffic consumed
+     *
+     * @generated from protobuf field: int64 extra_traffic_consumed = 2
+     */
+    extraTrafficConsumed: bigint;
+    /**
+     * Amount of base traffic remaining
+     *
+     * @generated from protobuf field: int64 base_traffic_remainder = 3
+     */
+    baseTrafficRemainder: bigint;
+    /**
+     * Cost deducted at `timestamp`, only present when traffic was consumed at `timestamp`, otherwise is set to 0
+     *
+     * @generated from protobuf field: uint64 last_consumed_cost = 4
+     */
+    lastConsumedCost: bigint;
+    /**
+     * Timestamp at which the state is valid
+     *
+     * @generated from protobuf field: int64 timestamp = 5
+     */
+    timestamp: bigint;
+    /**
+     * Optional serial of the balance update that updated the extra traffic limit
+     *
+     * @generated from protobuf field: optional uint32 serial = 6
+     */
+    serial?: number;
+}
+/**
+ * @generated from protobuf message com.digitalasset.canton.protocol.v30.SetTrafficPurchasedMessage
+ */
+export interface SetTrafficPurchasedMessage {
+    /**
+     * Member to update the balance for
+     *
+     * @generated from protobuf field: string member = 1
+     */
+    member: string;
+    /**
+     * Serial number - must be unique and monotonically increasing for each new purchase update
+     *
+     * @generated from protobuf field: uint32 serial = 2
+     */
+    serial: number;
+    /**
+     * New total traffic purchased entry
+     *
+     * @generated from protobuf field: uint64 total_traffic_purchased = 4
+     */
+    totalTrafficPurchased: bigint;
+    /**
+     * @generated from protobuf field: string synchronizer_id = 5
+     */
+    synchronizerId: string;
+}
+declare class TrafficControlParameters$Type extends MessageType<TrafficControlParameters> {
+    constructor();
+    create(value?: PartialMessage<TrafficControlParameters>): TrafficControlParameters;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: TrafficControlParameters): TrafficControlParameters;
+    internalBinaryWrite(message: TrafficControlParameters, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message com.digitalasset.canton.protocol.v30.TrafficControlParameters
+ */
+export declare const TrafficControlParameters: TrafficControlParameters$Type;
+declare class TrafficReceipt$Type extends MessageType<TrafficReceipt> {
+    constructor();
+    create(value?: PartialMessage<TrafficReceipt>): TrafficReceipt;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: TrafficReceipt): TrafficReceipt;
+    internalBinaryWrite(message: TrafficReceipt, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message com.digitalasset.canton.protocol.v30.TrafficReceipt
+ */
+export declare const TrafficReceipt: TrafficReceipt$Type;
+declare class TrafficConsumed$Type extends MessageType<TrafficConsumed> {
+    constructor();
+    create(value?: PartialMessage<TrafficConsumed>): TrafficConsumed;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: TrafficConsumed): TrafficConsumed;
+    internalBinaryWrite(message: TrafficConsumed, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message com.digitalasset.canton.protocol.v30.TrafficConsumed
+ */
+export declare const TrafficConsumed: TrafficConsumed$Type;
+declare class TrafficPurchased$Type extends MessageType<TrafficPurchased> {
+    constructor();
+    create(value?: PartialMessage<TrafficPurchased>): TrafficPurchased;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: TrafficPurchased): TrafficPurchased;
+    internalBinaryWrite(message: TrafficPurchased, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message com.digitalasset.canton.protocol.v30.TrafficPurchased
+ */
+export declare const TrafficPurchased: TrafficPurchased$Type;
+declare class TrafficState$Type extends MessageType<TrafficState> {
+    constructor();
+    create(value?: PartialMessage<TrafficState>): TrafficState;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: TrafficState): TrafficState;
+    internalBinaryWrite(message: TrafficState, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message com.digitalasset.canton.protocol.v30.TrafficState
+ */
+export declare const TrafficState: TrafficState$Type;
+declare class SetTrafficPurchasedMessage$Type extends MessageType<SetTrafficPurchasedMessage> {
+    constructor();
+    create(value?: PartialMessage<SetTrafficPurchasedMessage>): SetTrafficPurchasedMessage;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: SetTrafficPurchasedMessage): SetTrafficPurchasedMessage;
+    internalBinaryWrite(message: SetTrafficPurchasedMessage, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message com.digitalasset.canton.protocol.v30.SetTrafficPurchasedMessage
+ */
+export declare const SetTrafficPurchasedMessage: SetTrafficPurchasedMessage$Type;
+export {};
+//# sourceMappingURL=traffic_control_parameters.d.ts.map

package/dist/_proto/com/digitalasset/canton/protocol/v30/traffic_control_parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traffic_control_parameters.d.ts","sourceRoot":"","sources":["../../../../../../../src/_proto/com/digitalasset/canton/protocol/v30/traffic_control_parameters.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAEzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAEzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,4CAA4C,CAAA;AACrE;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAA;IAC5B;;;;;OAKG;IACH,kCAAkC,CAAC,EAAE,QAAQ,CAAA;IAC7C;;;;OAIG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAChC;;;;;;OAMG;IACH,qCAAqC,CAAC,EAAE,QAAQ,CAAA;IAChD;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAA;IAC5B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACzB;AACD;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAA;CAC/B;AACD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAA;CAC9B;AACD;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,qBAAqB,EAAE,MAAM,CAAA;IAC7B;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAA;CAC9B;AACD;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB;;;;OAIG;IACH,qBAAqB,EAAE,MAAM,CAAA;IAC7B;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAClB;AACD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,qBAAqB,EAAE,MAAM,CAAA;IAC7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;CACzB;AAED,cAAM,6BAA8B,SAAQ,WAAW,CAAC,wBAAwB,CAAC;;IAsD7E,MAAM,CACF,KAAK,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC,GACjD,wBAAwB;IAa3B,kBAAkB,CACd,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,EAC1B,MAAM,CAAC,EAAE,wBAAwB,GAClC,wBAAwB;IAuD3B,mBAAmB,CACf,OAAO,EAAE,wBAAwB,EACjC,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,kBAAkB,GAC5B,aAAa;CAsCnB;AACD;;GAEG;AACH,eAAO,MAAM,wBAAwB,+BAAsC,CAAA;AAE3E,cAAM,mBAAoB,SAAQ,WAAW,CAAC,cAAc,CAAC;;IAoCzD,MAAM,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,cAAc;IAS9D,kBAAkB,CACd,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,EAC1B,MAAM,CAAC,EAAE,cAAc,GACxB,cAAc;IAkCjB,mBAAmB,CACf,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,kBAAkB,GAC5B,aAAa;CAmBnB;AACD;;GAEG;AACH,eAAO,MAAM,cAAc,qBAA4B,CAAA;AAEvD,cAAM,oBAAqB,SAAQ,WAAW,CAAC,eAAe,CAAC;;IAiD3D,MAAM,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC,eAAe,CAAC,GAAG,eAAe;IAWhE,kBAAkB,CACd,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,EAC1B,MAAM,CAAC,EAAE,eAAe,GACzB,eAAe;IAwClB,mBAAmB,CACf,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,kBAAkB,GAC5B,aAAa;CAyBnB;AACD;;GAEG;AACH,eAAO,MAAM,eAAe,sBAA6B,CAAA;AAEzD,cAAM,qBAAsB,SAAQ,WAAW,CAAC,gBAAgB,CAAC;;IAyC7D,MAAM,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC,gBAAgB,CAAC,GAAG,gBAAgB;IAUlE,kBAAkB,CACd,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,EAC1B,MAAM,CAAC,EAAE,gBAAgB,GAC1B,gBAAgB;IAqCnB,mBAAmB,CACf,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,kBAAkB,GAC5B,aAAa;CAsBnB;AACD;;GAEG;AACH,eAAO,MAAM,gBAAgB,uBAA8B,CAAA;AAE3D,cAAM,iBAAkB,SAAQ,WAAW,CAAC,YAAY,CAAC;;IA+CrD,MAAM,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC,YAAY,CAAC,GAAG,YAAY;IAW1D,kBAAkB,CACd,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,EAC1B,MAAM,CAAC,EAAE,YAAY,GACtB,YAAY;IA2Cf,mBAAmB,CACf,OAAO,EAAE,YAAY,EACrB,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,kBAAkB,GAC5B,aAAa;CA4BnB;AACD;;GAEG;AACH,eAAO,MAAM,YAAY,mBAA0B,CAAA;AAEnD,cAAM,+BAAgC,SAAQ,WAAW,CAAC,0BAA0B,CAAC;;IAwCjF,MAAM,CACF,KAAK,CAAC,EAAE,cAAc,CAAC,0BAA0B,CAAC,GACnD,0BAA0B;IAc7B,kBAAkB,CACd,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,EAC1B,MAAM,CAAC,EAAE,0BAA0B,GACpC,0BAA0B;IAqC7B,mBAAmB,CACf,OAAO,EAAE,0BAA0B,EACnC,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,kBAAkB,GAC5B,aAAa;CAwBnB;AACD;;GAEG;AACH,eAAO,MAAM,0BAA0B,iCAAwC,CAAA"}