Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- ARK Ekosistemi
- Teknik yazar:
- yslcrypto
- Projenin adı:
- Project 1 - Getting Started With Core Blockchain Development Guide
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Başlangıç bölümünü okuduktan sonra aklıma gelenleri paylaşmak isterim:
GELİŞTİRME ORTAMINIZI AYARLAMA
Kurulum: Geliştirme araçlarını burada nasıl yükleyeceğinizi ayrıntılı olarak açıklayacağım. Yaygın hatalarla birlikte bunların nasıl düzeltileceğini ve kod örnekleri de sunacağım (burada bir sorun giderme sayfasının bağlantısını verebiliriz).
İlk test ağınız: İlk izlenim: Şu anda, hızlıca göz atıp hızlıca kurulum yapmak isteyen kullanıcılar için oldukça kafa karıştırıcı. Değiştireceğim bazı noktalar şunlardır:
Testnet gibi temel kavramları bile tanımlayabilirsiniz.
Daha kısa kod örnekleri (mkdir, cd vb.) sağlardım. Ayrıca, okuyucuların daha kolay kopyalayıp yapıştırabilmesi için bunları gruplandırırdım. Hiçbir şey çok basit değildir ve herkes kopyalayıp yapıştırmayı sever.
İlk okumada, ağ başlatma alt bölümündeki 1 ve 2. adımların neler sağladığını anlayamadım. Bağlantıları tıklayıp incelemek çok fazla dikkat gerektiriyor. Konuyu çok fazla ayrıntıya girmeden daha net bir şekilde açıklayabiliriz.
Okuyucuların bağlantıyı takip etmeden ne yaptıkları hakkında fikir sahibi olabilmesi için en azından 5. adımda (ki aslında 4. adım olduğunu düşünüyorum) core-container'a genel bir bakış sunardım.
3. ve 5. adımlarda (aslında 4. adımda) daha uzun kod örneklerini açıklayacağım.
Son adımda, okuyucunun işini kolaylaştırmak için yüklenen eklentinin ve dosyanın bağlantısını veririm.
Son olarak, paragraf başına en fazla bir fikir olacak şekilde düzenleyin (göz atmayı kolaylaştırır). Ayrıca tonu biraz daha eğlenceli / samimi hale getirir ve birkaç emoji eklerdim.
BLOCKCHAIN'İ İZLEMEK
İlk paragrafı basitleştirin. Eklentinin ne olduğunu, yetki verilen kullanıcının ne yaptığını (ya da en azından bir ilk ilkeler açıklamasına bağlantı verir), blok oluşturmanın ne anlama geldiğini açıklar ve bir ağ etkinliği örneği veririm.
Sorunu tanımlayın: Okuyucuya tam düğümün ne olduğuna dair bir fikir verin, daha ayrıntılı bir açıklamaya bağlantı verin ve tam düğüm ile harici uygulama arasındaki avantajları ve dezavantajları daha iyi açıklayın. Son olarak, bu alt bölümün sonunda, okuyucunun ilk olarak bu sayfaya rastlaması ihtimaline karşı, önceki başlangıç sayfasına (çalışmayan bir test ağı ve geliştirme ortamı oluşturma) bağlantı vereceğim.
Events API: İstediğimizi elde etmek için mevcut etkinlikler listesinde "block.applied"i kullanmamız gerektiği açık değil. Aşağıdaki İpucu daha anlaşılır olsa da bunu daha önce açıklayacağım.
Hangi "block.applied" ifadelerinin iade edildiğini tam olarak anlayamadım. Bu konuyu netleştirmenin önemli olduğunu düşünüyorum.
Sondaki kod örneğinde "block.generatorPublicKey" örneğinde "block.forger"ın (önceki sözde kod örneğinde) yerini ve "delegateKey"in, "delegateWeAreMonitoring"in yerini aldığını açıkça belirtmek faydalı olacaktır. Son olarak, kod ve sözde kod örneklerinin tutarlı olmasını sağlamak için "delegateKey" ve "generator" ifadelerini de değiştiririm.
Eklentiyi oluşturma: Bu bağlamda iskeletin ne anlama geldiğini açıklayacağım. Örneğin: Bir inşaat sahasındaki gerçek iskele gibi, bu bağlamda iskele derken, eklentiniz için önceden oluşturulmuş ve üzerine gerçek eklentiyi kurabileceğiniz basit bir yapıyı kastediyoruz.
Dizini ve eklentiyi yeniden adlandırmak için kod örnekleri ekleyin, package.json örneği gösterin ve plugin.js'ye "gerekli yapılandırmayı ekleme" derken neyi kastettiğimizi açıklayın.
Özetlemek gerekirse: Değişikliklerin ne olduğunu daha net bir şekilde belirtebilirsiniz. Son olarak da tebrik ederek bitirin ve birkaç emoji daha ekleyin :)
ARK SDK'SINI KULLANARAK İLK İŞLEMİNİZİ GÖNDERME
Başlangıç: Kullanıcının kopyala yapıştır yöntemiyle yeni bir dizin oluşturmasına olanak tanıyan bir kod örneği ekledim.
Testnet'e bağlanma: Okuyucu REST API'yi bilmiyorsa REST API'nin ne olduğunu açıklayın (veya en azından bir açıklamaya bağlantı verin). Bir JSON görüntüleyici örneği verebilirim. İkinci İPUCU'nda daha samimi bir üslup kullanırım (çünkü okuyucudan bir iyilik yapmasını istiyoruz).
Yapılandırma Yöneticisi'ni değiştirme: Ağla ilgili hatalarla ilgili yaygın örneklerden bahsetmiştim. Dilerseniz bir sorun giderme bölümüne de bağlantı verebilirsiniz.
Gönderme ve Alma Hesapları Oluşturun: Okuyucunun, kopyalayıp yapıştırma yöntemiyle yapılandırma dizinine geçmesine olanak tanımak için bir kod örneği ekliyorum. delegates.json dosyasının içeriğini gösteren bir kod örneği eklerim.
ARK CORE TESTER KSA'YI KULLANARAK İŞLEM GÖNDERME
Ön koşullar: ARK Core GitHub deposunun çalışan bir kopyasının nasıl alınacağını gösteren bir kod örneği ve okuyucuyu doğru dizine taşıyan başka bir kod örneği ekledim.
Temel bilgiler: Yol ortam değişkenlerini bilmeyen kullanıcılar için ilk paragrafı daha anlaşılır hale getirebilirim.
SONUÇ
Sonuç olarak, bunlar dokümanları okurken aldığım kısa notlardan bazıları. Projeye birlikte başladığımızda, nerede sorun yaşayacağımı görmek için süreci kendim de uygulamak isterim. Bu bilgileri kullanarak dokümanları daha da basitleştirebilirsiniz.
Son olarak, burada yalnızca bir projeyi inceledim ancak bu işlemin birkaç haftadan uzun süreceğini düşünmüyorum. E-posta yazışmalarımızda da belirttiğimiz gibi, birlikte çalışacağımız süre boyunca birkaç proje üzerinde çalışmamız mümkün olabilir.