Sync tracking issue

[sethvincent]

Tasks

• Determine how to use a staged sync approach #49
• Share hypercore keys between peers with hypercore extension #50
• Track replication state #51
• create custom replicate function instead of corestore.replicate #56

Related

• Cloud sync tracking issue: RFC: How to configure a cloud sync server for a project mapeo-cloud-sync#1

[sethvincent]

rough sketch of potential sync api:

import Mapeo from '@mapeo/core'

const rootKey = Mapeo.getRootKey() 
const mapeo = new Mapeo({ rootKey })
const project1 = mapeo.project(name1)
const project2 = mapeo.project(name2)

await project1.ready()
await project2.ready()

const progress = mapeo.sync([
  project1,
  project2
])

progress.on('status', (status) => {
  // `status` is something like an array of percentages for each project
  // or an array of objects with sync progress for each peer in each project
})

mapeo.on('peer', (peer) => {
  // each peer would have information on what projects they are part of and their sync state
  // same info could be retrieved via a getter like `mapeo.peers`
})

[sethvincent]

All the sub-tasks in this repo for this issue have been merged. Any other/new sync-related issues can be tracked separately.