先までは、"愛記"についての記載で、どのようにブロックチェーンSNSに組み込んで実装していけばよいのか、概念的なところからアプローチ方法を記載していった。概念設計としてはひとまず終えた。次は、フェデレーションモデル全体の基本設計といえるところまで、基本設計書に着手できるようなところまで、概念を具体化していきたい。そして、それにつながるDApps側である「愛記システム」を、Pythonプログラムで開発していきたい。
愛の行動のPL,BSを決算書として、個人単位、市町村単位、で公表するような愛記システムというものを考えている。愛の行動のデータベースはブロックチェーンのプログラムであり、日々の愛の行動による愛貨の移動を決算書にまとめていきたい。なお、市町村のブロックチェーンのプログラムは以前にも記載している。その市町村のブロックチェーンのプログラムにつながる愛記システムを、DApps側であるPythonプログラムとして設計したい。その場合、基本設計をどのような手順で進めていけばよいか、詳しく見ていこう。
愛記システムを設計するための基本手順を以下に示す。このシステムは、Pythonを用いて市町村のブロックチェーンと連携し、個人および市町村単位での愛の行動のデータを収集、記録し、決算書（PL、BS）として公表するものである。
基本設計のステップ
- 要件定義
- アーキテクチャ設計
- データベース設計
- API設計
- ブロックチェーンインターフェース
- 決算書の生成
- フロントエンド開発
- テストとデプロイ
基本設計の各ステップを順番に進めることで、ブロックチェーンとDAppsとして繋がる「愛記システム」の詳細な設計が可能になる。各ステップでは、関係者との協議やレビューを通じて設計内容を確定していくことが重要である。
1．要件定義
まず、基本設計の最初のステップである要件定義をしていきたい。どのような機能が必要か、どのような問題を解決するのかを洗い出したい。要件定義はシステム設計の最初の重要なステップであり、システムが解決するべき問題と、必要な機能を明確に定義するプロセスである。以下に、愛記システムのプログラムに必要な機能と解決すべき問題を列挙してみよう。
機能要件
-
愛の行動の記録
-
愛貨の移動の記録
-
決算書の生成
-
個人および市町村単位でのデータの集約
-
データのブロックチェーンへの記録と取得
-
愛貨の管理
-
ユーザー管理
-
通知機能
-
レポート機能
-
ダッシュボード
非機能要件
-
セキュリティ
-
可用性
-
パフォーマンス
-
スケーラビリティ
-
ユーザビリティ
-
コンプライアンス
解決すべき問題
-
透明性と信頼性の確保
-
データの一元管理
-
愛の行動の促進
-
評価制度の確立
-
データのセキュリティとプライバシーの保護
これらの要件を基に、愛記システムの基本設計を進めていくことが重要である。次のステップでは、これらの要件を具体的なアーキテクチャ設計に反映していくことになる。まずは、要件定義の解決すべき問題を一つずつクリアにしていきたい。
透明性と信頼性の確保
愛貨の取引と愛の行動の記録を透明にし、信頼性を確保することが重要だ。以下に、具体的な項目とその決定プロセスを記載する。
・透明性と信頼性の確保に必要な項目と決定プロセス
1. データの完全性と一貫性の保証
-
データの完全性: すべての取引と愛の行動記録が正確かつ改ざんされていないことを保証する。
・取引ID (Transaction ID）
・日時 (Timestamp）
・送信者 (Sender）
・受信者 (Receiver）
・愛貨の量 (Amount of Love Tokens）
・取引の内容 (Transaction Content）
・署名 (Signature)
・ハッシュ値 (Hash Value）
・取引ステータス (Transaction Status）
・取引のカテゴリ (Transaction Category）
・証拠データ (Proof Data）
・受信日時 (Received Timestamp）
・ジオロケーションデータ (Geolocation Data）
・関連取引ID (Related Transaction ID）
・メタデータ (Metadata）
・ゼロ知識証明 (Zero-Knowledge Proof）
・承認者情報 (Approver Information）
・取引費用 (Transaction Fee)
・関連アクションID (Related Action ID）
・愛の行動レベル (Love Action Level）
取引データの完全性を保証するための詳細な項目は上記のような２０項目すべてを基本設計に盛り込んで行く。
-
データの一貫性: システム全体でデータが統一されていることを確認する。
2. 取引の透明性の確保
-
公開取引データ: 取引データを公開し、誰でも確認できるようにする。
-
監査ログ: 取引や行動のすべての変更履歴を保持し、監査可能にする。
3. データのセキュリティとプライバシー保護
-
暗号化: データの送受信時および保存時に暗号化を行い、データの安全性を確保。
-
アクセス制御: データへのアクセスを制御し、必要な権限を持つユーザーのみに限定。
4. 取引の正当性の確認
-
署名の生成と検証: 取引データの署名を生成し、取引の正当性を検証。
-
取引の検証: 各取引を検証し、不正行為や二重支出を防止。
これらの項目を詳細に決定し、実装することで、愛記システムの透明性と信頼性を確保することができる。各項目については、具体的な技術要件や設計仕様を定義し、システム開発の各フェーズで反映させることが重要である。
・データの一貫性について
データの完全性と一貫性を確保するための基本設計とプログラムの例を以下に示す。具体的にどのような項目を設計し、どのように実装するかについて詳しく説明する。
基本設計
1. データの一貫性
システム全体でデータが統一されていることを確認するために、次の点に注意する。
- トランザクションのアトミック性: トランザクションが完全に成功するか、まったく成功しないかを保証する。
- データの整合性チェック: データが一貫性を保つための整合性チェックを設計する。
- データの同期: 分散システム間でデータの同期を適切に行う。
2. データの完全性
データが損なわれないようにするために、次の点に注意します。
- データの暗号化: データの機密性を確保するために、保存時および通信時にデータを暗号化する。
- データのバリデーション: 入力データをバリデーションして、不正なデータがシステムに入らないようにする。
3. 監査ログ
すべての操作を監査ログに記録し、後から検証可能にする。では、以下に、データの完全性と一貫性を確保するための具体的なプログラム例を示す。
・データの整合性チェック：
データの一貫性を保証するためのDApps側でのPythonプログラムを設計する際、いくつかの重要なポイントを考慮する必要がある。以下にそのプロセスを示す。
- データ構造の定義: どのようなデータがシステムに格納されるかを明確に定義する。例えば、トランザクションデータ、ユーザーデータ、承認履歴など。ここでは、トランザクションデータ、ユーザーデータ、承認履歴のデータ構造を具体的に定義する方法を示す。これらのデータ構造は、MongoDBに保存されるドキュメントの形式として定義される。以下は、Pythonでのデータ構造の定義と、それをデータベースに格納するためのプログラム例である。
from pymongo import MongoClient
# MongoDBクライアントの接続
client = MongoClient('mongodb://localhost:27017/')
db = client['blockchain_app']
# ユーザーデータの構造を定義
user_structure = {
"user_id": "user123",
"name": "John Doe",
"public_key": "user123publickey",
}
# トランザクションデータの構造を定義
transaction_structure = {
"transaction_id": "tx1001",
"sender_id": "user123",
"receiver_id": "user456",
"amount": 100.0,
"timestamp": "2021-07-01T12:00:00",
"signature": "signaturedata",
}
# 承認履歴の構造を定義
approval_history_structure = {
"transaction_id": "tx1001",
"approver_id": "user789",
"approval_timestamp": "2021-07-01T12:05:00",
"status": "approved",
}
# MongoDBにデータを追加する関数
def add_data_to_db(collection_name, data):
collection = db[collection_name]
collection.insert_one(data)
# データをデータベースに追加
add_data_to_db('users', user_structure)
add_data_to_db('transactions', transaction_structure)
add_data_to_db('approvals', approval_history_structure)
このコードでは、次のことを行っている：
・MongoDBに接続する。
・ユーザー、トランザクション、承認履歴の各データ構造をPythonの辞書として定義する。
・これらのデータ構造をMongoDBの適切なコレクションに追加するための関数add_data_to_dbを定義し、使用する。
・各データ構造は、システムのニーズに基づいて必要なフィールドを持っている。たとえば、トランザクションは送信者、受信者、金額、タイムスタンプ、署名を含んでいる。これにより、データの一貫性と完全性が保証され、システム全体でのデータの統一と整合性を維持するための基盤が確立される。
- データの整合性要件: 各データがどのように一貫性を保つべきかのルールを設定する。例えば、トランザクションは常に正確なタイムスタンプと署名を持つ必要がある。データの整合性要件を設定するには、アプリケーションのデータ構造に対して一定の検証ロジックを実装する必要がある。この検証ロジックは、データがデータベースに保存される前に適用され、データの完全性と一貫性を保証するために役立つ。ここでは、トランザクションデータに対してタイムスタンプと署名の検証を行う。
import hashlib
import datetime
from pymongo import MongoClient
client = MongoClient('mongodb://localhost:27017/')
db = client['blockchain_db']
def verify_signature(transaction_data, public_key, signature):
"""署名を検証する疑似関数"""
return hashlib.sha256((str(transaction_data) + public_key).encode()).hexdigest() == signature
def is_timestamp_valid(timestamp):
"""タイムスタンプが現在よりも未来でないことを確認する"""
current_timestamp = datetime.datetime.now().timestamp()
return timestamp <= current_timestamp
def check_transaction_consistency(transaction):
"""トランザクションの整合性をチェックする関数"""
# トランザクションデータから必要な情報を抽出
transaction_data = transaction['data']
public_key = transaction['public_key']
signature = transaction['signature']
timestamp = transaction['timestamp']
# 署名の検証
if not verify_signature(transaction_data, public_key, signature):
raise ValueError("Invalid Signature")
# タイムスタンプの検証
if not is_timestamp_valid(timestamp):
raise ValueError("Invalid Timestamp")
def add_transaction(transaction):
"""トランザクションを安全にデータベースに追加する"""
try:
check_transaction_consistency(transaction)
db.transactions.insert_one(transaction)
print("Transaction added successfully.")
except ValueError as error:
print(f"Error adding transaction: {error}")
# トランザクションの例
transaction = {
'data': 'some important data',
'timestamp': datetime.datetime.now().timestamp(),
'public_key': 'user123publickey',
'signature': 'validsignature123'
}
add_transaction(transaction)
このコードは以下の処理を行う：
・署名検証：トランザクションのデータと公開鍵を用いて署名が正しいかどうかを検証する。これにより、データが改ざんされていないことを保証する。
・タイムスタンプ検証：提供されたタイムスタンプが現在時刻よりも未来でないことを確認する。これにより、未来の日付でトランザクションが生成されるのを防ぐ。
・データベースへの安全な追加：整合性チェックをパスしたトランザクションのみがデータベースに追加される。整合性チェックに失敗した場合はエラーが報告される。
・これらの検証ステップを通じて、データの一貫性と完全性が保たれ、システムの信頼性が向上する。
- 整合性チェックのアルゴリズム: トランザクションが送信された際に、その整合性を確認するロジックを実装する。整合性チェックのアルゴリズムを実装する際には、以下のロジックが含まれる：
・データの完全性チェック：トランザクションデータが改ざんされていないかを確認する。
・タイムスタンプの妥当性：トランザクションのタイムスタンプが未来の時間になっていないかを確認する。
・重複チェック：同じトランザクションIDが既に存在しないかを確認する。
・関連データの一貫性：送信者および受信者のアカウントが存在するか、バランスが不足していないかを確認する。
これらのチェックを行うロジックを以下のPythonプログラムで示す：
import hashlib
import datetime
from pymongo import MongoClient
client = MongoClient('mongodb://localhost:27017/')
db = client['blockchain_db']
def verify_signature(transaction_data, public_key, signature):
"""署名を検証する関数。簡単なハッシュベースの検証を想定している。"""
expected_signature = hashlib.sha256((str(transaction_data) + public_key).encode()).hexdigest()
return expected_signature == signature
def is_timestamp_valid(timestamp):
"""タイムスタンプが現在よりも未来でないことを確認する関数。"""
current_timestamp = datetime.datetime.now().timestamp()
return timestamp <= current_timestamp
def is_unique_transaction(transaction_id):
"""トランザクションIDが一意であることを確認する関数。"""
existing_transaction = db.transactions.find_one({"transaction_id": transaction_id})
return existing_transaction is None
def check_account_existence(account_id):
"""アカウントが存在するかを確認する関数。"""
account = db.accounts.find_one({"account_id": account_id})
return account is not None
def check_sufficient_balance(sender_id, amount):
"""送信者の残高が十分であることを確認する関数。"""
sender_account = db.accounts.find_one({"account_id": sender_id})
return sender_account and sender_account['balance'] >= amount
def check_transaction_consistency(transaction):
"""トランザクションの整合性をチェックする関数。
トランザクションデータ、公開鍵、署名、タイムスタンプ、重複性、アカウントの存在、残高を検証する。"""
if not verify_signature(transaction['data'], transaction['public_key'], transaction['signature']):
raise ValueError("Invalid Signature")
if not is_timestamp_valid(transaction['timestamp']):
raise ValueError("Invalid Timestamp")
if not is_unique_transaction(transaction['transaction_id']):
raise ValueError("Duplicate Transaction ID")
if not check_account_existence(transaction['sender']):
raise ValueError("Sender Account Does Not Exist")
if not check_account_existence(transaction['receiver']):
raise ValueError("Receiver Account Does Not Exist")
if not check_sufficient_balance(transaction['sender'], transaction['amount']):
raise ValueError("Insufficient Balance")
def add_transaction(transaction):
"""トランザクションを安全にデータベースに追加する関数。"""
with client.start_session() as session:
with session.start_transaction():
check_transaction_consistency(transaction)
db.transactions.insert_one(transaction, session=session)
# 送信者の残高を減らし、受信者の残高を増やす
db.accounts.update_one({"account_id": transaction['sender']}, {"$inc": {"balance": -transaction['amount']}}, session=session)
db.accounts.update_one({"account_id": transaction['receiver']}, {"$inc": {"balance": transaction['amount']}}, session=session)
# トランザクションの例
transaction = {
'transaction_id': 'txn123456',
'data': 'some important data',
'timestamp': datetime.datetime.now().timestamp(),
'public_key': 'user123publickey',
'signature': 'generatedsignature',
'sender': 'user123',
'receiver': 'user456',
'amount': 50
}
try:
add_transaction(transaction)
print("Transaction added successfully.")
except ValueError as e:
print(f"Error adding transaction: {e}")
各関数の説明
・verify_signature: 署名の検証を行う。トランザクションデータと公開鍵を組み合わせてハッシュを生成し、それが提供された署名と一致するか確認する。
・is_timestamp_valid: タイムスタンプが未来の時間でないかを確認する。
・is_unique_transaction: トランザクションIDがデータベース内で一意であることを確認する。
・check_account_existence: 送信者と受信者のアカウントがデータベース内に存在するか確認する。
・check_sufficient_balance: 送信者のアカウントに十分な残高があるか確認する。
・check_transaction_consistency: 上記のすべてのチェックを行い、トランザクションが整合性を保っているか確認する。
・add_transaction: トランザクションをデータベースに安全に追加し、残高の更新を行う。
この設計により、送信されたトランザクションが整合性を保つための包括的なチェックを実施することができる。
- データベーストランザクションの利用: データベースレベルでのトランザクションを使用して、データの更新がアトミックに行われることを保証する。これにより、データが中途半端な状態になることを防ぐ。以下に、データベーストランザクションを利用してトランザクションの追加とアカウントの残高更新をアトミックに行う方法を示す。以下のPythonプログラムでは、MongoDBを使用してデータベーストランザクションを実装している。with client.start_session() as session:とwith session.start_transaction():を使用して、トランザクションの開始と終了を管理している。
import hashlib
import datetime
from pymongo import MongoClient, errors
client = MongoClient('mongodb://localhost:27017/')
db = client['blockchain_db']
def verify_signature(transaction_data, public_key, signature):
"""署名を検証する関数"""
expected_signature = hashlib.sha256((str(transaction_data) + public_key).encode()).hexdigest()
return expected_signature == signature
def is_timestamp_valid(timestamp):
"""タイムスタンプが現在よりも未来でないことを確認する関数"""
current_timestamp = datetime.datetime.now().timestamp()
return timestamp <= current_timestamp
def is_unique_transaction(transaction_id):
"""トランザクションIDが一意であることを確認する関数"""
existing_transaction = db.transactions.find_one({"transaction_id": transaction_id})
return existing_transaction is None
def check_account_existence(account_id):
"""アカウントが存在するかを確認する関数"""
account = db.accounts.find_one({"account_id": account_id})
return account is not None
def check_sufficient_balance(sender_id, amount):
"""送信者の残高が十分であることを確認する関数"""
sender_account = db.accounts.find_one({"account_id": sender_id})
return sender_account and sender_account['balance'] >= amount
def check_transaction_consistency(transaction):
"""トランザクションの整合性をチェックする関数"""
if not verify_signature(transaction['data'], transaction['public_key'], transaction['signature']):
raise ValueError("Invalid Signature")
if not is_timestamp_valid(transaction['timestamp']):
raise ValueError("Invalid Timestamp")
if not is_unique_transaction(transaction['transaction_id']):
raise ValueError("Duplicate Transaction ID")
if not check_account_existence(transaction['sender']):
raise ValueError("Sender Account Does Not Exist")
if not check_account_existence(transaction['receiver']):
raise ValueError("Receiver Account Does Not Exist")
if not check_sufficient_balance(transaction['sender'], transaction['amount']):
raise ValueError("Insufficient Balance")
def add_transaction(transaction):
"""トランザクションを安全にデータベースに追加する関数"""
with client.start_session() as session:
with session.start_transaction():
try:
check_transaction_consistency(transaction)
db.transactions.insert_one(transaction, session=session)
# 送信者の残高を減らし、受信者の残高を増やす
db.accounts.update_one({"account_id": transaction['sender']}, {"$inc": {"balance": -transaction['amount']}}, session=session)
db.accounts.update_one({"account_id": transaction['receiver']}, {"$inc": {"balance": transaction['amount']}}, session=session)
# トランザクションが成功したらコミット
session.commit_transaction()
except (ValueError, errors.PyMongoError) as e:
# エラーが発生した場合はロールバック
session.abort_transaction()
raise e
# トランザクションの例
transaction = {
'transaction_id': 'txn123456',
'data': 'some important data',
'timestamp': datetime.datetime.now().timestamp(),
'public_key': 'user123publickey',
'signature': 'generatedsignature',
'sender': 'user123',
'receiver': 'user456',
'amount': 50
}
try:
add_transaction(transaction)
print("Transaction added successfully.")
except ValueError as e:
print(f"Error adding transaction: {e}")
except errors.PyMongoError as e:
print(f"Database error: {e}")
データベーストランザクションの利用
・セッションの開始と終了: with client.start_session() as session: でデータベースセッションを開始し、with session.start_transaction(): でトランザクションを開始する。
・トランザクションの整合性チェックとデータベース操作: トランザクションの整合性チェックとデータベース操作（トランザクションの追加、残高の更新）はトランザクション内で行われる。
・コミットとロールバック: 正常に処理が完了した場合は session.commit_transaction() でトランザクションをコミットし、エラーが発生した場合は session.abort_transaction() でロールバックする。
この設計により、トランザクションの追加と残高の更新がアトミックに行われることを保証し、データの整合性を保つことができる。
- エラーハンドリング: データの整合性が崩れた場合に適切に対応できるよう、エラーハンドリングを設計する。
エラーハンドリングを設計する際には、以下の点に注意する必要がある。
・エラーの分類: エラーを分類し、それぞれに適切な処理を行う。
・エラーのログ記録: エラーが発生した場合にログを記録し、問題の追跡と分析ができるようにする。
・ユーザーへの通知: ユーザーにエラーを通知し、適切なフィードバックを提供する。
・リトライ機構: 一時的なエラーに対しては、自動的にリトライする機構を設ける。
・トランザクションのロールバック: データの整合性を保つために、エラーが発生した場合にはトランザクションをロールバックする。
以下に、上記の設計ポイントを踏まえたPythonプログラムの例を示す。
import hashlib
import datetime
import logging
from pymongo import MongoClient, errors
# ログの設定
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
client = MongoClient('mongodb://localhost:27017/')
db = client['blockchain_db']
class TransactionError(Exception):
"""カスタムトランザクションエラークラス"""
pass
def verify_signature(transaction_data, public_key, signature):
"""署名を検証する関数"""
expected_signature = hashlib.sha256((str(transaction_data) + public_key).encode()).hexdigest()
return expected_signature == signature
def is_timestamp_valid(timestamp):
"""タイムスタンプが現在よりも未来でないことを確認する関数"""
current_timestamp = datetime.datetime.now().timestamp()
return timestamp <= current_timestamp
def is_unique_transaction(transaction_id):
"""トランザクションIDが一意であることを確認する関数"""
existing_transaction = db.transactions.find_one({"transaction_id": transaction_id})
return existing_transaction is None
def check_account_existence(account_id):
"""アカウントが存在するかを確認する関数"""
account = db.accounts.find_one({"account_id": account_id})
return account is not None
def check_sufficient_balance(sender_id, amount):
"""送信者の残高が十分であることを確認する関数"""
sender_account = db.accounts.find_one({"account_id": sender_id})
return sender_account and sender_account['balance'] >= amount
def check_transaction_consistency(transaction):
"""トランザクションの整合性をチェックする関数"""
if not verify_signature(transaction['data'], transaction['public_key'], transaction['signature']):
raise TransactionError("Invalid Signature")
if not is_timestamp_valid(transaction['timestamp']):
raise TransactionError("Invalid Timestamp")
if not is_unique_transaction(transaction['transaction_id']):
raise TransactionError("Duplicate Transaction ID")
if not check_account_existence(transaction['sender']):
raise TransactionError("Sender Account Does Not Exist")
if not check_account_existence(transaction['receiver']):
raise TransactionError("Receiver Account Does Not Exist")
if not check_sufficient_balance(transaction['sender'], transaction['amount']):
raise TransactionError("Insufficient Balance")
def add_transaction(transaction):
"""トランザクションを安全にデータベースに追加する関数"""
try:
with client.start_session() as session:
with session.start_transaction():
check_transaction_consistency(transaction)
db.transactions.insert_one(transaction, session=session)
# 送信者の残高を減らし、受信者の残高を増やす
db.accounts.update_one({"account_id": transaction['sender']}, {"$inc": {"balance": -transaction['amount']}}, session=session)
db.accounts.update_one({"account_id": transaction['receiver']}, {"$inc": {"balance": transaction['amount']}}, session=session)
# トランザクションが成功したらコミット
session.commit_transaction()
logging.info(f"Transaction {transaction['transaction_id']} added successfully.")
except TransactionError as e:
logging.error(f"Transaction error: {e}")
raise
except errors.PyMongoError as e:
logging.error(f"Database error: {e}")
raise
# トランザクションの例
transaction = {
'transaction_id': 'txn123456',
'data': 'some important data',
'timestamp': datetime.datetime.now().timestamp(),
'public_key': 'user123publickey',
'signature': 'generatedsignature',
'sender': 'user123',
'receiver': 'user456',
'amount': 50
}
try:
add_transaction(transaction)
except Exception as e:
print(f"Error adding transaction: {e}")
エラーハンドリングの詳細
・エラーの分類:
TransactionError クラスを定義し、トランザクションに関連するエラーを扱う。
PyMongoError をキャッチして、データベースエラーを扱う。
・エラーのログ記録:
logging モジュールを使用して、エラーが発生した場合に詳細なログを記録する。
・ユーザーへの通知:
add_transaction 関数内でエラーが発生した場合に、適切なメッセージを表示する。
・リトライ機構:
この例ではリトライ機構は含まれていないが、一時的なデータベースエラーに対してリトライするロジックを追加することが可能である。
・トランザクションのロールバック:
トランザクションが正常に完了しない場合、session.abort_transaction() によって自動的にロールバックされる。
この設計により、トランザクションの整合性が崩れた場合やエラーが発生した場合に適切に対処することができる。