From 967a1129ea6dbfdc5afd9fae7e3844e2c691c0e0 Mon Sep 17 00:00:00 2001 From: Julian Compagni Portis Date: Thu, 14 Dec 2023 15:27:19 -0500 Subject: [PATCH] Cleanup comments for expiration_time to match current naming --- docs/static/openapi.yml | 150 ++++++++---------- .../neutron/dex/limit_order_expiration.proto | 2 +- proto/neutron/dex/limit_order_tranche.proto | 7 +- x/dex/types/limit_order_expiration.pb.go | 2 +- x/dex/types/limit_order_tranche.pb.go | 4 +- 5 files changed, 76 insertions(+), 89 deletions(-) diff --git a/docs/static/openapi.yml b/docs/static/openapi.yml index 1e2a0b2eb..a89bb59de 100644 --- a/docs/static/openapi.yml +++ b/docs/static/openapi.yml @@ -38348,18 +38348,17 @@ paths: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, - year 1, 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long + as blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but - represent a special case + JIT orders also use expiration_time to handle deletion + but represent a special case - All JIT orders have a goodTilDate of 0 and an exception - is made to still still treat these orders as live + All JIT orders have a expiration_time of 0 and an + exception is made to still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -38507,18 +38506,17 @@ paths: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, - year 1, 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long as + blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but + JIT orders also use expiration_time to handle deletion but represent a special case - All JIT orders have a goodTilDate of 0 and an exception is - made to still still treat these orders as live + All JIT orders have a expiration_time of 0 and an + exception is made to still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -38603,18 +38601,17 @@ paths: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, - year 1, 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long + as blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but - represent a special case + JIT orders also use expiration_time to handle deletion + but represent a special case - All JIT orders have a goodTilDate of 0 and an exception - is made to still still treat these orders as live + All JIT orders have a expiration_time of 0 and an + exception is made to still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -38770,18 +38767,17 @@ paths: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, - year 1, 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long as + blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but + JIT orders also use expiration_time to handle deletion but represent a special case - All JIT orders have a goodTilDate of 0 and an exception is - made to still still treat these orders as live + All JIT orders have a expiration_time of 0 and an + exception is made to still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -39764,19 +39760,18 @@ paths: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January - 1, year 1, 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as + long as blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion - but represent a special case + JIT orders also use expiration_time to handle + deletion but represent a special case - All JIT orders have a goodTilDate of 0 and an - exception is made to still still treat these orders - as live + All JIT orders have a expiration_time of 0 and an + exception is made to still treat these orders as + live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -70758,18 +70753,17 @@ definitions: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, year 1, - 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long as blockTime <= + expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but represent a + JIT orders also use expiration_time to handle deletion but represent a special case - All JIT orders have a goodTilDate of 0 and an exception is made to - still still treat these orders as live + All JIT orders have a expiration_time of 0 and an exception is made to + still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -71082,18 +71076,17 @@ definitions: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, year 1, - 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long as + blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but represent - a special case + JIT orders also use expiration_time to handle deletion but + represent a special case - All JIT orders have a goodTilDate of 0 and an exception is made - to still still treat these orders as live + All JIT orders have a expiration_time of 0 and an exception is + made to still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -71157,18 +71150,17 @@ definitions: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, year 1, - 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long as + blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but represent - a special case + JIT orders also use expiration_time to handle deletion but + represent a special case - All JIT orders have a goodTilDate of 0 and an exception is made - to still still treat these orders as live + All JIT orders have a expiration_time of 0 and an exception is + made to still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -71429,18 +71421,17 @@ definitions: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, year - 1, 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long as + blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but + JIT orders also use expiration_time to handle deletion but represent a special case - All JIT orders have a goodTilDate of 0 and an exception is - made to still still treat these orders as live + All JIT orders have a expiration_time of 0 and an exception + is made to still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -71691,18 +71682,17 @@ definitions: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, year 1, - 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long as + blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but represent a - special case + JIT orders also use expiration_time to handle deletion but + represent a special case - All JIT orders have a goodTilDate of 0 and an exception is made to - still still treat these orders as live + All JIT orders have a expiration_time of 0 and an exception is + made to still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -71738,18 +71728,17 @@ definitions: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, year 1, - 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long as + blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but represent a - special case + JIT orders also use expiration_time to handle deletion but + represent a special case - All JIT orders have a goodTilDate of 0 and an exception is made to - still still treat these orders as live + All JIT orders have a expiration_time of 0 and an exception is + made to still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block @@ -71969,18 +71958,17 @@ definitions: total_taker_denom: type: string title: >- - GoodTilDate is represented as seconds since January 1, year 1, - 00:00:00.00 UTC - LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + LimitOrders with expiration_time set are valid as long as + blockTime <= expiration_time expiration_time: type: string format: date-time title: >- - JIT orders also use goodTilDate to handle deletion but represent a - special case + JIT orders also use expiration_time to handle deletion but + represent a special case - All JIT orders have a goodTilDate of 0 and an exception is made to - still still treat these orders as live + All JIT orders have a expiration_time of 0 and an exception is + made to still treat these orders as live Order deletion still functions the same and the orders will be deleted at the end of the block diff --git a/proto/neutron/dex/limit_order_expiration.proto b/proto/neutron/dex/limit_order_expiration.proto index e69d3212a..bb0b3a316 100644 --- a/proto/neutron/dex/limit_order_expiration.proto +++ b/proto/neutron/dex/limit_order_expiration.proto @@ -7,7 +7,7 @@ import "google/protobuf/timestamp.proto"; import "gogoproto/gogo.proto"; message LimitOrderExpiration { - // see limitOrderTranche.proto for details on goodTilDate + // see limitOrderTranche.proto for details on expiration_time google.protobuf.Timestamp expiration_time = 1 [ (gogoproto.stdtime) = true, (gogoproto.nullable) = false diff --git a/proto/neutron/dex/limit_order_tranche.proto b/proto/neutron/dex/limit_order_tranche.proto index d18822eed..8c0970144 100644 --- a/proto/neutron/dex/limit_order_tranche.proto +++ b/proto/neutron/dex/limit_order_tranche.proto @@ -40,11 +40,10 @@ message LimitOrderTranche { (gogoproto.nullable) = false, (gogoproto.jsontag) = "total_taker_denom" ]; - // GoodTilDate is represented as seconds since January 1, year 1, 00:00:00.00 UTC - // LimitOrders with goodTilDate set are valid as long as blockTime <= goodTilDate + // LimitOrders with expiration_time set are valid as long as blockTime <= expiration_time - // JIT orders also use goodTilDate to handle deletion but represent a special case - // All JIT orders have a goodTilDate of 0 and an exception is made to still still treat these orders as live + // JIT orders also use expiration_time to handle deletion but represent a special case + // All JIT orders have a expiration_time of 0 and an exception is made to still treat these orders as live // Order deletion still functions the same and the orders will be deleted at the end of the block google.protobuf.Timestamp expiration_time = 6 [ (gogoproto.stdtime) = true, diff --git a/x/dex/types/limit_order_expiration.pb.go b/x/dex/types/limit_order_expiration.pb.go index 199a5b9d7..74e7eafa0 100644 --- a/x/dex/types/limit_order_expiration.pb.go +++ b/x/dex/types/limit_order_expiration.pb.go @@ -29,7 +29,7 @@ var _ = time.Kitchen const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package type LimitOrderExpiration struct { - // see limitOrderTranche.proto for details on goodTilDate + // see limitOrderTranche.proto for details on expiration_time ExpirationTime time.Time `protobuf:"bytes,1,opt,name=expiration_time,json=expirationTime,proto3,stdtime" json:"expiration_time"` TrancheRef []byte `protobuf:"bytes,2,opt,name=tranche_ref,json=trancheRef,proto3" json:"tranche_ref,omitempty"` } diff --git a/x/dex/types/limit_order_tranche.pb.go b/x/dex/types/limit_order_tranche.pb.go index 202f2baf1..382b61fd8 100644 --- a/x/dex/types/limit_order_tranche.pb.go +++ b/x/dex/types/limit_order_tranche.pb.go @@ -97,8 +97,8 @@ type LimitOrderTranche struct { ReservesTakerDenom github_com_cosmos_cosmos_sdk_types.Int `protobuf:"bytes,3,opt,name=reserves_taker_denom,json=reservesTakerDenom,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Int" json:"reserves_taker_denom" yaml:"reserves_taker_denom"` TotalMakerDenom github_com_cosmos_cosmos_sdk_types.Int `protobuf:"bytes,4,opt,name=total_maker_denom,json=totalMakerDenom,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Int" json:"total_maker_denom" yaml:"total_maker_denom"` TotalTakerDenom github_com_cosmos_cosmos_sdk_types.Int `protobuf:"bytes,5,opt,name=total_taker_denom,json=totalTakerDenom,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Int" json:"total_taker_denom" yaml:"total_taker_denom"` - // JIT orders also use goodTilDate to handle deletion but represent a special case - // All JIT orders have a goodTilDate of 0 and an exception is made to still still treat these orders as live + // JIT orders also use expiration_time to handle deletion but represent a special case + // All JIT orders have a expiration_time of 0 and an exception is made to still treat these orders as live // Order deletion still functions the same and the orders will be deleted at the end of the block ExpirationTime *time.Time `protobuf:"bytes,6,opt,name=expiration_time,json=expirationTime,proto3,stdtime" json:"expiration_time,omitempty"` PriceTakerToMaker github_com_neutron_org_neutron_v2_utils_math.PrecDec `protobuf:"bytes,7,opt,name=price_taker_to_maker,json=priceTakerToMaker,proto3,customtype=github.com/neutron-org/neutron/v2/utils/math.PrecDec" json:"price_taker_to_maker" yaml:"price_taker_to_maker"`