Ripplesのマーケットを読み取る

すべてのルール

• ブロックの範囲は両端を含みます。fromBlock=10&toBlock=15は、ブロック10〜15を対象にします。
• 1回に指定できる範囲は、両端を含めて最大1000ブロックです。それより広いと400 invalid_requestが返り、メッセージに上限が示されます。チャンクサイズはこの上限以下に設定してください。
• Every response is a single named key, with no success or data wrapper and no top-level metadata.
• Every amount is an exact decimal string of up to 50 decimal places, never a JSON number. JSONの数値は倍精度浮動小数点数なので、小数点以下18桁のトークンは、最初の取引で有効桁数を使い切ってしまいます。
• /latest-blockはインデクサー自身のカーソルで、チェーンの最新ブロックではありません。The head is the lowest indexed cursor across every source writing the chain, and /events stops at it, so a block is never served twice and never skipped. このヘッドで止めれば、インデックスの境目に当たることはありません。
• イベントのない範囲には空のリストを返し、エラーにはなりません。
• 上限は60秒あたり600リクエスト（呼び出し元ごと）で、2秒ごとのポーリングの10倍にあたります。引き上げたい場合はRipplesに連絡してください。設定を1つ変えるだけです。

1つのマーケットを順に取得する

呼び出しは4回です。まずヘッド、次に範囲内の取引、最後にマーケットとその2つの資産を取得します。以下のURLはすべて、Robinhoodのフィードの実際のURLです。

# Ask how far the feed has indexed. Never read past this block.
https://api.ripples.run/v1/dex/robinhood/latest-block
# block.blockNumber is the head. Everything below stops there.

# Read a window of trades. Both bounds are inclusive.
https://api.ripples.run/v1/dex/robinhood/events?fromBlock=57699981&toBlock=57700000
# Each event carries pairId, the legs, priceNative and reserves.

# Look up the market an event names. Its record is fixed at creation, so read it once.
https://api.ripples.run/v1/dex/robinhood/pair?id=0x…poolId
# asset0Id is the launch token and asset1Id is what it is priced in.

# Look up each side of the market, for decimals and supply.
https://api.ripples.run/v1/dex/robinhood/asset?id=0x…token
# decimals is always present. Supplies are exact decimal strings.

目標額に達したマーケットも、引き続き/pairで応答します。Robinhoodでは、永久ロックされた流動性のもとで同じプールでの取引が続くため、その取引は引き続き/eventsに届きます。

Ripplesのプールはすべて同じキーを持ちます。fee = 0とtickSpacing = 200で、すべてのローンチで共通です。どちらもフックの定数なので、デプロイによって変わることはなく、ハードコードして問題ありません。プール自体は手数料を取らず、手数料はすべてフックが課します。

PoolManagerのイベント

• Initialize. The pool exists. Its block is the market's creation for every aggregator that dates a pair.
• ModifyLiquidity. The launch's own position. The seed is the only one before graduation.
• Swap. Every trade. The amounts are the pool's, before the hook's cut: read TradeFeeCharged, CreatorTaxCharged and SnipeTaxCharged from the hook in the same transaction and subtract all of them to get what the trader received. TradeFeeCharged is emitted once per payee, so one trade lands two of them whenever the launch pays a creator as well as the treasury.

数値がずれる原因になる点

フックはスワップの中で手数料を取るため、PoolManagerのSwapの金額は、トレーダーが実際に受け取った額より、課された手数料の分だけ大きくなります。手数料はスワップの非指定側の通貨で課されます。exact-inputの購入ではローンチトークン、exact-inputの売却ではマーケットの価格建ての資産、exact-outputのスワップではスワップする人が支払う側の通貨で、指定した額に上乗せして課されます。通貨は方向から推測せず、イベントから読み取ってください。同じトランザクションからTradeFeeCharged、CreatorTaxCharged、そしてオープニングタックス期間中はSnipeTaxChargedを読み取り、そのすべてを差し引きます。どのイベントも料率ではなく金額と通貨を持っているため、読み取る側が料率表を組み立て直す必要はありません。いずれもトークンを外部のアドレスに動かすことはありません。これらはPoolManagerの中に保持され、受け取られるまでそこに残る残高です。

TradeFeeChargedは受取先ごとに1回発行されます。そのため、ローンチがトレジャリーに加えてクリエイターにも支払う場合は、1回の取引で2つ発行され、手数料はその合計です。CreatorTaxChargedは、別の料率による別の課金です。取引手数料はトレジャリーと分け合いますが、クリエイター手数料は分け合いません。クリエイター手数料を設定したローンチでは、トレーダーは両方を支払います。

ローンチフックのイベント

ファクトリーのイベント

トピックだけでなく、発行元のアドレスでも絞り込んでください。2つのファクトリーが並べてデプロイされ、それぞれ別のタイミングで置き換えられます。管理系イベントのうち10件は、シグネチャがバイト単位で同一です。トピックだけで判別すると、一方のファクトリーの管理操作をもう一方のものとして扱ってしまいます。

トークンローンチ用ファクトリーの読み取り

コレクション用ファクトリーの読み取り

ローンチフックの読み取り

LaunchLensコントラクトの読み取り

launchesOfには別のコントラクトが応答します。デプロイされているチェーンでは、上のチェーンごとの一覧にそのアドレスを載せています。このコントラクトは状態も資金も権限も持ちません。返すフィールドはすべて、上の5つのフックのview関数とPoolManagerから読み直したものです。そのため、このコントラクトを信頼したくない場合は、その2つのアドレスから同じ答えを再現できます。記録に載っているチェーンには、どれもこのコントラクトがあります。LaunchLensコントラクトのないチェーンでは一括読み取りはできません。上のファクトリーの呼び出しでローンチを列挙し、各マーケットをフックのview関数から読み取ってください。

取引の発注

Ripplesのマーケットは通常のUniswap v4プールなので、v4に対応したルーターならどれでも取引できます。Ripplesのルーターが必要になるのは、ある規模の注文だけです。ローンチの流動性は、上下限のある1つの価格帯に置かれた1つのポジションで、フックはその範囲の外で終わるスワップをすべて拒否します。そのため、広い価格制限でスワップを出すルーターでは、マーケットの残量を超える購入がそのまま拒否されます。注文は、あった分だけ約定するのではなく、全体がリバートします。

0x22DB9B2c6C6DB56ABC3fc196E4bC1FBb9c4338a6にあるLaunchRouterは、こうした注文を受け付けます。swapExactIn(key, zeroForOne, amountIn, minAmountOut, recipient, deadline)は範囲の端を価格制限としてスワップを出すため、プールはカーブの終わりまで約定して止まり、(spent, amountOut)を返します。呼び出し元からPermit2経由で引き出すのはspentだけなので、マーケットが受けられなかった分の注文額は動きません。minAmountOutは数量ではなく価格です。ルーターはspent * minAmountOut <= amountIn * amountOutを保証します。全額を使う注文ではこれはamountOut >= minAmountOutと同じで、一部しか使わない注文では、使った部分に同じレートが適用されます。

約定の結果はFilled(poolId, sender, recipient, zeroForOne, amountIn, spent, amountOut)から読み取ります。spentがamountInを下回れば部分約定で、マーケットはカーブの終わりに達しています。PoolManagerのSwapは約定した部分だけを報告し、約定しなかった部分には触れないため、差分が必要な場合はここから取得します。CurveEndReachedは売るものが残っていないマーケットでのリバートで、障害ではなく「このローンチは卒業できる状態にある」という答えです。

このページのアドレスは現行世代のものです。以前のトークンローンチ用ファクトリーは、作成したローンチを今も保持しており、それらのマーケットでも取引が続いているため、そのローンチについては今もlaunchCountとlaunchesに応答します。RobinhoodのRipplesのマーケットをすべて扱うインデクサーは、両方のファクトリーを読み取ります。どちらもアドレス一覧に載っています。どちらが作成したマーケットも同じローンチフックと同じプールキーを共有しているため、フックで絞り込めば、どのファクトリーが作ったかを知らなくてもすべてを把握できます。

同じ内容のJSONは/integrate/manifest.jsonにあります。ここのアドレスがチェーンと食い違う場合は、チェーンが正しい情報です。その場合はサポートページからRipplesに知らせてください。