6-3. アメンドメントを定義して機能を追加する
This content is not available in your language yet.
XRPL は世界中の独立したノードが同じルールで動くことで成り立っています。新しい機能を勝手に有効化すると、古いノードと新しいノードでトランザクション結果が食い違う可能性があります。これを防ぐのが アメンドメント です。
なぜ新機能はアメンドメントで守るのか
Section titled “なぜ新機能はアメンドメントで守るのか”挙動を変える変更をアメンドメントなしで入れると、新しいコードのノードと古いコードのノードで結果が食い違い、コンセンサスが取れなくなる可能性があります。アメンドメントで囲むことで、次の状態を作れます。
- 過半数のバリデータが賛成するまで機能は無効のまま
- 有効化条件を満たした後、全ノードが同じルールで新しい挙動へ進む
ステップ1: features.macroに定義する
Section titled “ステップ1: features.macroに定義する”アメンドメントは features.macro に定義します。
include/xrpl/protocol/detail/features.macroinclude/xrpl/protocol/Feature.h定義は XRPL_FEATURE または XRPL_FIX マクロで行われます。
XRPL_FEATURE(MyNewFeature, Supported::Yes, VoteBehavior::DefaultNo)| 引数 | 設定の目安 |
|---|---|
Supported::Yes | このビルドが機能を実装済みなら Yes |
VoteBehavior::DefaultNo | 新機能は慎重に既定で反対票から始める |
この定義から、featureMyNewFeature のような定数が生成されます。
ステップ2: コードにガードを置く
Section titled “ステップ2: コードにガードを置く”機能を変更するコードでは、rules().enabled(...) でアメンドメントの有効/無効を見ます。
if (ctx_.view().rules().enabled(featureMyNewFeature)){ // アメンドメントが有効なときだけ通る新しい挙動}新しいトランザクションタイプ全体をアメンドメントで無効化する場合は、checkExtraFeatures() を定義します。Transactor の共通処理がこれを呼び、機能が無効なら temDISABLED として扱います。
static boolMyTransactor::checkExtraFeatures(PreflightContext const& ctx){ return ctx.rules.enabled(featureMyNewFeature);}実例として LoanBrokerSet では、Lending Protocol 関連の依存アメンドメントを checkExtraFeatures() でまとめて確認しています。ここでは Lending の仕様を追うより、「機能が有効なときだけ受け付ける判定を共通ヘルパーへ寄せている」点に注目してください。
boolLoanBrokerSet::checkExtraFeatures(PreflightContext const& ctx){ return checkLendingProtocolDependencies(ctx.rules, ctx.tx);}既存トランザクションの一部挙動だけを変える場合は、doApply() など実際に分岐が必要な場所で ctx_.view().rules().enabled(...) を見ます。どの段階で拒否または分岐するかは、トランザクションの意味と既存挙動への影響で決めます。
ステップ3: 有効・無効の両方でテストする
Section titled “ステップ3: 有効・無効の両方でテストする”アメンドメント付きの変更では、有効なケースだけでなく、無効なケースもテストします。
voidrun() override{ using namespace test::jtx; FeatureBitset const all{testableAmendments()};
testWithFeats(all); testWithFeats(all - featureMyNewFeature);}| パターン | 確認したいこと |
|---|---|
all | 新機能が有効なときに正しく動く |
all - featureMyNewFeature | 機能無効時に従来の挙動を保つ、または temDISABLED で拒否する |
ステップ4: Invariant Checkを検討する
Section titled “ステップ4: Invariant Checkを検討する”新機能がLedgerの状態を新しく作る、残高に影響する、所有関係を持つオブジェクトを追加する、といった場合は Invariant Check を検討します。
include/xrpl/tx/invariants/InvariantCheck.hsrc/libxrpl/tx/invariants/src/libxrpl/tx/Transactor.cppInvariant Checkは、個々のTransactorにバグがあってもLedgerが壊れた状態で確定しないようにする最後の検査です。
flowchart TD xlsProposal["XLS提案と議論"] --> featureMacro["features.macroに定義"] featureMacro --> guardCode["checkExtraFeatures / rules().enabled でガード"] guardCode --> tests["有効/無効の両方をテスト"] tests --> invariants["必要ならInvariant Check"] invariants --> review["PRで設計理由を説明"]
次のステップ
Section titled “次のステップ”次は Invariant Checksの仕組み に進み、トランザクション適用後にLedgerの整合性をどう守るかを見ます。