@uniswap/client-data-api 0.0.229 → 0.0.230
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/types_pb.d.ts +44 -1
- package/dist/data/v2/types_pb.js +55 -1
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
|
|
2
2
|
import { Message, proto3, Timestamp } from "@bufbuild/protobuf";
|
|
3
3
|
import { TimestampedValue, TokenType } from "../v1/types_pb.js";
|
|
4
|
-
import { ProtocolVersion } from "../v1/poolTypes_pb.js";
|
|
4
|
+
import { ProtocolVersion, Token as Token$1 } from "../v1/poolTypes_pb.js";
|
|
5
5
|
/**
|
|
6
6
|
* @generated from enum data.v2.TokensOrderBy
|
|
7
7
|
*/
|
|
@@ -1026,6 +1026,36 @@ export declare class PoolsSort extends Message<PoolsSort> {
|
|
|
1026
1026
|
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolsSort;
|
|
1027
1027
|
static equals(a: PoolsSort | PlainMessage<PoolsSort> | undefined, b: PoolsSort | PlainMessage<PoolsSort> | undefined): boolean;
|
|
1028
1028
|
}
|
|
1029
|
+
/**
|
|
1030
|
+
* A pool's boosted APR in one reward token: the sum of that token's live
|
|
1031
|
+
* campaign APRs on the pool, in percent, on top of the pool's fee APR. Ended
|
|
1032
|
+
* campaigns are excluded — they accrue no yield.
|
|
1033
|
+
*
|
|
1034
|
+
* Deliberately carries no campaign detail (windows, allocations, distributed
|
|
1035
|
+
* amounts): only the pool details page renders that, and it reads
|
|
1036
|
+
* GetPoolRewards. Keeping it off this message keeps the per-row payload small
|
|
1037
|
+
* enough to repeat across a page of pools.
|
|
1038
|
+
*
|
|
1039
|
+
* @generated from message data.v2.PoolTokenBoost
|
|
1040
|
+
*/
|
|
1041
|
+
export declare class PoolTokenBoost extends Message<PoolTokenBoost> {
|
|
1042
|
+
/**
|
|
1043
|
+
* @generated from field: pools.v1.Token token = 1;
|
|
1044
|
+
*/
|
|
1045
|
+
token?: Token$1;
|
|
1046
|
+
/**
|
|
1047
|
+
* @generated from field: double apr = 2;
|
|
1048
|
+
*/
|
|
1049
|
+
apr: number;
|
|
1050
|
+
constructor(data?: PartialMessage<PoolTokenBoost>);
|
|
1051
|
+
static readonly runtime: typeof proto3;
|
|
1052
|
+
static readonly typeName = "data.v2.PoolTokenBoost";
|
|
1053
|
+
static readonly fields: FieldList;
|
|
1054
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PoolTokenBoost;
|
|
1055
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PoolTokenBoost;
|
|
1056
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PoolTokenBoost;
|
|
1057
|
+
static equals(a: PoolTokenBoost | PlainMessage<PoolTokenBoost> | undefined, b: PoolTokenBoost | PlainMessage<PoolTokenBoost> | undefined): boolean;
|
|
1058
|
+
}
|
|
1029
1059
|
/**
|
|
1030
1060
|
* Ranking stats for a pool.
|
|
1031
1061
|
* apr = annualised fee revenue / TVL.
|
|
@@ -1065,6 +1095,19 @@ export declare class PoolRankStats extends Message<PoolRankStats> {
|
|
|
1065
1095
|
* @generated from field: optional double volume_1d_tvl_ratio = 7;
|
|
1066
1096
|
*/
|
|
1067
1097
|
volume1dTvlRatio?: number;
|
|
1098
|
+
/**
|
|
1099
|
+
* What reward_apr is paid in, per reward token — so a client can denominate
|
|
1100
|
+
* a boost ("+2.1% in UNI") instead of rendering a bare number under a
|
|
1101
|
+
* guessed symbol. reward_apr stays the cross-token sum and is derived from
|
|
1102
|
+
* these, so reward_apr == sum(token_boosts[].apr) always holds.
|
|
1103
|
+
*
|
|
1104
|
+
* Empty when the pool runs no live campaign, and empty when the incentive
|
|
1105
|
+
* lookup degraded — in which case reward_apr is unset too. Never one
|
|
1106
|
+
* without the other: a boost nobody can denominate is worse than no boost.
|
|
1107
|
+
*
|
|
1108
|
+
* @generated from field: repeated data.v2.PoolTokenBoost token_boosts = 8;
|
|
1109
|
+
*/
|
|
1110
|
+
tokenBoosts: PoolTokenBoost[];
|
|
1068
1111
|
constructor(data?: PartialMessage<PoolRankStats>);
|
|
1069
1112
|
static readonly runtime: typeof proto3;
|
|
1070
1113
|
static readonly typeName = "data.v2.PoolRankStats";
|
package/dist/data/v2/types_pb.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
// @ts-nocheck
|
|
5
5
|
import { Message, proto3, protoInt64, Timestamp } from "@bufbuild/protobuf";
|
|
6
6
|
import { TimestampedValue, TokenType } from "../v1/types_pb.js";
|
|
7
|
-
import { ProtocolVersion } from "../v1/poolTypes_pb.js";
|
|
7
|
+
import { ProtocolVersion, Token as Token$1 } from "../v1/poolTypes_pb.js";
|
|
8
8
|
/**
|
|
9
9
|
* @generated from enum data.v2.TokensOrderBy
|
|
10
10
|
*/
|
|
@@ -1174,6 +1174,46 @@ PoolsSort.fields = proto3.util.newFieldList(() => [
|
|
|
1174
1174
|
{ no: 1, name: "order_by", kind: "enum", T: proto3.getEnumType(PoolsOrderBy), opt: true },
|
|
1175
1175
|
{ no: 2, name: "ascending", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
|
|
1176
1176
|
]);
|
|
1177
|
+
/**
|
|
1178
|
+
* A pool's boosted APR in one reward token: the sum of that token's live
|
|
1179
|
+
* campaign APRs on the pool, in percent, on top of the pool's fee APR. Ended
|
|
1180
|
+
* campaigns are excluded — they accrue no yield.
|
|
1181
|
+
*
|
|
1182
|
+
* Deliberately carries no campaign detail (windows, allocations, distributed
|
|
1183
|
+
* amounts): only the pool details page renders that, and it reads
|
|
1184
|
+
* GetPoolRewards. Keeping it off this message keeps the per-row payload small
|
|
1185
|
+
* enough to repeat across a page of pools.
|
|
1186
|
+
*
|
|
1187
|
+
* @generated from message data.v2.PoolTokenBoost
|
|
1188
|
+
*/
|
|
1189
|
+
export class PoolTokenBoost extends Message {
|
|
1190
|
+
constructor(data) {
|
|
1191
|
+
super();
|
|
1192
|
+
/**
|
|
1193
|
+
* @generated from field: double apr = 2;
|
|
1194
|
+
*/
|
|
1195
|
+
this.apr = 0;
|
|
1196
|
+
proto3.util.initPartial(data, this);
|
|
1197
|
+
}
|
|
1198
|
+
static fromBinary(bytes, options) {
|
|
1199
|
+
return new PoolTokenBoost().fromBinary(bytes, options);
|
|
1200
|
+
}
|
|
1201
|
+
static fromJson(jsonValue, options) {
|
|
1202
|
+
return new PoolTokenBoost().fromJson(jsonValue, options);
|
|
1203
|
+
}
|
|
1204
|
+
static fromJsonString(jsonString, options) {
|
|
1205
|
+
return new PoolTokenBoost().fromJsonString(jsonString, options);
|
|
1206
|
+
}
|
|
1207
|
+
static equals(a, b) {
|
|
1208
|
+
return proto3.util.equals(PoolTokenBoost, a, b);
|
|
1209
|
+
}
|
|
1210
|
+
}
|
|
1211
|
+
PoolTokenBoost.runtime = proto3;
|
|
1212
|
+
PoolTokenBoost.typeName = "data.v2.PoolTokenBoost";
|
|
1213
|
+
PoolTokenBoost.fields = proto3.util.newFieldList(() => [
|
|
1214
|
+
{ no: 1, name: "token", kind: "message", T: Token$1 },
|
|
1215
|
+
{ no: 2, name: "apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
|
|
1216
|
+
]);
|
|
1177
1217
|
/**
|
|
1178
1218
|
* Ranking stats for a pool.
|
|
1179
1219
|
* apr = annualised fee revenue / TVL.
|
|
@@ -1185,6 +1225,19 @@ PoolsSort.fields = proto3.util.newFieldList(() => [
|
|
|
1185
1225
|
export class PoolRankStats extends Message {
|
|
1186
1226
|
constructor(data) {
|
|
1187
1227
|
super();
|
|
1228
|
+
/**
|
|
1229
|
+
* What reward_apr is paid in, per reward token — so a client can denominate
|
|
1230
|
+
* a boost ("+2.1% in UNI") instead of rendering a bare number under a
|
|
1231
|
+
* guessed symbol. reward_apr stays the cross-token sum and is derived from
|
|
1232
|
+
* these, so reward_apr == sum(token_boosts[].apr) always holds.
|
|
1233
|
+
*
|
|
1234
|
+
* Empty when the pool runs no live campaign, and empty when the incentive
|
|
1235
|
+
* lookup degraded — in which case reward_apr is unset too. Never one
|
|
1236
|
+
* without the other: a boost nobody can denominate is worse than no boost.
|
|
1237
|
+
*
|
|
1238
|
+
* @generated from field: repeated data.v2.PoolTokenBoost token_boosts = 8;
|
|
1239
|
+
*/
|
|
1240
|
+
this.tokenBoosts = [];
|
|
1188
1241
|
proto3.util.initPartial(data, this);
|
|
1189
1242
|
}
|
|
1190
1243
|
static fromBinary(bytes, options) {
|
|
@@ -1210,6 +1263,7 @@ PoolRankStats.fields = proto3.util.newFieldList(() => [
|
|
|
1210
1263
|
{ no: 5, name: "reward_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
|
|
1211
1264
|
{ no: 6, name: "total_apr", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
|
|
1212
1265
|
{ no: 7, name: "volume_1d_tvl_ratio", kind: "scalar", T: 1 /* ScalarType.DOUBLE */, opt: true },
|
|
1266
|
+
{ no: 8, name: "token_boosts", kind: "message", T: PoolTokenBoost, repeated: true },
|
|
1213
1267
|
]);
|
|
1214
1268
|
/**
|
|
1215
1269
|
* A pool's protocol identity, token pair, and current on-chain state (state
|