@zoguxprotocol/proto 0.1.9 → 0.1.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoguxprotocol/proto",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "access": "public",
   "description": "Protos for Zogux protocol",
   "author": "Zogux Trading Inc.",

package/src/codegen/zogux/clob/order.ts

@@ -297,6 +297,15 @@ export interface OrderFillState {
    */
 
   prunableBlockHeight: number;
+  /**
+   * Base-10 string of the sum of gross quote quantums released from spot locked
+   * balance via spot BUY matches (same basis as FillAmountToQuoteQuantums per
+   * fill). Empty means tracking was never started for this order (e.g. partial
+   * fills before this field existed); residual dust unlock must not use L-S for
+   * such orders.
+   */
+
+  spotBuyQuoteMatchedTotal: string;
 }
 /**
  * OrderFillState represents the fill amount of an order according to on-chain
@@ -308,6 +317,7 @@ export interface OrderFillState {
 export interface OrderFillStateSDKType {
   fill_amount: Long;
   prunable_block_height: number;
+  spot_buy_quote_matched_total: string;
 }
 /**
  * StatefulOrderTimeSliceValue represents the type of the value of the
@@ -820,7 +830,8 @@ export const PotentiallyPrunableOrders = {
 function createBaseOrderFillState(): OrderFillState {
   return {
     fillAmount: Long.UZERO,
-    prunableBlockHeight: 0
+    prunableBlockHeight: 0,
+    spotBuyQuoteMatchedTotal: ""
   };
 }
 
@@ -834,6 +845,10 @@ export const OrderFillState = {
       writer.uint32(16).uint32(message.prunableBlockHeight);
     }
 
+    if (message.spotBuyQuoteMatchedTotal !== "") {
+      writer.uint32(26).string(message.spotBuyQuoteMatchedTotal);
+    }
+
     return writer;
   },
 
@@ -854,6 +869,10 @@ export const OrderFillState = {
           message.prunableBlockHeight = reader.uint32();
           break;
 
+        case 3:
+          message.spotBuyQuoteMatchedTotal = reader.string();
+          break;
+
         default:
           reader.skipType(tag & 7);
           break;
@@ -867,6 +886,7 @@ export const OrderFillState = {
     const message = createBaseOrderFillState();
     message.fillAmount = object.fillAmount !== undefined && object.fillAmount !== null ? Long.fromValue(object.fillAmount) : Long.UZERO;
     message.prunableBlockHeight = object.prunableBlockHeight ?? 0;
+    message.spotBuyQuoteMatchedTotal = object.spotBuyQuoteMatchedTotal ?? "";
     return message;
   }
 

package/src/codegen/zogux/feetiers/params.ts

@@ -11,6 +11,17 @@ export interface PerpetualFeeParams {
 export interface PerpetualFeeParamsSDKType {
   tiers: PerpetualFeeTierSDKType[];
 }
+/** SpotFeeParams defines the parameters for spot fees. */
+
+export interface SpotFeeParams {
+  /** Sorted fee tiers (lowest requirements first). */
+  tiers: SpotFeeTier[];
+}
+/** SpotFeeParams defines the parameters for spot fees. */
+
+export interface SpotFeeParamsSDKType {
+  tiers: SpotFeeTierSDKType[];
+}
 /** A fee tier for perpetuals */
 
 export interface PerpetualFeeTier {
@@ -42,6 +53,37 @@ export interface PerpetualFeeTierSDKType {
   maker_fee_ppm: number;
   taker_fee_ppm: number;
 }
+/** A fee tier for spot trading. */
+
+export interface SpotFeeTier {
+  /** Human-readable name of the tier, e.g. "Gold". */
+  name: string;
+  /** The trader's absolute volume requirement in quote quantums. */
+
+  absoluteVolumeRequirement: Long;
+  /** The total volume share requirement. */
+
+  totalVolumeShareRequirementPpm: number;
+  /** The maker volume share requirement. */
+
+  makerVolumeShareRequirementPpm: number;
+  /** The maker fee once this tier is reached. */
+
+  makerFeePpm: number;
+  /** The taker fee once this tier is reached. */
+
+  takerFeePpm: number;
+}
+/** A fee tier for spot trading. */
+
+export interface SpotFeeTierSDKType {
+  name: string;
+  absolute_volume_requirement: Long;
+  total_volume_share_requirement_ppm: number;
+  maker_volume_share_requirement_ppm: number;
+  maker_fee_ppm: number;
+  taker_fee_ppm: number;
+}
 
 function createBasePerpetualFeeParams(): PerpetualFeeParams {
   return {
@@ -88,6 +130,51 @@ export const PerpetualFeeParams = {
 
 };
 
+function createBaseSpotFeeParams(): SpotFeeParams {
+  return {
+    tiers: []
+  };
+}
+
+export const SpotFeeParams = {
+  encode(message: SpotFeeParams, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    for (const v of message.tiers) {
+      SpotFeeTier.encode(v!, writer.uint32(10).fork()).ldelim();
+    }
+
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): SpotFeeParams {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseSpotFeeParams();
+
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+
+      switch (tag >>> 3) {
+        case 1:
+          message.tiers.push(SpotFeeTier.decode(reader, reader.uint32()));
+          break;
+
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+
+    return message;
+  },
+
+  fromPartial(object: DeepPartial<SpotFeeParams>): SpotFeeParams {
+    const message = createBaseSpotFeeParams();
+    message.tiers = object.tiers?.map(e => SpotFeeTier.fromPartial(e)) || [];
+    return message;
+  }
+
+};
+
 function createBasePerpetualFeeTier(): PerpetualFeeTier {
   return {
     name: "",
@@ -181,4 +268,99 @@ export const PerpetualFeeTier = {
     return message;
   }
 
+};
+
+function createBaseSpotFeeTier(): SpotFeeTier {
+  return {
+    name: "",
+    absoluteVolumeRequirement: Long.UZERO,
+    totalVolumeShareRequirementPpm: 0,
+    makerVolumeShareRequirementPpm: 0,
+    makerFeePpm: 0,
+    takerFeePpm: 0
+  };
+}
+
+export const SpotFeeTier = {
+  encode(message: SpotFeeTier, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.name !== "") {
+      writer.uint32(10).string(message.name);
+    }
+
+    if (!message.absoluteVolumeRequirement.isZero()) {
+      writer.uint32(16).uint64(message.absoluteVolumeRequirement);
+    }
+
+    if (message.totalVolumeShareRequirementPpm !== 0) {
+      writer.uint32(24).uint32(message.totalVolumeShareRequirementPpm);
+    }
+
+    if (message.makerVolumeShareRequirementPpm !== 0) {
+      writer.uint32(32).uint32(message.makerVolumeShareRequirementPpm);
+    }
+
+    if (message.makerFeePpm !== 0) {
+      writer.uint32(40).sint32(message.makerFeePpm);
+    }
+
+    if (message.takerFeePpm !== 0) {
+      writer.uint32(48).sint32(message.takerFeePpm);
+    }
+
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): SpotFeeTier {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseSpotFeeTier();
+
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+
+      switch (tag >>> 3) {
+        case 1:
+          message.name = reader.string();
+          break;
+
+        case 2:
+          message.absoluteVolumeRequirement = (reader.uint64() as Long);
+          break;
+
+        case 3:
+          message.totalVolumeShareRequirementPpm = reader.uint32();
+          break;
+
+        case 4:
+          message.makerVolumeShareRequirementPpm = reader.uint32();
+          break;
+
+        case 5:
+          message.makerFeePpm = reader.sint32();
+          break;
+
+        case 6:
+          message.takerFeePpm = reader.sint32();
+          break;
+
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+
+    return message;
+  },
+
+  fromPartial(object: DeepPartial<SpotFeeTier>): SpotFeeTier {
+    const message = createBaseSpotFeeTier();
+    message.name = object.name ?? "";
+    message.absoluteVolumeRequirement = object.absoluteVolumeRequirement !== undefined && object.absoluteVolumeRequirement !== null ? Long.fromValue(object.absoluteVolumeRequirement) : Long.UZERO;
+    message.totalVolumeShareRequirementPpm = object.totalVolumeShareRequirementPpm ?? 0;
+    message.makerVolumeShareRequirementPpm = object.makerVolumeShareRequirementPpm ?? 0;
+    message.makerFeePpm = object.makerFeePpm ?? 0;
+    message.takerFeePpm = object.takerFeePpm ?? 0;
+    return message;
+  }
+
 };

package/src/codegen/zogux/feetiers/query.lcd.ts

@@ -1,5 +1,5 @@
 import { LCDClient } from "@osmonauts/lcd";
-import { QueryPerpetualFeeParamsRequest, QueryPerpetualFeeParamsResponseSDKType, QueryUserFeeTierRequest, QueryUserFeeTierResponseSDKType, QueryPerMarketFeeDiscountParamsRequest, QueryPerMarketFeeDiscountParamsResponseSDKType, QueryAllMarketFeeDiscountParamsRequest, QueryAllMarketFeeDiscountParamsResponseSDKType, QueryStakingTiersRequest, QueryStakingTiersResponseSDKType, QueryUserStakingTierRequest, QueryUserStakingTierResponseSDKType } from "./query";
+import { QueryPerpetualFeeParamsRequest, QueryPerpetualFeeParamsResponseSDKType, QueryUserFeeTierRequest, QueryUserFeeTierResponseSDKType, QueryUserSpotFeeTierRequest, QueryUserSpotFeeTierResponseSDKType, QueryPerMarketFeeDiscountParamsRequest, QueryPerMarketFeeDiscountParamsResponseSDKType, QueryAllMarketFeeDiscountParamsRequest, QueryAllMarketFeeDiscountParamsResponseSDKType, QueryStakingTiersRequest, QueryStakingTiersResponseSDKType, QueryUserStakingTierRequest, QueryUserStakingTierResponseSDKType } from "./query";
 export class LCDQueryClient {
   req: LCDClient;
 
@@ -11,6 +11,7 @@ export class LCDQueryClient {
     this.req = requestClient;
     this.perpetualFeeParams = this.perpetualFeeParams.bind(this);
     this.userFeeTier = this.userFeeTier.bind(this);
+    this.userSpotFeeTier = this.userSpotFeeTier.bind(this);
     this.perMarketFeeDiscountParams = this.perMarketFeeDiscountParams.bind(this);
     this.allMarketFeeDiscountParams = this.allMarketFeeDiscountParams.bind(this);
     this.stakingTiers = this.stakingTiers.bind(this);
@@ -38,6 +39,21 @@ export class LCDQueryClient {
     const endpoint = `zogux/v4/feetiers/user_fee_tier`;
     return await this.req.get<QueryUserFeeTierResponseSDKType>(endpoint, options);
   }
+  /* Queries a user's spot fee tier */
+
+
+  async userSpotFeeTier(params: QueryUserSpotFeeTierRequest): Promise<QueryUserSpotFeeTierResponseSDKType> {
+    const options: any = {
+      params: {}
+    };
+
+    if (typeof params?.user !== "undefined") {
+      options.params.user = params.user;
+    }
+
+    const endpoint = `zogux/v4/feetiers/user_spot_fee_tier`;
+    return await this.req.get<QueryUserSpotFeeTierResponseSDKType>(endpoint, options);
+  }
   /* PerMarketFeeDiscountParams queries fee discount parameters for a
    specific market/CLOB pair. */
 

package/src/codegen/zogux/feetiers/query.rpc.Query.ts

@@ -1,7 +1,7 @@
 import { Rpc } from "../../helpers";
 import * as _m0 from "protobufjs/minimal";
 import { QueryClient, createProtobufRpcClient } from "@cosmjs/stargate";
-import { QueryPerpetualFeeParamsRequest, QueryPerpetualFeeParamsResponse, QueryUserFeeTierRequest, QueryUserFeeTierResponse, QueryPerMarketFeeDiscountParamsRequest, QueryPerMarketFeeDiscountParamsResponse, QueryAllMarketFeeDiscountParamsRequest, QueryAllMarketFeeDiscountParamsResponse, QueryStakingTiersRequest, QueryStakingTiersResponse, QueryUserStakingTierRequest, QueryUserStakingTierResponse } from "./query";
+import { QueryPerpetualFeeParamsRequest, QueryPerpetualFeeParamsResponse, QueryUserFeeTierRequest, QueryUserFeeTierResponse, QueryUserSpotFeeTierRequest, QueryUserSpotFeeTierResponse, QueryPerMarketFeeDiscountParamsRequest, QueryPerMarketFeeDiscountParamsResponse, QueryAllMarketFeeDiscountParamsRequest, QueryAllMarketFeeDiscountParamsResponse, QueryStakingTiersRequest, QueryStakingTiersResponse, QueryUserStakingTierRequest, QueryUserStakingTierResponse } from "./query";
 /** Query defines the gRPC querier service. */
 
 export interface Query {
@@ -10,6 +10,9 @@ export interface Query {
   /** Queries a user's fee tier */
 
   userFeeTier(request: QueryUserFeeTierRequest): Promise<QueryUserFeeTierResponse>;
+  /** Queries a user's spot fee tier */
+
+  userSpotFeeTier(request: QueryUserSpotFeeTierRequest): Promise<QueryUserSpotFeeTierResponse>;
   /**
    * PerMarketFeeDiscountParams queries fee discount parameters for a
    * specific market/CLOB pair.
@@ -33,6 +36,7 @@ export class QueryClientImpl implements Query {
     this.rpc = rpc;
     this.perpetualFeeParams = this.perpetualFeeParams.bind(this);
     this.userFeeTier = this.userFeeTier.bind(this);
+    this.userSpotFeeTier = this.userSpotFeeTier.bind(this);
     this.perMarketFeeDiscountParams = this.perMarketFeeDiscountParams.bind(this);
     this.allMarketFeeDiscountParams = this.allMarketFeeDiscountParams.bind(this);
     this.stakingTiers = this.stakingTiers.bind(this);
@@ -51,6 +55,12 @@ export class QueryClientImpl implements Query {
     return promise.then(data => QueryUserFeeTierResponse.decode(new _m0.Reader(data)));
   }
 
+  userSpotFeeTier(request: QueryUserSpotFeeTierRequest): Promise<QueryUserSpotFeeTierResponse> {
+    const data = QueryUserSpotFeeTierRequest.encode(request).finish();
+    const promise = this.rpc.request("zogux.feetiers.Query", "UserSpotFeeTier", data);
+    return promise.then(data => QueryUserSpotFeeTierResponse.decode(new _m0.Reader(data)));
+  }
+
   perMarketFeeDiscountParams(request: QueryPerMarketFeeDiscountParamsRequest): Promise<QueryPerMarketFeeDiscountParamsResponse> {
     const data = QueryPerMarketFeeDiscountParamsRequest.encode(request).finish();
     const promise = this.rpc.request("zogux.feetiers.Query", "PerMarketFeeDiscountParams", data);
@@ -88,6 +98,10 @@ export const createRpcQueryExtension = (base: QueryClient) => {
       return queryService.userFeeTier(request);
     },
 
+    userSpotFeeTier(request: QueryUserSpotFeeTierRequest): Promise<QueryUserSpotFeeTierResponse> {
+      return queryService.userSpotFeeTier(request);
+    },
+
     perMarketFeeDiscountParams(request: QueryPerMarketFeeDiscountParamsRequest): Promise<QueryPerMarketFeeDiscountParamsResponse> {
       return queryService.perMarketFeeDiscountParams(request);
     },

package/src/codegen/zogux/feetiers/query.ts

@@ -1,4 +1,4 @@
-import { PerpetualFeeParams, PerpetualFeeParamsSDKType, PerpetualFeeTier, PerpetualFeeTierSDKType } from "./params";
+import { PerpetualFeeParams, PerpetualFeeParamsSDKType, PerpetualFeeTier, PerpetualFeeTierSDKType, SpotFeeTier, SpotFeeTierSDKType } from "./params";
 import { PerMarketFeeDiscountParams, PerMarketFeeDiscountParamsSDKType } from "./per_market_fee_discount";
 import { StakingTier, StakingTierSDKType } from "./staking_tier";
 import * as _m0 from "protobufjs/minimal";
@@ -47,12 +47,49 @@ export interface QueryUserFeeTierResponse {
   /** Index of the fee tier in the list queried from PerpetualFeeParams. */
   index: number;
   tier?: PerpetualFeeTier;
+  /**
+   * Source volume bucket used for this fee tier calculation.
+   * feetiers uses perpetual-only notional.
+   */
+
+  volumeSource: string;
 }
 /** QueryUserFeeTierResponse is a request type for the UserFeeTier RPC method. */
 
 export interface QueryUserFeeTierResponseSDKType {
   index: number;
   tier?: PerpetualFeeTierSDKType;
+  volume_source: string;
+}
+/** QueryUserSpotFeeTierRequest is a request type for the UserSpotFeeTier RPC method. */
+
+export interface QueryUserSpotFeeTierRequest {
+  user: string;
+}
+/** QueryUserSpotFeeTierRequest is a request type for the UserSpotFeeTier RPC method. */
+
+export interface QueryUserSpotFeeTierRequestSDKType {
+  user: string;
+}
+/** QueryUserSpotFeeTierResponse is a response type for the UserSpotFeeTier RPC method. */
+
+export interface QueryUserSpotFeeTierResponse {
+  /** Index of the fee tier in the list queried from SpotFeeParams. */
+  index: number;
+  tier?: SpotFeeTier;
+  /**
+   * Source volume bucket used for this fee tier calculation.
+   * feetiers uses spot-only notional.
+   */
+
+  volumeSource: string;
+}
+/** QueryUserSpotFeeTierResponse is a response type for the UserSpotFeeTier RPC method. */
+
+export interface QueryUserSpotFeeTierResponseSDKType {
+  index: number;
+  tier?: SpotFeeTierSDKType;
+  volume_source: string;
 }
 /**
  * QueryPerMarketFeeDiscountParamsRequest is the request type for the
@@ -304,7 +341,8 @@ export const QueryUserFeeTierRequest = {
 function createBaseQueryUserFeeTierResponse(): QueryUserFeeTierResponse {
   return {
     index: 0,
-    tier: undefined
+    tier: undefined,
+    volumeSource: ""
   };
 }
 
@@ -318,6 +356,10 @@ export const QueryUserFeeTierResponse = {
       PerpetualFeeTier.encode(message.tier, writer.uint32(18).fork()).ldelim();
     }
 
+    if (message.volumeSource !== "") {
+      writer.uint32(26).string(message.volumeSource);
+    }
+
     return writer;
   },
 
@@ -338,6 +380,10 @@ export const QueryUserFeeTierResponse = {
           message.tier = PerpetualFeeTier.decode(reader, reader.uint32());
           break;
 
+        case 3:
+          message.volumeSource = reader.string();
+          break;
+
         default:
           reader.skipType(tag & 7);
           break;
@@ -351,6 +397,117 @@ export const QueryUserFeeTierResponse = {
     const message = createBaseQueryUserFeeTierResponse();
     message.index = object.index ?? 0;
     message.tier = object.tier !== undefined && object.tier !== null ? PerpetualFeeTier.fromPartial(object.tier) : undefined;
+    message.volumeSource = object.volumeSource ?? "";
+    return message;
+  }
+
+};
+
+function createBaseQueryUserSpotFeeTierRequest(): QueryUserSpotFeeTierRequest {
+  return {
+    user: ""
+  };
+}
+
+export const QueryUserSpotFeeTierRequest = {
+  encode(message: QueryUserSpotFeeTierRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.user !== "") {
+      writer.uint32(10).string(message.user);
+    }
+
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): QueryUserSpotFeeTierRequest {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseQueryUserSpotFeeTierRequest();
+
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+
+      switch (tag >>> 3) {
+        case 1:
+          message.user = reader.string();
+          break;
+
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+
+    return message;
+  },
+
+  fromPartial(object: DeepPartial<QueryUserSpotFeeTierRequest>): QueryUserSpotFeeTierRequest {
+    const message = createBaseQueryUserSpotFeeTierRequest();
+    message.user = object.user ?? "";
+    return message;
+  }
+
+};
+
+function createBaseQueryUserSpotFeeTierResponse(): QueryUserSpotFeeTierResponse {
+  return {
+    index: 0,
+    tier: undefined,
+    volumeSource: ""
+  };
+}
+
+export const QueryUserSpotFeeTierResponse = {
+  encode(message: QueryUserSpotFeeTierResponse, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.index !== 0) {
+      writer.uint32(8).uint32(message.index);
+    }
+
+    if (message.tier !== undefined) {
+      SpotFeeTier.encode(message.tier, writer.uint32(18).fork()).ldelim();
+    }
+
+    if (message.volumeSource !== "") {
+      writer.uint32(26).string(message.volumeSource);
+    }
+
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): QueryUserSpotFeeTierResponse {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseQueryUserSpotFeeTierResponse();
+
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+
+      switch (tag >>> 3) {
+        case 1:
+          message.index = reader.uint32();
+          break;
+
+        case 2:
+          message.tier = SpotFeeTier.decode(reader, reader.uint32());
+          break;
+
+        case 3:
+          message.volumeSource = reader.string();
+          break;
+
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+
+    return message;
+  },
+
+  fromPartial(object: DeepPartial<QueryUserSpotFeeTierResponse>): QueryUserSpotFeeTierResponse {
+    const message = createBaseQueryUserSpotFeeTierResponse();
+    message.index = object.index ?? 0;
+    message.tier = object.tier !== undefined && object.tier !== null ? SpotFeeTier.fromPartial(object.tier) : undefined;
+    message.volumeSource = object.volumeSource ?? "";
     return message;
   }