Type alias Queue

Queue: {
    gateways: {
        blockHeight: number;
        completed: string[];
        dropped: string[];
        isBidding: string[];
        isConfirming: {
            [block: number]: string[];
        };
        isExecuting: string[];
        reverted: string[];
    };
}

The queue type is used to track the incoming SFXs throughout their life-cycle. Each gateway has its own queue, tracking its height on the light-client. When an SFX was executed, it is moved to the isConfirming queue. Once the gateway has reached the required block height, the SFXs can be confirmed.

Type declaration

  • gateways: {
        blockHeight: number;
        completed: string[];
        dropped: string[];
        isBidding: string[];
        isConfirming: {
            [block: number]: string[];
        };
        isExecuting: string[];
        reverted: string[];
    }

    Each gateway has its own queue, which can be accessed via gateway id

    • blockHeight: number

      Stores the latest block height know by the corresponding circuit light client

    • completed: string[]

      SFXs that are completed

    • dropped: string[]

      SFXs that are dropped

    • isBidding: string[]

      SFXs that are currently in bidding stage

    • isConfirming: {
          [block: number]: string[];
      }

      SFXs that are waiting to be confirmed

      • [block: number]: string[]
    • isExecuting: string[]

      SFXs that are currently being executed

    • reverted: string[]

      SFXs that are reverted

Generated using TypeDoc