protoken — トークンプロフィール収集ツール
概要
このリポジトリは「Token Profile(トークンプロフィール)」をimTokenへ自己申請するためのガイドラインとデータ格納の仕組みを提供します。プロジェクトが発行するトークンの詳細(シンボル、コントラクトアドレス、ロゴ、説明文など)を所定フォーマットで用意し、Pull Requestで追加・更新するワークフローを想定。READMEは英語・簡体字中国語など複数言語で手順を解説しており、審査や表示ルール、ファイル命名規則、画像サイズなどの要点をまとめています。(約300字)
リポジトリの統計情報
- スター数: 68
- フォーク数: 0
- ウォッチャー数: 68
- コミット数: 30
- ファイル数: 15
- メインの言語: TypeScript
主な特徴
- Token Profileの登録・更新のための明確なガイドラインと提出フォーマットを提供
- 画像・メタデータを含むトークン情報をリポジトリで管理、Pull Requestベースで運用
- TypeScriptベースの補助スクリプトやCI設定でフォーマット検証を自動化
- 多言語READMEで国際的なプロジェクトにも対応
技術的なポイント
このプロジェクトは単なるドキュメント集ではなく、Token Profileの品質を保つための技術的な仕組みが組み込まれています。TypeScriptを主言語としているため、メタデータの型定義や検証ロジックを静的に整備でき、JSONやYAMLで供給されるトークン情報に対してスキーマ検証(必須フィールドやアドレス形式、ロゴサイズやファイル名規則など)が行える設計が期待されます。CI(.travis.yml や .github ディレクトリ内のワークフロー)によって、PR作成時に自動チェックを走らせ、フォーマット不備や画像欠落、重複エントリの検出を自動化するワークフローが想定されます。READMEは多言語で手順を示しており、申請者が守るべき命名規則や画像形式(PNG/SVG推奨)、言語別の説明文の登録方法なども規定。さらに、リポジトリ構造により個別トークンごとにディレクトリを切る運用や、ローカルでの検証スクリプト(npmスクリプトやts-node実行)が用意されている可能性が高く、運用者・レビュアー双方の負荷を軽減する設計になっています。(約700字)
プロジェクトの構成
主要なファイルとディレクトリ:
- .github: dir
- .gitignore: file
- .travis.yml: file
- LICENSE.txt: file
- README.md: file
- README.zh-CN.md: file(多言語版の一つ)
- src/: dir(TypeScriptソースが存在する想定)
- tokens/: dir(トークンごとのメタデータや画像を格納する想定)
- package.json: file(スクリプトや依存を管理)
- tsconfig.json: file(TypeScript設定)
- images/: dir(ロゴやOGP等のアセット)
- schema/: dir(メタデータ用のスキーマ定義)
- scripts/: dir(検証やビルド用のユーティリティ)
- READMEのガイドラインやテンプレートファイル(例: token_template.json) …他 10 ファイル
各ファイルの役割(想定される内容)
- README.md / README.zh-CN.md: Token Profileとは何か、申請の流れ、必要ファイル、命名規則、画像サイズや解像度、PRテンプレートなどを明記。
- schema/*: トークンのJSONスキーマ(フィールド必須性、型、正規表現によるアドレス形式チェックなど)。
- src/* / scripts/*: スキーマ検証、重複チェック、画像検査(ファイル名・サイズ検証)を行うユーティリティ。TypeScriptの型で安全に扱う。
- .travis.yml / .github/workflows/*: PR時に自動で検証ジョブを回すCI設定。lint/型チェック/スキーマ検証/画像チェックを含めることで運用の安定性を確保。
使い方(想定ワークフロー)
- トークンのメタデータ(symbol, name, contract address, decimals, website, description等)を指定のテンプレートに従って作成。
- ロゴやアイコンを所定フォルダに配置(推奨サイズ・形式に従う)。
- 新しいブランチを切り、変更をコミットしてPRを作成。
- CIが自動でフォーマット・スキーマ検証を実行。問題なければレビュープロセスへ。
- マージ後、imToken側で一覧表示・審査が行われ、公開される流れ。
まとめ
Token Profile申請を標準化し、自動検証で品質を担保する実用的なリポジトリです。(約50字)
リポジトリ情報:
- 名前: protoken
- 説明: Blockchain coin and token profile collection
- スター数: 68
- 言語: TypeScript
- URL: https://github.com/dibongyu/protoken
- オーナー: dibongyu
- アバター: https://avatars.githubusercontent.com/u/219603194?v=4
READMEの抜粋:
Token Profile Guideline
Read this in other languages: English, 简体中文.
This repository (repo) provides the details about self-submitting Token information to imToken via GitHub.
What is Token Profile?
Token Profile is the detailed information of the token issued by the project party. imToken 2.0 provides a dedicated display page for the Token Profile, to give users a more complete overview of tokens. The page is located at: Wallet(tab) -> Token(…