Feb 2025 The Symbol Syndicate’s Docs Blogs
2025年2月のブログはこちらから
【日本語訳】行った作業の概要
刊行予定のSymbolに関する書籍のレビュー
Opening Line 社より、Symbolブロックチェーンを使ったアプリケーションの作成に関する刊行予定の書籍のレビューを依頼されました。日本語は私の学習課題リストにある言語の一つですが、本書は日本語で書かれていたため困難に感じたものの、非常にやりがいのあるものでした。本書の実践的なアプローチは大変魅力的で、レビューを通して多くのことを学ぶことができました。
サイトの構成
ドキュメント用の静的サイトジェネレーターには MkDocs と Material を採用し、現在必要なプラグインの設定を進めています。特に Python、TypeScript、Java、RESTといった複数言語のAPIドキュメントが必要であり、それら全てに単一のツールで対応できないため、プラグイン同士の連携が必ずしもうまくいかないという課題があります。サイトには、 mkdocstrings、 Typedoc、 Doxygen、 Swagger-ui-tag などを利用しており、ツールチップは機能するようになりました。現在取り組んでいることは、全体としてより統一感が出るように、テーマを統合することです。このプロジェクトでは比較的コーディング作業も発生するのですが、私はコーディングからしばらく離れていたため、むしろ面白く感じています!チュートリアルの作成に取り掛かるのが、今から本当に楽しみです!
マネジメント
マネジメントなんて誰も好きじゃありませんが、こればかりは避けられませんよね ¯(ツ)/¯
求人票の作成、ライター候補者との面接、タスクリスト作りなど…。ですが、その甲斐あって、作成したい全ページのリストが出来上がりました!次のセクションもぜひチェックしてみてください。
コンテンツ執筆
今月はコンテンツ作成はあまり進んでいませんが、旧 NEM NIS1 REST API の OpenAPI 仕様に関して動きがありました。実情として現在は Symbol のドキュメントに注力していますが、NEM のことを忘れたわけではありません。
今月のタスクごとの時間配分はこちらでご確認いただけます。
サイトの準備が完全に整い次第、皆さんにお知らせいたします。その後はコンテンツ執筆に全力を注ぎ、サイトの管理や設定にかかる手間は、できれば最小限に抑えたいと考えています。今後ライターの方々が加わった段階で、私の時間は執筆とレビューに費やされることになるかと思います。
サイトマップ
以下が Symbol のドキュメントとして作成予定の全ページのリストです。
すでに存在するページもあれば、基礎として利用できるチュートリアルコードがあるページもあります。また、完全に新規で作成する必要があるページも含まれています。
この機会に何でもリクエストしてください!
以下のリストをご確認いただき、何か足りないと思われる点や、お気づきの点がございましたら、ぜひお知らせください!
以下のリストをご確認いただき、何か足りないと思われる点や、お気づきの点がございましたら、ぜひお知らせください!
連絡先はこのブログのトップページにあります。
ユーザーマニュアル
コードを必要としない操作方法
Symbol Desktop Wallet
Creating an account
Using a Ledger device
Sending mosaics and messages
Using multisig accounts
Creating a multisig account
Cosigning transactions
Enabling harvesting
Reading and writing metadata (account, mosaic, and namespace)
Creating a new mosaic
Using namespaces
Registering a new namespace
Linking namespaces to mosaics
Linking namespaces to accounts
Setting account restrictions (on addresses, on mosaics, on operations)
Node client
Setting up a Symbol node
With Shoestring
Manually
Securely
In a non-custodial way
Maintaining a Symbol node
Avoiding common hacks and scams
開発者向けマニュアル
コードを使いアクションを実行する方法
Getting Started
Setup for local development
Hello World!
Tutorials
Transactions
Simple (create, sign, and emit)
Transfer transaction
Query unconfirmed transactions
Aggregate complete
Aggregate bonded
Atomic swaps (not cross-chain)
Sending messages (plain and encrypted)
Deadlines (query, modify)
Accounts
Create from private key
Create from mnemonic
Key derivation and verification
Fund via faucet
Query the balance of an account
Query historical state of an account
Account metadata (add and modify)
Cosignatories (add, modify, and remove)
Restrictions
Namespaces
Create or extend a root namespace
Create a child namespace
Namespace metadata (add, modify, and query)
Retrieving namespace info from receipts
Mosaics
Create (definition, supply, and link to a namespace)
Query mosaic state
Modify definition
Mosaic revocation
Restrictions (Global and address-based)
Metadata (Add, modify, and query)
Harvesting
Delegated harvesting
link/unlink keys: account, VRF, voting, node
Chain state
Query chain and finalization height
Check a confirmed transaction’s proof
Check mosaic’s state
Network currency (XYM)
Query supplies (total, maximum, and circulating)
Query block rewards
Query historical block rewards
Cross-chain swaps
WebSockets
Listen to new blocks
Listen to transaction flow
Listen to bonded transaction flow
Listen to transaction errors
Analytics
Query network mosaics
Query total mosaics issued
Query total active nodes
Working with local block data
Reference Guides
Python SDK
TypeScript SDK
Java SDK
REST API
テキストブック
機能についての解説
Introduction
The Symbol Vision
Cryptography primer
Accounts
Restrictions
Mnemonics
Wallets
Metadata
Cosignatories
Vanity addresses
Namespaces
Duration
Fees
Metadata
Mosaics
Restrictions
Metadata
Transactions
Simple
Aggregate
Complete
Bonded (Partial)
Multisignature
Fees
Atomic
Unconfirmed Transactions
Encrypted Messages
List of transaction types
Nodes
Consensus
Types (Peer, API, Voting)
Validators
Key Rotation
Harvesters and remote harvesters
Delegated Harvesting
Required links
Blocks
Harvesting (= Mining)
Receipts
Finalization
Trees
Roots and Leaves
Merkle Trees
Patricia Trees
Cross-chain swaps
Catapult client
Architecture
Plugins
Core
Transaction Plugins
Services
Configuration
Node properties
Network properties
CAT DSL
import
using
enum
struct
comments
次の作業
サイトの最終調整を終え、フィードバックを集めるために実証版を公開します。
それぞれのセクションについて、スタイルを設定しテンプレートとしても使えるように、最初の1ページを作成します。
その後は… とにかく書く、書く、書く。時には他の人の手も借りて、また書く、書く、書く、です。
ここまで読んでくださりありがとうございます!また来月お会いしましょう!
—