RFC: Remove GrazChain

[codingki]

This RFC (Request for Comments) document outlines the breaking changes, updates, and new features planned for removing GrazChain type and usage.

Motivation

Because we are going to release a new cli for chain info/data generation straight from source ex: https://github.com/cosmos/chain-registry called wadesta. I suggest a different approach filling custom value into graz.

Our initial intention having GrazChain is for adding and only using required value for interacting with clients and signingClients.

Current GrazChain

interface GrazChain {
  chainId: string;
  currencies: Currency[];
  rest: string;
  rpc: string;
  rpcHeaders?: Dictionary<string>;
  gas?: { price: string; denom: string };
}

We adding rpcHeaders and gas in there for interacting with clients and signingClient for simplicity, but this can make a different problem when you already have a ChainInfo you will need to mutate those constants. this is not a good approach.

Goals

in v0.1.x when you connect you will need just the chainId, GrazChain is not longer be the parameter in connect. We will remove GrazChain and we will using ChainInfo type from keplr so You will need to pass an array of ChainInfo to GrazProvider.

example:

const cosmoshub = {};// cosmoshub chain info
const sommelier = {};// sommelier chain info

return(
<GrazProvider grazOptions={{
  chains: [cosmoshub, sommelier]
}}>
    {child}
</GrazProvider>
)

What if We want to add rpcHeaders and gas?

We will have a new params to the grazOptions called chainsConfig it's a record of ChainConfig

ChainsConfig

// string is chainId
type ChainsConfig = Record<string, ChainConfig>

ChainConfig

interface ChainConfig {
  rpcHeaders?: Dictionary<string>;
  gas?: { price: string; denom: string }
}

so in GrazProvider will be like this:

const cosmoshub = {};// cosmoshub chain info
const sommelier = {};// sommelier chain info

return(
<GrazProvider grazOptions={{
  chains: [cosmoshub, sommelier]
  chainsConfig: {
   "cosmoshub-4": {
      rpcHeaders: ...,
      gas: {
        price: ...,
        denom: ...
      }
    }
  }
}}>
    {child}
</GrazProvider>
)

Conclusion

This RFC document has outlined the motivations, goals, and breaking changes planned for removing GrazChain type and usage.

Feedback and suggestions from the graz community are highly appreciated. Please provide your input and comments on this RFC to help shape the future of graz and ensure that it meets the needs of the developers.

[codingki]

in 0.1.x Commit: 5211161