@uniswap/client-data-api 0.0.180 → 0.0.184
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/data/v2/api_pb.d.ts +111 -5
- package/dist/data/v2/api_pb.js +5 -0
- package/package.json +1 -1
package/dist/data/v2/api_pb.d.ts
CHANGED
|
@@ -1175,6 +1175,26 @@ export declare class ListLaunchesRequest extends Message<ListLaunchesRequest> {
|
|
|
1175
1175
|
* @generated from field: optional string query = 8;
|
|
1176
1176
|
*/
|
|
1177
1177
|
query?: string;
|
|
1178
|
+
/**
|
|
1179
|
+
* "My launches": keep only launches created by this wallet — the same
|
|
1180
|
+
* address served as Launch.creator_address (launched_tokens.creator_wallet,
|
|
1181
|
+
* the launch tx's from address). Any case is accepted; the server
|
|
1182
|
+
* EIP-55-checksums it before comparing, and rejects a non-address with
|
|
1183
|
+
* INVALID_ARGUMENT. Empty/absent applies no filter.
|
|
1184
|
+
*
|
|
1185
|
+
* Coverage is the Uniswap launchpads only (uniswap-cca crowd-launch
|
|
1186
|
+
* auctions + uniswap-bonding-curve instant launches). Third-party-launchpad
|
|
1187
|
+
* launches are served from a materialized table with no creator column and
|
|
1188
|
+
* are dropped from a creator-filtered read — they carry no
|
|
1189
|
+
* Launch.creator_address today either, so nothing filterable is lost.
|
|
1190
|
+
*
|
|
1191
|
+
* Not supported with sort_by = TRENDING: that ranking is built from a
|
|
1192
|
+
* candidate scan with no creator column, so the combination is rejected
|
|
1193
|
+
* rather than served unfiltered or silently re-sorted.
|
|
1194
|
+
*
|
|
1195
|
+
* @generated from field: optional string creator_address = 9;
|
|
1196
|
+
*/
|
|
1197
|
+
creatorAddress?: string;
|
|
1178
1198
|
constructor(data?: PartialMessage<ListLaunchesRequest>);
|
|
1179
1199
|
static readonly runtime: typeof proto3;
|
|
1180
1200
|
static readonly typeName = "data.v2.ListLaunchesRequest";
|
|
@@ -1627,9 +1647,49 @@ export declare class CreatorFeeTotals extends Message<CreatorFeeTotals> {
|
|
|
1627
1647
|
* LP position), NOT per-beneficiary — whoever holds the vault NFT at
|
|
1628
1648
|
* claim time receives it.
|
|
1629
1649
|
*
|
|
1650
|
+
* SETTLED-ONLY. Fees reach the beneficiary vault only when somebody calls
|
|
1651
|
+
* the permissionless FeeSplitter.collectFees(tokenIds), so this
|
|
1652
|
+
* UNDERSTATES the creator's earnings by everything the launch's Uniswap
|
|
1653
|
+
* v4 position has accrued since the last collect. Its meaning is
|
|
1654
|
+
* unchanged and will not change — see claimable_including_uncollected for
|
|
1655
|
+
* the figure to show a creator as "your earnings".
|
|
1656
|
+
*
|
|
1630
1657
|
* @generated from field: data.v2.LaunchCreatorFeeAmounts claimable = 3;
|
|
1631
1658
|
*/
|
|
1632
1659
|
claimable?: LaunchCreatorFeeAmounts;
|
|
1660
|
+
/**
|
|
1661
|
+
* `claimable` PLUS the creator's share of the fees still sitting
|
|
1662
|
+
* uncollected in the launch's Uniswap v4 position: what a
|
|
1663
|
+
* collectFees + claim sent right now would actually pay out.
|
|
1664
|
+
*
|
|
1665
|
+
* Computed by simulating FeeSplitter.collectFees(tokenIds) against the
|
|
1666
|
+
* chain head (eth_simulateV1) and reading the beneficiary vault's
|
|
1667
|
+
* amounts(tokenId) inside that same simulated state — no transaction is
|
|
1668
|
+
* sent and no state is written. Aggregated across every LP position of
|
|
1669
|
+
* the launch, exactly like `claimable`.
|
|
1670
|
+
*
|
|
1671
|
+
* Always populated: when the simulation cannot run (RPC error, or a
|
|
1672
|
+
* collect that reverts) this degrades to the vault's settled on-chain
|
|
1673
|
+
* balance, and finally to `claimable` itself, so a creator sees a
|
|
1674
|
+
* slightly stale number rather than an error.
|
|
1675
|
+
*
|
|
1676
|
+
* Read claimable_includes_uncollected before deciding how to treat this.
|
|
1677
|
+
*
|
|
1678
|
+
* WHEN IT IS TRUE this is the post-collect figure: normally >=
|
|
1679
|
+
* `claimable`, but it comes from chain state rather than indexed events,
|
|
1680
|
+
* so it can also come in LOWER when the indexer is behind a claim that
|
|
1681
|
+
* already landed. It is the authoritative figure in that case — do not
|
|
1682
|
+
* max() the two.
|
|
1683
|
+
*
|
|
1684
|
+
* WHEN IT IS FALSE the collect could not be simulated and this degraded
|
|
1685
|
+
* to a settled balance (or to `claimable` itself). It then carries no
|
|
1686
|
+
* uncollected remainder and can only UNDERSTATE the creator's earnings,
|
|
1687
|
+
* so max() with `claimable` is the right defence and the number must not
|
|
1688
|
+
* be labelled "your earnings".
|
|
1689
|
+
*
|
|
1690
|
+
* @generated from field: data.v2.LaunchCreatorFeeAmounts claimable_including_uncollected = 4;
|
|
1691
|
+
*/
|
|
1692
|
+
claimableIncludingUncollected?: LaunchCreatorFeeAmounts;
|
|
1633
1693
|
constructor(data?: PartialMessage<CreatorFeeTotals>);
|
|
1634
1694
|
static readonly runtime: typeof proto3;
|
|
1635
1695
|
static readonly typeName = "data.v2.CreatorFeeTotals";
|
|
@@ -1688,11 +1748,13 @@ export declare class GetLaunchCreatorFeesResponse extends Message<GetLaunchCreat
|
|
|
1688
1748
|
*/
|
|
1689
1749
|
positionTokenId?: string;
|
|
1690
1750
|
/**
|
|
1691
|
-
* Current beneficiary: the
|
|
1692
|
-
* position_token_id position, who may claim
|
|
1693
|
-
* by transferring the NFT.
|
|
1694
|
-
*
|
|
1695
|
-
*
|
|
1751
|
+
* Current beneficiary: the CREATOR'S WALLET (EIP-55) — the holder of the
|
|
1752
|
+
* beneficiary ERC721 for the position_token_id position, who may claim
|
|
1753
|
+
* and re-point the fee stream by transferring the NFT. This is NOT the
|
|
1754
|
+
* vault contract; that is beneficiary_vault. Unset when creator fees are
|
|
1755
|
+
* off, while vault ingestion lags (for a CCA launch: until the creator's
|
|
1756
|
+
* graffiti claim mints the vault NFT), or transiently mid re-registration
|
|
1757
|
+
* (NFT burned).
|
|
1696
1758
|
*
|
|
1697
1759
|
* @generated from field: optional string fee_beneficiary = 5;
|
|
1698
1760
|
*/
|
|
@@ -1708,6 +1770,50 @@ export declare class GetLaunchCreatorFeesResponse extends Message<GetLaunchCreat
|
|
|
1708
1770
|
* @generated from field: int64 as_of_timestamp = 6;
|
|
1709
1771
|
*/
|
|
1710
1772
|
asOfTimestamp: bigint;
|
|
1773
|
+
/**
|
|
1774
|
+
* The launch's own FeeSplitter (EIP-55) — the contract to send the
|
|
1775
|
+
* permissionless collectFees([position_token_id]) to, which sweeps the v4
|
|
1776
|
+
* position's fees into the beneficiary vault and is what makes
|
|
1777
|
+
* creator.claimable_including_uncollected actually claimable.
|
|
1778
|
+
*
|
|
1779
|
+
* PER LAUNCH, NOT A CHAIN CONSTANT: several FeeSplitter generations are
|
|
1780
|
+
* deployed and live on the same chain (Robinhood Chain runs two), and a
|
|
1781
|
+
* launch's fees only ever flow through the one its strategy was wired to.
|
|
1782
|
+
* Clients MUST call the address in this field — a hardcoded per-chain
|
|
1783
|
+
* splitter silently targets the wrong generation. Unset when the launch
|
|
1784
|
+
* has neither an indexed launch row nor a fee event yet.
|
|
1785
|
+
*
|
|
1786
|
+
* @generated from field: optional string fee_splitter = 7;
|
|
1787
|
+
*/
|
|
1788
|
+
feeSplitter?: string;
|
|
1789
|
+
/**
|
|
1790
|
+
* The launch's own UERC20BeneficiaryVault (EIP-55) — the contract that
|
|
1791
|
+
* custodies the creator's share and that claim(position_token_id, 0, 0)
|
|
1792
|
+
* is sent to. Per launch for the same reason fee_splitter is. Unset until
|
|
1793
|
+
* the position's beneficiary NFT has been ingested.
|
|
1794
|
+
*
|
|
1795
|
+
* @generated from field: optional string beneficiary_vault = 8;
|
|
1796
|
+
*/
|
|
1797
|
+
beneficiaryVault?: string;
|
|
1798
|
+
/**
|
|
1799
|
+
* False when the collect could not be simulated and
|
|
1800
|
+
* creator.claimable_including_uncollected is a settled balance (or the
|
|
1801
|
+
* event-derived claimable) rather than the post-collect figure. Clients
|
|
1802
|
+
* should not present it as "your earnings" when false.
|
|
1803
|
+
*
|
|
1804
|
+
* as_of_timestamp does NOT cover for this: that marker is computed from
|
|
1805
|
+
* indexed events only, so it reads perfectly fresh during an RPC outage
|
|
1806
|
+
* while the amount beside it has silently gone stale. This is the only
|
|
1807
|
+
* signal that distinguishes the two.
|
|
1808
|
+
*
|
|
1809
|
+
* `optional` is load-bearing. A bare proto3 bool reads as false when
|
|
1810
|
+
* absent, so a client built against <= 0.0.180 would see "degraded" on
|
|
1811
|
+
* every response; the presence bit separates "this server does not send
|
|
1812
|
+
* it" from "this response is degraded".
|
|
1813
|
+
*
|
|
1814
|
+
* @generated from field: optional bool claimable_includes_uncollected = 9;
|
|
1815
|
+
*/
|
|
1816
|
+
claimableIncludesUncollected?: boolean;
|
|
1711
1817
|
constructor(data?: PartialMessage<GetLaunchCreatorFeesResponse>);
|
|
1712
1818
|
static readonly runtime: typeof proto3;
|
|
1713
1819
|
static readonly typeName = "data.v2.GetLaunchCreatorFeesResponse";
|
package/dist/data/v2/api_pb.js
CHANGED
|
@@ -1479,6 +1479,7 @@ ListLaunchesRequest.fields = proto3.util.newFieldList(() => [
|
|
|
1479
1479
|
{ no: 6, name: "filter", kind: "message", T: LaunchListFilter, opt: true },
|
|
1480
1480
|
{ no: 7, name: "ascending", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
|
|
1481
1481
|
{ no: 8, name: "query", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
|
|
1482
|
+
{ no: 9, name: "creator_address", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
|
|
1482
1483
|
]);
|
|
1483
1484
|
/**
|
|
1484
1485
|
* @generated from message data.v2.ListLaunchesResponse
|
|
@@ -2045,6 +2046,7 @@ CreatorFeeTotals.fields = proto3.util.newFieldList(() => [
|
|
|
2045
2046
|
{ no: 1, name: "accumulated", kind: "message", T: LaunchCreatorFeeAmounts },
|
|
2046
2047
|
{ no: 2, name: "claimed", kind: "message", T: LaunchCreatorFeeAmounts },
|
|
2047
2048
|
{ no: 3, name: "claimable", kind: "message", T: LaunchCreatorFeeAmounts },
|
|
2049
|
+
{ no: 4, name: "claimable_including_uncollected", kind: "message", T: LaunchCreatorFeeAmounts },
|
|
2048
2050
|
]);
|
|
2049
2051
|
/**
|
|
2050
2052
|
* @generated from message data.v2.GetLaunchCreatorFeesResponse
|
|
@@ -2096,6 +2098,9 @@ GetLaunchCreatorFeesResponse.fields = proto3.util.newFieldList(() => [
|
|
|
2096
2098
|
{ no: 4, name: "position_token_id", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
|
|
2097
2099
|
{ no: 5, name: "fee_beneficiary", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
|
|
2098
2100
|
{ no: 6, name: "as_of_timestamp", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
|
|
2101
|
+
{ no: 7, name: "fee_splitter", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
|
|
2102
|
+
{ no: 8, name: "beneficiary_vault", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
|
|
2103
|
+
{ no: 9, name: "claimable_includes_uncollected", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
|
|
2099
2104
|
]);
|
|
2100
2105
|
/**
|
|
2101
2106
|
* Server-computed Top Traders leaderboard for a launch token: the token's
|