Class FedSync

constructor

• new FedSync(
      options?: {
          fromStaticOnly?: boolean;
          localNodeHash?: Uint8Array<ArrayBufferLike> | null;
          pruneAgeSecs?: number;
          staticPeers?: Uint8Array<ArrayBufferLike>[];
      },
  ): FedSync

  Parameters

  • Optionaloptions: {
        fromStaticOnly?: boolean;
        localNodeHash?: Uint8Array<ArrayBufferLike> | null;
        pruneAgeSecs?: number;
        staticPeers?: Uint8Array<ArrayBufferLike>[];
    } = {}

  Returns FedSync

fromStaticOnly

localNodeHash

peers

pruneAgeSecs

staticPeers

peerCount

• get peerCount(): number

  Returns the number of known peers.

  Returns number

peerHeard

• peerHeard(
      destinationHash: Uint8Array<ArrayBufferLike>,
      peeringCost?: number | null,
  ): void

  Called when an rfed.node announce is seen. Creates or updates peer entry.

  Parameters

  • destinationHash: Uint8Array<ArrayBufferLike>

    16-byte rfed.node destination hash

  • peeringCost: number | null = null

    PoW cost from announce app_data (optional)

  Returns void

pruneStalePeers

• pruneStalePeers(): number

  Prunes peers not heard from within pruneAgeSecs (except static peers). Returns count of pruned peers.

  Returns number

seedStaticPeers

• seedStaticPeers(): void

  Seed static peers as immediately-due sync targets. Called once at startup.

  Returns void

syncErr

• syncErr(destinationHash: Uint8Array<ArrayBufferLike>): void

  Mark that a sync attempt failed for a peer (increases backoff).

  Parameters

  • destinationHash: Uint8Array<ArrayBufferLike>

  Returns void

syncOk

• syncOk(destinationHash: Uint8Array<ArrayBufferLike>): void

  Mark that a sync attempt succeeded for a peer (resets backoff).

  Parameters

  • destinationHash: Uint8Array<ArrayBufferLike>

  Returns void

syncStarted

• syncStarted(destinationHash: Uint8Array<ArrayBufferLike>): void

  Mark that a sync attempt has started for a peer.

  Parameters

  • destinationHash: Uint8Array<ArrayBufferLike>

  Returns void

tick

• tick(): Uint8Array<ArrayBufferLike>[]

  Returns a list of peer destination hashes that are due for sync. Called periodically by the main loop/runner.

  Returns Uint8Array<ArrayBufferLike>[]