@devtion/actions 0.0.0-7e983e3

package/dist/types/src/types/enums.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Define different states of a ceremony.
+ * @enum {string}
+ * - SCHEDULED: when the ceremony setup has been properly completed but the contribution period has not yet started.
+ * - OPENED: when the contribution period has started.
+ * - PAUSED: When the coordinator has manually paused the ceremony (NB. currently not possible because the relevant functionality has not yet been implemented).
+ * - CLOSED: when the contribution period has finished.
+ * - FINALIZED: when the ceremony finalization has been properly completed.
+ */
+export declare const enum CeremonyState {
+    SCHEDULED = "SCHEDULED",
+    OPENED = "OPENED",
+    PAUSED = "PAUSED",
+    CLOSED = "CLOSED",
+    FINALIZED = "FINALIZED"
+}
+/**
+ * Define the type of Trusted Setup ceremony (Phase 1 or Phase 2).
+ * @enum {string}
+ * - PHASE1: when the ceremony is a Phase 1 Trusted Setup ceremony.
+ * - PHASE2: when the ceremony is a Phase 2 Trusted Setup ceremony.
+ */
+export declare const enum CeremonyType {
+    PHASE1 = "PHASE1",
+    PHASE2 = "PHASE2"
+}
+/**
+ * Define different status of a participant.
+ * @enum {string}
+ * - CREATED: when the participant document has been created in the database.
+ * - WAITING: when the participant is waiting for a contribution (i.e., is currently queued or is waiting for its status to be checked after a timeout expiration).
+ * - READY: when the participant is ready for a contribution.
+ * - CONTRIBUTING: when the participant is currently contributing (i.e., not queued anymore, but the current contributor at this time).
+ * - CONTRIBUTED: when the participant has completed successfully the contribution for all circuits in a ceremony. The participant may need to wait for the latest contribution verification while having this status.
+ * - DONE: when the participant has completed contributions and verifications from coordinator.
+ * - FINALIZING: when the coordinator is currently finalizing the ceremony.
+ * - FINALIZED: when the coordinator has successfully finalized the ceremony.
+ * - TIMEDOUT: when the participant has been timedout while contributing. This may happen due to network or memory issues, un/intentional crash, or contributions lasting for too long.
+ * - EXHUMED: when the participant is ready to resume the contribution after a timeout expiration.
+ */
+export declare const enum ParticipantStatus {
+    CREATED = "CREATED",
+    WAITING = "WAITING",
+    READY = "READY",
+    CONTRIBUTING = "CONTRIBUTING",
+    CONTRIBUTED = "CONTRIBUTED",
+    DONE = "DONE",
+    FINALIZING = "FINALIZING",
+    FINALIZED = "FINALIZED",
+    TIMEDOUT = "TIMEDOUT",
+    EXHUMED = "EXHUMED"
+}
+/**
+ * Define different steps during which the participant may be during the contribution.
+ * @enum {string}
+ * - DOWNLOADING: when the participant is doing the download of the last contribution (from previous participant).
+ * - COMPUTING: when the participant is actively computing the contribution.
+ * - UPLOADING: when the participant is uploading the computed contribution.
+ * - VERIFYING: when the participant is waiting from verification results from the coordinator.
+ * - COMPLETED: when the participant has received the verification results from the coordinator and completed the contribution steps.
+ */
+export declare const enum ParticipantContributionStep {
+    DOWNLOADING = "DOWNLOADING",
+    COMPUTING = "COMPUTING",
+    UPLOADING = "UPLOADING",
+    VERIFYING = "VERIFYING",
+    COMPLETED = "COMPLETED"
+}
+/**
+ * Define what type of timeout was performed.
+ * @enum {string}
+ * - BLOCKING_CONTRIBUTION: when the current contributor was blocking the waiting queue.
+ * - BLOCKING_CLOUD_FUNCTION: when the contribution verification has gone beyond the time limit.
+ */
+export declare const enum TimeoutType {
+    BLOCKING_CONTRIBUTION = "BLOCKING_CONTRIBUTION",
+    BLOCKING_CLOUD_FUNCTION = "BLOCKING_CLOUD_FUNCTION"
+}
+/**
+ * Define what type of timeout mechanism is currently adopted for a ceremony.
+ * @enum {string}
+ * - DYNAMIC: self-update approach based on latest contribution time.
+ * - FIXED: approach based on a fixed amount of time.
+ */
+export declare const enum CeremonyTimeoutType {
+    DYNAMIC = "DYNAMIC",
+    FIXED = "FIXED"
+}
+/**
+ * Define request type for pre-signed urls.
+ */
+export declare const enum RequestType {
+    PUT = "PUT",
+    GET = "GET"
+}
+/**
+ * Define the environment in use when testing.
+ * @enum {string}
+ * - DEVELOPMENT: tests are performed on the local Firebase emulator instance.
+ * - PRODUCTION: tests are performed on the remote (deployed) Firebase application.
+ */
+export declare const enum TestingEnvironment {
+    DEVELOPMENT = "DEVELOPMENT",
+    PRODUCTION = "PRODUCTION"
+}
+/**
+ * Define what type of contribution verification mechanism is currently adopted for a circuit.
+ * @enum {string}
+ * - CF: Cloud Functions.
+ * - VM: Virtual Machine.
+ */
+export declare const enum CircuitContributionVerificationMechanism {
+    CF = "CF",
+    VM = "VM"
+}
+/**
+ * Define the supported VM volume types.
+ * @dev the VM volume types can be retrieved at https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html
+ * @enum {string}
+ * - GP2: General Purpose SSD version 2.
+ * - GP3: General Purpose SSD version 3.
+ * - IO1: Provisioned IOPS SSD volumes version 1.
+ * - ST1: Throughput Optimized HDD volumes.
+ * - SC1: Cold HDD volumes.
+ */
+export declare const enum DiskTypeForVM {
+    GP2 = "gp2",
+    GP3 = "gp3",
+    IO1 = "io1",
+    ST1 = "st1",
+    SC1 = "sc1"
+}
+//# sourceMappingURL=enums.d.ts.map

package/dist/types/src/types/enums.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../../src/types/enums.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,0BAAkB,aAAa;IAC3B,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,cAAc;CAC1B;AAED;;;;;GAKG;AACH,0BAAkB,YAAY;IAC1B,MAAM,WAAW;IACjB,MAAM,WAAW;CACpB;AAED;;;;;;;;;;;;;GAaG;AACH,0BAAkB,iBAAiB;IAC/B,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACtB;AAED;;;;;;;;GAQG;AACH,0BAAkB,2BAA2B;IACzC,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,SAAS,cAAc;CAC1B;AAED;;;;;GAKG;AACH,0BAAkB,WAAW;IACzB,qBAAqB,0BAA0B;IAC/C,uBAAuB,4BAA4B;CACtD;AAED;;;;;GAKG;AACH,0BAAkB,mBAAmB;IACjC,OAAO,YAAY;IACnB,KAAK,UAAU;CAClB;AAED;;GAEG;AACH,0BAAkB,WAAW;IACzB,GAAG,QAAQ;IACX,GAAG,QAAQ;CACd;AAED;;;;;GAKG;AACH,0BAAkB,kBAAkB;IAChC,WAAW,gBAAgB;IAC3B,UAAU,eAAe;CAC5B;AAED;;;;;GAKG;AACH,0BAAkB,wCAAwC;IACtD,EAAE,OAAO;IACT,EAAE,OAAO;CACZ;AAED;;;;;;;;;GASG;AACH,0BAAkB,aAAa;IAC3B,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;CACd"}