Update 2025/5/6

Feb 2025 The Symbol Syndicate’s Docs Blogs

2025年2月のブログはこちらから
strapi-blog-api-image

【日本語訳】行った作業の概要


  • 刊行予定のSymbolに関する書籍のレビュー Opening Line 社より、Symbolブロックチェーンを使ったアプリケーションの作成に関する刊行予定の書籍のレビューを依頼されました。日本語は私の学習課題リストにある言語の一つですが、本書は日本語で書かれていたため困難に感じたものの、非常にやりがいのあるものでした。本書の実践的なアプローチは大変魅力的で、レビューを通して多くのことを学ぶことができました。
  • サイトの構成 ドキュメント用の静的サイトジェネレーターには MkDocsMaterial を採用し、現在必要なプラグインの設定を進めています。特に Python、TypeScript、Java、RESTといった複数言語のAPIドキュメントが必要であり、それら全てに単一のツールで対応できないため、プラグイン同士の連携が必ずしもうまくいかないという課題があります。サイトには、 mkdocstringsTypedocDoxygenSwagger-ui-tag などを利用しており、ツールチップは機能するようになりました。現在取り組んでいることは、全体としてより統一感が出るように、テーマを統合することです。このプロジェクトでは比較的コーディング作業も発生するのですが、私はコーディングからしばらく離れていたため、むしろ面白く感じています!チュートリアルの作成に取り掛かるのが、今から本当に楽しみです!
  • マネジメント マネジメントなんて誰も好きじゃありませんが、こればかりは避けられませんよね ¯(ツ)/¯ 求人票の作成、ライター候補者との面接、タスクリスト作りなど…。ですが、その甲斐あって、作成したい全ページのリストが出来上がりました!次のセクションもぜひチェックしてみてください。
  • コンテンツ執筆 今月はコンテンツ作成はあまり進んでいませんが、旧 NEM NIS1 REST API の OpenAPI 仕様に関して動きがありました。実情として現在は Symbol のドキュメントに注力していますが、NEM のことを忘れたわけではありません。
今月のタスクごとの時間配分はこちらでご確認いただけます。
strapi-blog-api-image
サイトの準備が完全に整い次第、皆さんにお知らせいたします。その後はコンテンツ執筆に全力を注ぎ、サイトの管理や設定にかかる手間は、できれば最小限に抑えたいと考えています。今後ライターの方々が加わった段階で、私の時間は執筆とレビューに費やされることになるかと思います。

サイトマップ

以下が Symbol のドキュメントとして作成予定の全ページのリストです。
すでに存在するページもあれば、基礎として利用できるチュートリアルコードがあるページもあります。また、完全に新規で作成する必要があるページも含まれています。
  この機会に何でもリクエストしてください!
以下のリストをご確認いただき、何か足りないと思われる点や、お気づきの点がございましたら、ぜひお知らせください!
以下のリストをご確認いただき、何か足りないと思われる点や、お気づきの点がございましたら、ぜひお知らせください!
連絡先はこのブログのトップページにあります。

ユーザーマニュアル

コードを必要としない操作方法
  1. Symbol Desktop Wallet
    1. Creating an account
    2. Using a Ledger device
    3. Sending mosaics and messages
    4. Using multisig accounts
      1. Creating a multisig account
      2. Cosigning transactions
    5. Enabling harvesting
    6. Reading and writing metadata (account, mosaic, and namespace)
    7. Creating a new mosaic
    8. Using namespaces
      1. Registering a new namespace
      2. Linking namespaces to mosaics
      3. Linking namespaces to accounts
    9. Setting account restrictions (on addresses, on mosaics, on operations)
  2. Node client
    1. Setting up a Symbol node
      1. With Shoestring
      2. Manually
      3. Securely
      4. In a non-custodial way
    2. Maintaining a Symbol node
  3. Avoiding common hacks and scams

開発者向けマニュアル

コードを使いアクションを実行する方法
  1. Getting Started
    1. Setup for local development
    2. Hello World!
  2. Tutorials
    1. Transactions
      1. Simple (create, sign, and emit)
      2. Transfer transaction
      3. Query unconfirmed transactions
      4. Aggregate complete
      5. Aggregate bonded
      6. Atomic swaps (not cross-chain)
      7. Sending messages (plain and encrypted)
      8. Deadlines (query, modify)
    2. Accounts
      1. Create from private key
      2. Create from mnemonic
      3. Key derivation and verification
      4. Fund via faucet
      5. Query the balance of an account
      6. Query historical state of an account
      7. Account metadata (add and modify)
      8. Cosignatories (add, modify, and remove)
      9. Restrictions
    3. Namespaces
      1. Create or extend a root namespace
      2. Create a child namespace
      3. Namespace metadata (add, modify, and query)
      4. Retrieving namespace info from receipts
    4. Mosaics
      1. Create (definition, supply, and link to a namespace)
      2. Query mosaic state
      3. Modify definition
      4. Mosaic revocation
      5. Restrictions (Global and address-based)
      6. Metadata (Add, modify, and query)
    5. Nodes
      1. Rotate voting keys
    6. Harvesting
      1. Delegated harvesting link/unlink keys: account, VRF, voting, node
    7. Chain state
      1. Query chain and finalization height
      2. Check a confirmed transaction’s proof
      3. Check mosaic’s state
    8. Network currency (XYM)
      1. Query supplies (total, maximum, and circulating)
      2. Query block rewards
      3. Query historical block rewards
    9. Cross-chain swaps
    10. WebSockets
      1. Listen to new blocks
      2. Listen to transaction flow
      3. Listen to bonded transaction flow
      4. Listen to transaction errors
    11. Analytics
      1. Query network mosaics
      2. Query total mosaics issued
      3. Query total active nodes
      4. Working with local block data
  3. Reference Guides
    1. Python SDK
    2. TypeScript SDK
    3. Java SDK
    4. REST API

テキストブック

機能についての解説
  1. Introduction
    1. The Symbol Vision
    2. Cryptography primer
  2. Accounts
    1. Restrictions
    2. Mnemonics
    3. Wallets
    4. Metadata
    5. Cosignatories
    6. Vanity addresses
  3. Namespaces
    1. Duration
    2. Fees
    3. Metadata
  4. Mosaics
    1. Restrictions
    2. Metadata
  5. Transactions
    1. Simple
    2. Aggregate
      1. Complete
      2. Bonded (Partial)
    3. Multisignature
    4. Fees
    5. Atomic
    6. Unconfirmed Transactions
    7. Encrypted Messages
    8. List of transaction types
  6. Nodes
    1. Consensus
    2. Types (Peer, API, Voting)
    3. Validators
    4. Key Rotation
    5. Harvesters and remote harvesters
    6. Delegated Harvesting
      1. Required links
  7. Blocks
    1. Harvesting (= Mining)
    2. Receipts
    3. Finalization
    4. Trees
      1. Roots and Leaves
      2. Merkle Trees
      3. Patricia Trees
  8. Cross-chain swaps
  9. Catapult client
    1. Architecture
    2. Plugins
      1. Core
      2. Transaction Plugins
      3. Services
    3. Configuration
      1. Node properties
      2. Network properties
  10. CAT DSL
    1. import
    2. using
    3. enum
    4. struct
    5. comments

次の作業

サイトの最終調整を終え、フィードバックを集めるために実証版を公開します。
それぞれのセクションについて、スタイルを設定しテンプレートとしても使えるように、最初の1ページを作成します。
その後は… とにかく書く、書く、書く。時には他の人の手も借りて、また書く、書く、書く、です。
ここまで読んでくださりありがとうございます!また来月お会いしましょう!
strapi-blog-api-image
Xavi (日本語訳 Radio)

News
Community
Docs
Contact