Skip to main content

Kurulum

ws isteğe bağlı bir peer bağımlılıktır. Yalnızca WebSocket istemcisini kullanıyorsanız kurun.

İstemciyi oluşturma

Minimal:
.build() öğesinin async olduğuna dikkat edin - sonuç dönmeden önce WebSocket bağlantısını kurar. Bağlantı başarısız olursa promise hemen reddedilir.

Builder yöntemleri

.url(url) - Birincil WebSocket uç noktası. ORBITFLARE_WS_URL ortam değişkenine düşer.
.urls([...]) - Tek çağrıda birincil + yedekler.
.fallbackUrl(url) / .fallbackUrls([...]) - Yedek uç noktalar ekler. Yeniden bağlanırken SDK aralarında döner.
.apiKey(key) - Lisans anahtarı. ORBITFLARE_LICENSE_KEY ortam değişkenine düşer.
.retry(policy) - Yeniden bağlanma geri çekilmesi. Varsayılan: 100 ms başlangıç, 30 sn üst sınır, 2x çarpan, sonsuz deneme.
.pingIntervalSecs(n) - SDK’nın WebSocket Ping çerçevelerini gönderme sıklığı. Varsayılan: 10.
.maxMissedPongs(n) - Bağlantıyı sonlandırmadan önce yanıtsız ping sayısı. Varsayılan: 3.

Kullanılabilir abonelikler

slotSubscribe()

Bir slot işlendiğinde, onaylandığında veya finalize edildiğinde tetiklenir.
Her olay slot, parent ve root alanlarına sahip bir nesnedir:

accountSubscribe(address, commitment)

Belirtilen hesabın verisi değiştiğinde tetiklenir.
Lamport, owner ve çalıştırılabilir bayrağı ile base64 kodlanmış hesap verisini döndürür.

logsSubscribe(mentions, commitment)

Verilen adresleri anan işlemler için tetiklenir. Tüm işlemler için boş dizi geçin.
Tüm günlükler:

signatureSubscribe(signature, commitment)

Bir işlem verilen taahhüt düzeyine ulaştığında bir kez tetiklenir. Az önce gönderdiğiniz bir işlemi onaylamak için kullanışlıdır.

Olayları okuma

Tüm abonelikler bir WsSubscription döndürür. Sonraki olay için .next() çağırın:
.next() abonelik kapatıldığında undefined ile resolve olur. Olay dinleyici tarzında bir geri çağırma da ekleyebilirsiniz:

Abonelikten çıkma

Sunucuya abonelikten çıkma iletisi gönderir. Bunu çağırmadan aboneliği düşürürseniz SDK yetimi tespit eder ve abonelikten çıkmayı otomatik gönderir.

Birden çok abonelik

Tüm abonelikler tek WebSocket bağlantısında çalışır. SDK bildirimleri doğru aboneliğe dahili olarak yönlendirir.
Mevcut abonelikler çalışırken istediğiniz zaman yeni abonelik ekleyebilirsiniz.

Yeniden bağlanma

Bağlantı koparsa arka plan görevi üstel geri çekilme ile yeniden bağlanır ve her şeyi otomatik yeniden abone eder. .next() çağrılarınız çalışmaya devam eder - bağlantı geri gelince olaylar sürer.

Tam örnek

Slot güncellemelerine ve USDC için hesap değişikliklerine abone olan, canlı bir akış yazan bir izleme betiği.