chore: rename chain to consumer for PoS integration (#233)

proto/babylon/btcstaking/v1/btcstaking.proto

@@ -33,9 +33,9 @@ message FinalityProvider {
     // the finality provider is slashed.
     // if it's 0 then the finality provider is not slashed
     uint64 slashed_btc_height = 9;
-    // chain_id is the chain id of the chain the finality provider is operating on.
+    // consumer_id is the ID of the consumer the finality provider is operating on.
     // If it's missing / empty, it's assumed the finality provider is operating in the Babylon chain.
-    string chain_id = 10;
+    string consumer_id = 10;
 }
 
 // FinalityProviderWithMeta wraps the FinalityProvider with metadata.

proto/babylon/btcstaking/v1/packet.proto

@@ -48,9 +48,9 @@ message NewFinalityProvider {
   // the finality provider is slashed.
   // if it's 0 then the finality provider is not slashed
   uint64 slashed_btc_height = 9;
-  // chain_id is the chain id of the chain the finality provider is operating on.
+  // consumer_id is the ID of the consumer the finality provider is operating on.
   // If it's missing / empty, it's assumed the finality provider is operating in the Babylon chain.
-  string chain_id = 10;
+  string consumer_id = 10;
 }
 
 // SlashedFinalityProvider is an IBC packet sent from consumer chain to Babylon

proto/babylon/btcstaking/v1/tx.proto

@@ -51,9 +51,9 @@ message MsgCreateFinalityProvider {
   bytes btc_pk = 4 [ (gogoproto.customtype) = "github.com/babylonchain/babylon/types.BIP340PubKey" ];
   // pop is the proof of possession of btc_pk over the FP signer address.
   ProofOfPossessionBTC pop = 5;
-  // chain id is a registered CZ chain id, or Babylon's chain id.
+  // consumer_id is the ID of the consumer
   // If it's empty, it's assumed to be Babylon's chain id
-  string chain_id = 7;
+  string consumer_id = 7;
 }
 
 // MsgCreateFinalityProviderResponse is the response for MsgCreateFinalityProvider

proto/babylon/btcstkconsumer/v1/btcstkconsumer.proto

@@ -3,12 +3,13 @@ package babylon.btcstkconsumer.v1;
 
 option go_package = "github.com/babylonchain/babylon/x/btcstkconsumer/types";
 
-// ChainRegister is the registration information of a CZ
-message ChainRegister {
-  // chain_id is the ID of the chain
-  string chain_id = 1;
-  // chain_name is the name of the chain
-  string chain_name = 2;
-  // chain_description is a description for the chain (can be empty)
-  string chain_description = 3;
+// ConsumerRegister is the registration information of a consumer
+message ConsumerRegister {
+  // consumer_id is the ID of the consumer
+  // - for Cosmos SDK chains, the consumer ID will be the IBC client ID
+  string consumer_id = 1;
+  // consumer_name is the name of the consumer
+  string consumer_name = 2;
+  // consumer_description is a description for the consumer (can be empty)
+  string consumer_description = 3;
 }

proto/babylon/btcstkconsumer/v1/query.proto

@@ -21,28 +21,28 @@ service Query {
   rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
     option (google.api.http).get = "/babylon/btcstkconsumer/v1/params";
   }
-  // ChainRegistryList queries the list of chains that are registered to Babylon
-  rpc ChainRegistryList(QueryChainRegistryListRequest) returns (QueryChainRegistryListResponse) {
-    option (google.api.http).get = "/babylon/btcstkconsumer/v1/chain_registry_list";
+  // ConsumerRegistryList queries the list of consumers that are registered to Babylon
+  rpc ConsumerRegistryList(QueryConsumerRegistryListRequest) returns (QueryConsumerRegistryListResponse) {
+    option (google.api.http).get = "/babylon/btcstkconsumer/v1/consumer_registry_list";
   }
-  // ChainsRegistry queries the latest info for a given list of chains in Babylon's view
-  rpc ChainsRegistry(QueryChainsRegistryRequest) returns (QueryChainsRegistryResponse) {
-    option (google.api.http).get = "/babylon/btcstkconsumer/v1/chains_registry/{chain_ids}";
+  // ConsumersRegistry queries the latest info for a given list of consumers in Babylon's view
+  rpc ConsumersRegistry(QueryConsumersRegistryRequest) returns (QueryConsumersRegistryResponse) {
+    option (google.api.http).get = "/babylon/btcstkconsumer/v1/consumers_registry/{consumer_ids}";
   }
 
-  // FinalityProviderChain info about one finality provider's chain id
-  rpc FinalityProviderChain(QueryFinalityProviderChainRequest) returns (QueryFinalityProviderChainResponse) {
-    option (google.api.http).get = "/babylon/btcstkconsumer/v1/finality_provider_chain/{fp_btc_pk_hex}";
+  // FinalityProviderConsumer info about one finality provider's consumer id
+  rpc FinalityProviderConsumer(QueryFinalityProviderConsumerRequest) returns (QueryFinalityProviderConsumerResponse) {
+    option (google.api.http).get = "/babylon/btcstkconsumer/v1/finality_provider_consumer/{fp_btc_pk_hex}";
   }
 
-  // FinalityProviders queries all finality providers for a given chain
+  // FinalityProviders queries all finality providers for a given consumer
   rpc FinalityProviders(QueryFinalityProvidersRequest) returns (QueryFinalityProvidersResponse) {
-    option (google.api.http).get = "/babylon/btcstkconsumer/v1/finality_providers/{chain_id}";
+    option (google.api.http).get = "/babylon/btcstkconsumer/v1/finality_providers/{consumer_id}";
   }
 
   // FinalityProvider info about one finality provider
   rpc FinalityProvider(QueryFinalityProviderRequest) returns (QueryFinalityProviderResponse) {
-    option (google.api.http).get = "/babylon/btcstkconsumer/v1/finality_provider/{chain_id}/{fp_btc_pk_hex}";
+    option (google.api.http).get = "/babylon/btcstkconsumer/v1/finality_provider/{consumer_id}/{fp_btc_pk_hex}";
   }
 }
 
@@ -58,32 +58,32 @@ message QueryParamsResponse {
   ];
 }
 
-// QueryChainRegistryListRequest is request type for the Query/ChainRegistryList RPC method
-message QueryChainRegistryListRequest {
+// QueryConsumerRegistryListRequest is request type for the Query/ConsumerRegistryList RPC method
+message QueryConsumerRegistryListRequest {
   // pagination defines whether to have the pagination in the request
   cosmos.base.query.v1beta1.PageRequest pagination = 1;
 }
 
-// QueryChainRegistryListResponse is response type for the Query/ChainRegistryList RPC method
-message QueryChainRegistryListResponse {
-  // chain_ids are IDs of the chains in ascending alphabetical order
-  repeated string chain_ids = 1;
+// QueryConsumerRegistryListResponse is response type for the Query/ConsumerRegistryList RPC method
+message QueryConsumerRegistryListResponse {
+  // consumer_ids are IDs of the consumers in ascending alphabetical order
+  repeated string consumer_ids = 1;
   // pagination defines the pagination in the response
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
 }
 
-// QueryChainsRegistryRequest is request type for the Query/ChainsRegistry RPC method.
-message QueryChainsRegistryRequest { repeated string chain_ids = 1; }
+// QueryConsumersRegistryRequest is request type for the Query/ConsumersRegistry RPC method.
+message QueryConsumersRegistryRequest { repeated string consumer_ids = 1; }
 
-// QueryChainsRegistryResponse is response type for the Query/ChainsRegistry RPC method.
-message QueryChainsRegistryResponse {
-  repeated babylon.btcstkconsumer.v1.ChainRegister chains_register = 1;
+// QueryConsumersRegistryResponse is response type for the Query/ConsumersRegistry RPC method.
+message QueryConsumersRegistryResponse {
+  repeated babylon.btcstkconsumer.v1.ConsumerRegister consumers_register = 1;
 }
 
 // QueryFinalityProvidersRequest is the request type for the
 // Query/FinalityProviders RPC method.
 message QueryFinalityProvidersRequest {
-  string chain_id = 1;
+  string consumer_id = 1;
   // pagination defines an optional pagination for the request.
   cosmos.base.query.v1beta1.PageRequest pagination = 2;
 }
@@ -100,8 +100,8 @@ message QueryFinalityProvidersResponse {
 
 // QueryFinalityProviderRequest requests information about a finality provider
 message QueryFinalityProviderRequest {
-  // chain id is the chain id this finality provider is registered to
-  string chain_id = 1;
+  // consumer id is the consumer id this finality provider is registered to
+  string consumer_id = 1;
   // fp_btc_pk_hex is the hex str of Bitcoin secp256k1 PK of the finality provider
   string fp_btc_pk_hex = 2;
 }
@@ -140,17 +140,17 @@ message FinalityProviderResponse {
   uint64 height = 8;
   // voting_power is the voting power of this finality provider at the given height
   uint64 voting_power = 9;
-  // chain_id is the chain id this finality provider is registered to
-  string chain_id = 10;
+  // consumer_id is the consumer id this finality provider is registered to
+  string consumer_id = 10;
 }
 
-// QueryFinalityProviderChainRequest requests the chain a CZ finality provider belongs to
-message QueryFinalityProviderChainRequest {
+// QueryFinalityProviderConsumerRequest requests the consumer a CZ finality provider belongs to
+message QueryFinalityProviderConsumerRequest {
   // fp_btc_pk_hex is the hex str of Bitcoin secp256k1 PK of the finality provider
   string fp_btc_pk_hex = 1;
 }
 
-// QueryFinalityProviderChainResponse returns the CZ finality provier chain id
-message QueryFinalityProviderChainResponse {
-  string chain_id = 1;
+// QueryFinalityProviderConsumerResponse returns the CZ finality provier consumer id
+message QueryFinalityProviderConsumerResponse {
+  string consumer_id = 1;
 }

proto/babylon/btcstkconsumer/v1/tx.proto

@@ -16,8 +16,8 @@ service Msg {
   // UpdateParams defines a (governance) operation for updating the module
   // parameters. The authority defaults to the x/gov module account.
   rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse);
-  // RegisterChain registers a CZ chain to the btcstkconsumer module.
-  rpc RegisterChain(MsgRegisterChain) returns (MsgRegisterChainResponse);
+  // RegisterConsumer registers a CZ consumer to the btcstkconsumer module.
+  rpc RegisterConsumer(MsgRegisterConsumer) returns (MsgRegisterConsumerResponse);
 }
 
 // MsgUpdateParams is the Msg/UpdateParams request type.
@@ -41,18 +41,18 @@ message MsgUpdateParams {
 // MsgUpdateParams message.
 message MsgUpdateParamsResponse {}
 
-// MsgRegisterChain defines a message for registering CZ chains to the btcstkconsumer module.
-message MsgRegisterChain {
+// MsgRegisterConsumer defines a message for registering CZ consumers to the btcstkconsumer module.
+message MsgRegisterConsumer {
   option (cosmos.msg.v1.signer) = "signer";
 
   string signer = 1;
-  // chain_id is the ID of the chain
-  string chain_id = 2;
-  // chain_name is the name of the chain
-  string chain_name = 3;
-  // chain_description is a description for the chain (can be empty)
-  string chain_description = 4;
+  // consumer_id is the ID of the consumer
+  string consumer_id = 2;
+  // consumer_name is the name of the consumer
+  string consumer_name = 3;
+  // consumer_description is a description for the consumer (can be empty)
+  string consumer_description = 4;
 }
 
-// MsgRegisterChainResponse is the response to the MsgRegisterChain message.
-message MsgRegisterChainResponse {}
+// MsgRegisterConsumerResponse is the response to the MsgRegisterConsumer message.
+message MsgRegisterConsumerResponse {}