mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-11-15 04:25:27 +00:00
70 lines
2.5 KiB
Protocol Buffer
70 lines
2.5 KiB
Protocol Buffer
syntax = "proto3";
|
|
package kava.swap.v1beta1;
|
|
|
|
import "cosmos/base/v1beta1/coin.proto";
|
|
import "cosmos_proto/cosmos.proto";
|
|
import "gogoproto/gogo.proto";
|
|
|
|
option go_package = "github.com/0glabs/0g-chain/x/swap/types";
|
|
|
|
// Params defines the parameters for the swap module.
|
|
message Params {
|
|
option (gogoproto.goproto_stringer) = false; // false here because we define Stringer method in params.go
|
|
|
|
// allowed_pools defines that pools that are allowed to be created
|
|
repeated AllowedPool allowed_pools = 1 [
|
|
(gogoproto.castrepeated) = "AllowedPools",
|
|
(gogoproto.nullable) = false
|
|
];
|
|
// swap_fee defines the swap fee for all pools
|
|
string swap_fee = 2 [
|
|
(cosmos_proto.scalar) = "cosmos.Dec",
|
|
(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
|
|
(gogoproto.nullable) = false
|
|
];
|
|
}
|
|
|
|
// AllowedPool defines a pool that is allowed to be created
|
|
message AllowedPool {
|
|
option (gogoproto.goproto_stringer) = false; // false here because we define Stringer method in params.go
|
|
|
|
// token_a represents the a token allowed
|
|
string token_a = 1;
|
|
// token_b represents the b token allowed
|
|
string token_b = 2;
|
|
}
|
|
|
|
// PoolRecord represents the state of a liquidity pool
|
|
// and is used to store the state of a denominated pool
|
|
message PoolRecord {
|
|
// pool_id represents the unique id of the pool
|
|
string pool_id = 1 [(gogoproto.customname) = "PoolID"];
|
|
// reserves_a is the a token coin reserves
|
|
cosmos.base.v1beta1.Coin reserves_a = 2 [(gogoproto.nullable) = false];
|
|
// reserves_b is the a token coin reserves
|
|
cosmos.base.v1beta1.Coin reserves_b = 3 [(gogoproto.nullable) = false];
|
|
// total_shares is the total distrubuted shares of the pool
|
|
string total_shares = 4 [
|
|
(cosmos_proto.scalar) = "cosmos.Int",
|
|
(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
|
|
(gogoproto.nullable) = false
|
|
];
|
|
}
|
|
|
|
// ShareRecord stores the shares owned for a depositor and pool
|
|
message ShareRecord {
|
|
// depositor represents the owner of the shares
|
|
bytes depositor = 1 [
|
|
(cosmos_proto.scalar) = "cosmos.AddressBytes",
|
|
(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"
|
|
];
|
|
// pool_id represents the pool the shares belong to
|
|
string pool_id = 2 [(gogoproto.customname) = "PoolID"];
|
|
// shares_owned represents the number of shares owned by depsoitor for the pool_id
|
|
string shares_owned = 3 [
|
|
(cosmos_proto.scalar) = "cosmos.Int",
|
|
(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
|
|
(gogoproto.nullable) = false
|
|
];
|
|
}
|