https://github.com/hengxin/jupiter-refinement-project

Jupiter Refinement Project
https://github.com/hengxin/jupiter-refinement-project

collaborative-editing formal-verification jupiter refinement tla tlaplus tlaps tlc

Last synced: 4 months ago
JSON representation

Jupiter Refinement Project

• Host: GitHub
• URL: https://github.com/hengxin/jupiter-refinement-project
• Owner: hengxin
• Created: 2019-02-01T05:23:38.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-11-23T05:05:06.000Z (about 5 years ago)
• Last Synced: 2025-10-12T18:05:10.790Z (4 months ago)
• Topics: collaborative-editing, formal-verification, jupiter, refinement, tla, tlaplus, tlaps, tlc
• Language: TeX
• Size: 55.9 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# `jupiter-refinement-project`

## Overview

It is devoted to "formal specification and verification of a family of Jupiter protocols 

for implementing replicated lists".

Jupiter protocol is a core of many collaborative editing systems.

## Papers

See [paper-jupiter-refinement](https://github.com/hengxin/jupiter-refinement-project/blob/master/paper-jupiter-refinement.pdf).

## How to Run?

1. Run separately.

  Create and run TLC models [in the usual way](https://tla.msr-inria.inria.fr/tlatoolbox/doc/model/model.html).

2. Run in batch (***Recommended***).

  We write scripts to automatically conduct a batch of experiments; 

  see [tangruize/jupiter-experiments](https://github.com/tangruize/jupiter-experiments/tree/master).

## TLA+ Modules

**Note:** The TLA+ code in this repository may be different from that in papers

we wrote in formatting, naming, and modularity.

The following figure shows the key TLA+ modules in this project,

where the solid line from module A to module B indicates that B *"extends"* A,

and the dashed line from module A to module B indicates that B contains an *"instance"* of A.

![Module Graph](https://github.com/hengxin/jupiter-refinement-project/wiki/modules.png)

These modules fall into four categories:

- System Model:

  It describes the client/server architecture of collaborative editing systems.

  It also models a replica as an abstract state machine 

  and provides the interface for implementing such a state machine.

- Jupiter Family: 

  This contains several techniques for all Jupiter protocols.

  - `JupiterCtx` is for context-based Jupiter protocols.

  - `JupiterSerial` helps to establish the serialization order at the server.

  - `BufferStateSpace`, `GraphStateSpace`, `SetStateSpace` are data structures for supporting OTs in Jupiter protocols.

- Jupiter Protocols: 

  Formal TLA+ specifications of four Jupiter protocols, i.e., `AJupiter`, `XJupiter`, `CJupiter`, and `AbsJupiter`.

- Refinement: 

  The (data) refinement relations among Jupiter protocols are established.

  Specifically, 

  - `AJupiter` is a refinement (a.k.a implementation) of `XJupiter`,

  - `XJupiter` is a refinement of `CJupiter`, 

  - `CJupiter` is a refinement of `AbsJupiter`.

## Jupiter Protocols Illustrated

See [jupiter-protocols-illustrations](https://github.com/hengxin/jupiter-refinement-project/tree/master/jupiter-protocols-illustrations) for illustrations for these four Jupiter protocols.

---

For more details, please visit the [wiki](https://github.com/hengxin/jupiter-refinement-project/wiki) page.

If you have any questions, please fire an issue or contact us (hfwei at nju dot edu dot cn).