SyncManager

SIP Protocol API Reference v0.12.0

---

SIP Protocol API Reference / SyncManager

Class: SyncManager

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23810

Sync Manager

Coordinates oblivious synchronization across providers and chains.

Features

• Multi-provider support (fallback on failure)
• Multi-chain parallel sync
• Automatic randomness rotation
• Background sync option
• Event-driven progress updates

Usage

const manager = new SyncManager(provider)
await manager.initialize()

// Sync all chains
const result = await manager.sync(viewingKey, spendingKey, {
  listener: {
    onProgress: (e) => console.log(`${e.percentComplete}%`),
    onNotesFound: (notes) => console.log(`Found ${notes.length} notes`),
  }
})

Constructors

Constructor

new SyncManager(providers, config?): SyncManager

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23816

Parameters

providers

ObliviousSyncProvider | ObliviousSyncProvider[]

config?

Partial<SyncManagerConfig>

Returns

SyncManager

Methods

initialize()

initialize(): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23820

Initialize the sync manager

Returns

Promise<void>

---

getState()

getState(): WalletSyncState | null

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23824

Get current sync state

Returns

WalletSyncState | null

---

getSupportedChains()

getSupportedChains(): string[]

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23828

Get supported chains

Returns

string[]

---

getHealth()

getHealth(chainId): Promise<SyncServiceHealth[]>

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23832

Check health of all providers for a chain

Parameters

chainId

string

Returns

Promise<SyncServiceHealth[]>

---

sync()

sync(viewingKey, spendingKey, options?): Promise<EncryptedNote[]>

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23844

Sync obliviously

Main method for oblivious synchronization. The sync service learns nothing about which notes belong to you or your spending patterns.

Parameters

viewingKey

ViewingKey

Viewing key for note detection

spendingKey

`0x${string}`

Spending key for nullifier derivation

options?

SyncOptions

Sync options

Returns

Promise<EncryptedNote[]>

Notes found during sync

---

checkNullifiersSpent()

checkNullifiersSpent(nullifiers): Promise<Map<`0x${string}`, boolean>>

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23851

Check if nullifiers have been spent (obliviously)

Parameters

nullifiers

ObliviousNullifier[]

Oblivious nullifiers to check

Returns

Promise<Map<`0x${string}`, boolean>>

Map of nullifier → spent status

---

deriveNullifier()

deriveNullifier(noteCommitment, spendingKey, chainId): ObliviousNullifier

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23860

Derive oblivious nullifier for a note

Parameters

noteCommitment

`0x${string}`

Note commitment

spendingKey

`0x${string}`

Spending key

chainId

string

Chain ID

Returns

ObliviousNullifier

Oblivious nullifier

---

startBackgroundSync()

startBackgroundSync(viewingKey, spendingKey, options?): void

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23868

Start background sync

Parameters

viewingKey

ViewingKey

Viewing key

spendingKey

`0x${string}`

Spending key

options?

SyncOptions

Sync options

Returns

void

---

stopBackgroundSync()

stopBackgroundSync(): void

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23872

Stop background sync

Returns

void

---

shutdown()

shutdown(): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-rqQpCeVM.d.ts:23876

Shutdown the sync manager

Returns

Promise<void>