ScalarDL の設定
注記
このページは英語版のページが機械翻訳されたものです。英語版との間に矛盾または不一致がある場合は、英語版を正としてください。
このページでは、ScalarDL で利用可能な以下の設定について説明します:
Ledger の設定
Ledger サーバーでは、サービスポ ート設定、認証設定、TLS 設定など、いくつかの設定を行うことができます。
auditor.cert_holder_id
(非推奨)
- フィールド:
scalar.dl.ledger.auditor.cert_holder_id
- 説明: Auditor 証明書ホルダー ID。このフィールドは、Auditor の証明書ホルダーを識別するために使用されます。
- デフォルト値:
auditor
注記
この設定は非推奨であり、Ledger-Auditor 認証が HMAC のみを使用するようになるため、リリース 5.0.0 で削除されます。認証の詳細については、ScalarDL 認証ガイドを参照してください。
auditor.cert_version
(非推奨)
- フィールド:
scalar.dl.ledger.auditor.cert_version
- 説明: Auditor 証明書バージョン。このフィールドは、Auditor 証明書のバージョンを指定します。
- デフォルト値:
1
注記
この設定は非推奨であり、Ledger-Auditor 認証が HMAC のみを使用するようになるため、リリース 5.0.0 で削除されます。認証の詳細については、ScalarDL 認証ガイドを参照してください。
auditor.enabled
- フィールド:
scalar.dl.ledger.auditor.enabled
- 説明: Auditor を有効にするオプション。このフィールドは、Auditor が 有効かどうかを決定します。
- デフォルト値:
false
authentication.hmac.cipher_key
- フィールド:
scalar.dl.ledger.authentication.hmac.cipher_key
- 説明: クライアントエンティティの HMAC 秘密鍵を暗号化および復号するために使用される暗号鍵。このフィールドは、HMAC 認証の暗号鍵を指定するために使用されます。
- デフォルト値: 空 (オプション)
authentication.method
- フィールド:
scalar.dl.ledger.authentication.method
- 説明: クライアントとサーバーの認証方法。このフィールドは、クライアントとサーバー間で使用される認証方法を指定します。
- デフォルト値: 空 (オプション)
direct_asset_access.enabled
- フィールド:
scalar.dl.ledger.direct_asset_access.enabled
- 説明:
asset_metadata
を経由せずにアセットテーブルに直接アクセスするためのオプション。このフィールドは、アセットテーブルへの直接アクセスが有効かどうかを決定します。 - デフォルト値:
false
executable_contracts
- フィールド:
scalar.dl.ledger.executable_contracts
- 説明: 実行可能なコントラクトのバイナリ名。このフィールドは、実行可能なコントラクトのバイナリ名を指定します。
- デフォルト値: 空
function.enabled
- フィールド:
scalar.dl.ledger.function.enabled
- 説明: 変更可能なデータベースの機能を有効にするオプション。このフィールドは、変更可能なデータベースの機能が有効かどうかを決定します。
- デフォルト値:
true
name
- フィールド:
scalar.dl.ledger.name
- 説明: Ledger の名前。このフィールドは、Ledger の名前を指定します。
- デフォルト値:
Scalar Ledger
(オプション)
namespace
- フィールド:
scalar.dl.ledger.namespace
- 説明: Ledger テーブルの名前空間。このフィールドは、Ledger テーブルの名前空間を指定します。
- デフォルト値:
scalar
(オプション)
proof.enabled
- フィールド:
scalar.dl.ledger.proof.enabled
- 説明: アセットを検証するために使用されるアセット証明を有効にするオプション。このフィールドは、アセット証明が有効かどうかを決定します。
- デフォルト値:
false
proof.private_key_path
- フィールド:
scalar.dl.ledger.proof.private_key_path
- 説明: PEM 形式の秘密鍵ファイルのパス。このフィールドは、PEM 形式の秘密鍵ファイルのパスを指定します。
- デフォルト値: 空
proof.private_key_pem
- フィールド:
scalar.dl.ledger.proof.private_key_pem
- 説明: PEM エンコードされた秘密鍵データ。このフィールドは、PEM エンコードされた秘密鍵データを指定します。
- デフォルト値: 空
server.admin_port
- フィールド:
scalar.dl.ledger.server.admin_port
- 説明: サーバー管理ポート。このフィールドは、サーバー管理ポートを指定します。
- デフォルト値:
50053
server.decommissioning_duration_secs
- フィールド:
scalar.dl.ledger.server.decommissioning_duration_secs
- 説明: サーバーが稼働しているが、gRPC ヘルスチェックリクエストに
NOT_SERVING
を返す廃止期間。このフィールドは、廃止期間を指定します。 - デフォルト値:
30 秒
(オプション)
server.grpc.max_inbound_message_size
- フィールド:
scalar.dl.ledger.server.grpc.max_inbound_message_size
- 説明: 単一の gRPC フレームに許可される最大メッセージサイズ。このフィールドは、単一の gRPC フレームの最大メッセージサイズを指定します。
- デフォルト値: 空 (オプション)
server.grpc.max_inbound_metadata_size
- フィールド:
scalar.dl.ledger.server.grpc.max_inbound_metadata_size
- 説明: 受信が許可されるメタデータの最大サイズ。このフィールドは、受信が許可されるメタデータの最大サイズを指定します。
- デフォルト値:
8 KiB
(オプション)
server.port
- フィールド:
scalar.dl.ledger.server.port
- 説明: サーバーポート。このフィールドは、サーバーポートを指定します。
- デフォルト値:
50051
server.privileged_port
- フィールド:
scalar.dl.ledger.server.privileged_port
- 説明: サーバ ー特権ポート。このフィールドは、サーバー特権ポートを指定します。
- デフォルト値:
50052
server.prometheus_exporter_port
- フィールド:
scalar.dl.ledger.server.prometheus_exporter_port
- 説明: Prometheus エクスポーターポート。このフィールドは、Prometheus エクスポーターポートを指定します。
- デフォルト値:
8080
server.tls.cert_chain_path
- フィールド:
scalar.dl.ledger.server.tls.cert_chain_path
- 説明: TLS 通信に使用される証明書チェーンファイル。このフィールドは、TLS 通信に使用される証明書チェーンファイルを指定します。
- デフォルト値: 空
server.tls.enabled
- フィールド:
scalar.dl.ledger.server.tls.enabled
- 説明: クライアントとサーバー間の TLS を有効にするオプション。このフィールドは、クライアントとサーバー間の TLS が有効かどうかを決定します。
- デフォルト値:
false
server.tls.private_key_path
- フィールド:
scalar.dl.ledger.server.tls.private_key_path
- 説明: TLS 通信に使用される秘密鍵ファイル。このフィールドは、TLS 通信に使用される秘密鍵ファイルを指定します。
- デフォルト値: 空
servers.authentication.hmac.secret_key
- フィールド:
scalar.dl.ledger.servers.authentication.hmac.secret_key
- 説明: (Ledger と Auditor) サーバー間のメッセージ認証のための HMAC の秘密鍵。このフィールドは、Ledger と Auditor サーバー間の認証のための HMAC の秘密鍵を指定します。
- デフォルト値: 空
tx_state_management.enabled
- フィールド:
scalar.dl.ledger.tx_state_management.enabled
- 説明: Ledger によるトランザクション状態管理を有 効にするオプション。このフィールドは、Ledger によるトランザクション状態管理が有効かどうかを決定します。
- デフォルト値:
false
Auditor の設定
Auditor サーバーでは、サービスポート設定、認証設定、TLS 設定など、いくつかの設定を行うことができます。
authentication.hmac.cipher_key
- フィールド:
scalar.dl.auditor.authentication.hmac.cipher_key
- 説明: クライアントエンティティの HMAC 秘密鍵を暗号化および復号するために使用される暗号鍵。これは、
scalar.dl.auditor.authentication.method
が "hmac" に設定されている場合にのみ使用されます。 - デフォルト値: 空 (オプション)
authentication.method
- フィールド:
scalar.dl.auditor.authentication.method
- 説明: クライアントと Auditor サーバーの認証方法。これは、クライアントの設定と一致している必要があります。
- デフォルト値:
digital-signature
(オプション)
authorization.credential
- フィールド:
scalar.dl.auditor.authorization.credential
- 説明: 認可資格情報 (例: ベアラートークン)。
- デフォルト値: 空 (オプション)
grpc.deadline_duration_millis
- フィールド:
scalar.dl.auditor.grpc.deadline_duration_millis
- 説明: 各 gRPC リクエストの期限期間 (ミリ秒)。
- デフォルト値: 空 (オプション)
ledger.host
- フィールド:
scalar.dl.auditor.ledger.host
- 説明: Ledger サーバーのホスト名または IP アドレス。
- デフォルト値:
localhost
ledger.port
- フィールド:
scalar.dl.auditor.ledger.port
- 説明: Ledger サーバーのポート番号。
- デフォルト値:
50051
ledger.privileged_port
- フィールド:
scalar.dl.auditor.ledger.privileged_port
- 説明: Ledger サーバーの特権ポート番号。
- デフォルト値:
50052
name
- フィールド:
scalar.dl.auditor.name
- 説明: Auditor の名前。
- デフォルト値:
Scalar Auditor
(オプション)
namespace
- フィールド:
scalar.dl.auditor.namespace
- 説明: Auditor テーブルの名前空間。
- デフォルト値:
auditor
(オプション)
server.admin_port
- フィールド:
scalar.dl.auditor.server.admin_port
- 説明: サーバー管理ポート。
- デフォルト値:
40053
server.decommissioning_duration_secs
- フィールド:
scalar.dl.auditor.server.decommissioning_duration_secs
- 説明: サーバーが稼働しているが、gRPC ヘルスチェックリクエストに
NOT_SERVING
を返す廃止期間 (秒)。 - デフォルト値:
30
server.grpc.max_inbound_message_size
- フィールド:
scalar.dl.auditor.server.grpc.max_inbound_message_size
- 説明: 単一の gRPC フレームに許可される最大メッセージサイズ。
- デフォルト値: 空 (オプション)
server.grpc.max_inbound_metadata_size
- フィールド:
scalar.dl.auditor.server.grpc.max_inbound_metadata_size
- 説明: 受信が許可されるメタデータの最大サイズ。
- デフォルト値:
8 KiB
(オプション)
server.port
- フィールド:
scalar.dl.auditor.server.port
- 説明: サーバーポート。
- デフォルト値:
40051
server.privileged_port
- フィールド:
scalar.dl.auditor.server.privileged_port
- 説明: サーバー特権ポート。
- デフォルト値:
40052
server.prometheus_exporter_port
- フィールド:
scalar.dl.auditor.server.prometheus_exporter_port
- 説明: Prometheus エクスポーターポート。
- デフォルト値:
8080
server.tls.enabled
- フィールド:
scalar.dl.auditor.server.tls.enabled
- 説明: クライアントとサーバー間の TLS 通信を有効 にするオプション。
- デフォルト値:
false
server.tls.cert_chain_path
- フィールド:
scalar.dl.auditor.server.tls.cert_chain_path
- 説明: TLS 通信に使用される証明書チェーンファイルのパス。
- デフォルト値: 空
server.tls.private_key_path
- フィールド:
scalar.dl.auditor.server.tls.private_key_path
- 説明: TLS 通信に使用される秘密鍵ファイルのパス。
- デフォルト値: 空
servers.authentication.hmac.secret_key
- フィールド:
scalar.dl.auditor.servers.authentication.hmac.secret_key
- 説明: Ledger と Auditor サーバー間のメッセージ認証のための HMAC の秘密鍵。
- デフォルト値: 空 (オプション)
tls.enabled
- フィールド:
scalar.dl.auditor.tls.enabled
- 説明: TLS 通信を有効にするオプション。
- デフォルト値:
false
tls.ca_root_cert_path
- フィールド:
scalar.dl.auditor.tls.ca_root_cert_path
- 説明: TLS 通信のためのカスタム CA ルート証明書のパス。
- デフォルト値: 空
tls.ca_root_cert_pem
- フィールド:
scalar.dl.auditor.tls.ca_root_cert_pem
- 説明: TLS 通信のための PEM エンコードされたカスタム CA ルート証明書。
- デフォルト値: 空
tls.override_authority
- フィールド:
scalar.dl.auditor.tls.override_authority
- 説明: TLS 通信のためのカスタム権限。
- デフォルト値: 空
クライ アントの設定
クライアントでは、Ledger および Auditor サーバーの設定、認証設定、TLS 設定など、いくつかの設定を行うことができます。
auditor.authorization.credential
- フィールド:
scalar.dl.client.auditor.authorization.credential
- 説明: Auditor の認可資格情報。
- デフォルト値: 空 (オプション)
auditor.enabled
- フィールド:
scalar.dl.client.auditor.enabled
- 説明: Auditor を有効にするオプション。
- デフォルト値:
false
auditor.host
- フィールド:
scalar.dl.client.auditor.host
- 説明: Auditor のホスト名または IP アドレス。
- デフォルト値:
localhost
auditor.linearizable_validation.contract_id
- フィールド:
scalar.dl.client.auditor.linearizable_validation.contract_id
- 説明: ValidateLedger コントラクトの ID。
- デフォルト値:
validate-ledger
auditor.port
- フィールド:
scalar.dl.client.auditor.port
- 説明: Auditor のポート番号。
- デフォルト値:
40051
auditor.privileged_port
- フィールド:
scalar.dl.client.auditor.privileged_port
- 説明: 特権サービスのための Auditor のポート番号。
- デフォルト値:
40052
auditor.tls.ca_root_cert_path
- フィールド:
scalar.dl.client.auditor.tls.ca_root_cert_path
- 説明: Auditor の TLS 通信の ためのカスタム CA ルート証明書 (ファイルパス)。
- デフォルト値: 空
auditor.tls.ca_root_cert_pem
- フィールド:
scalar.dl.client.auditor.tls.ca_root_cert_pem
- 説明: Auditor の TLS 通信のためのカスタム CA ルート証明書 (PEM データ)。
- デフォルト値: 空
auditor.tls.enabled
- フィールド:
scalar.dl.client.auditor.tls.enabled
- 説明: Auditor の TLS 通信を有効にするオプション。
- デフォルト値:
false
auditor.tls.override_authority
- フィールド:
scalar.dl.client.auditor.tls.override_authority
- 説明: Auditor の TLS 通信のためのカスタム権限。
- デフォルト値: 空
authentication_method
- フィールド:
scalar.dl.client.authentication_method
- 説明: クライアントとサーバーの認証方法。
- デフォルト値: 空 (オプション)
authorization.credential
- フィールド:
scalar.dl.client.authorization.credential
- 説明: Ledger の認可資格情報。
- デフォルト値: 空 (オプション)
entity.id
- フィールド:
scalar.dl.client.entity.id
- 説明: リクエスターの一意の ID (例: ユーザーまたはデバイス)。
- デフォルト値: 空
entity.identity.hmac.secret_key
- フィールド:
scalar.dl.client.entity.identity.hmac.secret_key
- 説明: HMAC の秘密鍵。
- デフォルト値: 空
entity.identity.hmac.secret_key_version
- フィールド:
scalar.dl.client.entity.identity.hmac.secret_key_version
- 説明: HMAC 鍵のバージョン。
- デフォルト値: 空 (オプション)
grpc.deadline_duration_millis
- フィールド:
scalar.dl.client.grpc.deadline_duration_millis
- 説明: 各リクエストの期限期間。
- デフォルト値: 空 (オプション)
grpc.max_inbound_message_size
- フィールド:
scalar.dl.client.grpc.max_inbound_message_size
- 説明: 単一の gRPC フレームに許可される最大メッセージサイズ。
- デフォルト値: 空 (オプション)
grpc.max_inbound_metadata_size
- フィールド:
scalar.dl.client.grpc.max_inbound_metadata_size
- 説明: 受信が許可されるメタデータの最大サイズ。
- デフォルト値: 空 (オプション)
mode
- フィールド:
scalar.dl.client.mode
- 説明: クライアントモード (CLIENT または INTERMEDIARY)。
- デフォルト値: 空 (オプション)
server.host
- フィールド:
scalar.dl.client.server.host
- 説明: サーバーのホスト名または IP アドレス。
- デフォルト値:
localhost
server.port
- フィールド:
scalar.dl.client.server.port
- 説明: サーバーのポート番号。
- デフォルト値:
50051
server.privileged_port
- フィールド:
scalar.dl.client.server.privileged_port
- 説明: 特権サービスのためのサーバーのポート番号。
- デフォルト値:
50052
tls.ca_root_cert_path
- フィールド:
scalar.dl.client.tls.ca_root_cert_path
- 説明: Ledger の TLS 通信のためのカスタム CA ルート証明書 (ファイルパス)。
- デフォルト値: 空
tls.ca_root_cert_pem
- フィールド:
scalar.dl.client.tls.ca_root_cert_pem
- 説明: Ledger の TLS 通信のためのカスタム CA ルート証明書 (PEM データ)。
- デフォルト値: 空
tls.enabled
- フィールド:
scalar.dl.client.tls.enabled
- 説明: Ledger の TLS 通信を有効にするオプション。
- デフォルト値:
false
tls.override_authority
- フィールド:
scalar.dl.client.tls.override_authority
- 説明: Ledger の TLS 通信のためのカスタム権限。
- デフォルト値: 空