Skip to content

fix: ICS forge display change format #233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reecepbcups merged 1 commit into from
Oct 11, 2024
Merged

fix: ICS forge display change format #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions spawn/cfg_registry_schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,21 @@ import (
"github.com/rollchains/spawn/spawn/types"
)

const (
DefaultWebsite = "https://example.com"
DefaultDiscord = "https://discord.gg/your-discord"
DefaultEmail = "example@example.com"
DefaultLogoPNG = "https://raw.githubusercontent.com/cosmos/chain-registry/master/cosmoshub/images/atom.png"
DefaultLogoSVG = "https://raw.githubusercontent.com/cosmos/chain-registry/master/cosmoshub/images/atom.svg"
DefaultDescription = "A short description of your project"
DefaultChainID = "localchain-1"
DefaultNetworkType = "testnet" // or mainnet
DefaultSlip44CoinType = 118
DefaultChainRegistrySchema = "https://raw.githubusercontent.com/cosmos/chain-registry/master/chain.schema.json"
DefaultChainRegistryAssetsSchema = "https://github.com/cosmos/chain-registry/blob/master/assetlist.schema.json"
DefaultThemeHexColor = "#FF2D00"
)

var caser = cases.Title(language.English)

func (cfg NewChainConfig) ChainRegistryFile() types.ChainRegistryFormat {
Expand Down Expand Up @@ -86,7 +101,7 @@ func (cfg NewChainConfig) ChainRegistryFile() types.ChainRegistryFormat {
},
Images: []types.Images{
{
Png: DefaultLogo,
Png: DefaultLogoPNG,
Theme: types.Theme{
PrimaryColorHex: DefaultThemeHexColor,
},
Expand Down Expand Up @@ -144,12 +159,12 @@ func (cfg NewChainConfig) ChainRegistryAssetsFile() types.ChainRegistryAssetsLis
Display: strings.ToLower(display), // token
Symbol: display, // TOKEN
LogoURIs: types.LogoURIs{
Png: DefaultLogo,
Png: DefaultLogoPNG,
Svg: DefaultLogoSVG,
},
Images: []types.ImagesAssetLists{
{
Png: DefaultLogo,
Png: DefaultLogoPNG,
Svg: DefaultLogoSVG,
Theme: types.Theme{
PrimaryColorHex: DefaultThemeHexColor,
Expand Down
204 changes: 47 additions & 157 deletions spawn/metadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,180 +3,70 @@ package spawn
import (
"encoding/json"
"os"
"strings"
"time"
)

const (
DefaultWebsite = "https://example.com"
DefaultLogo = "https://raw.githubusercontent.com/cosmos/chain-registry/master/cosmoshub/images/atom.png"
DefaultLogoSVG = "https://raw.githubusercontent.com/cosmos/chain-registry/master/cosmoshub/images/atom.svg"
DefaultDescription = "A short description of your project"
DefaultChainID = "localchain-1"
DefaultNetworkType = "testnet" // or mainnet
DefaultSlip44CoinType = 118
DefaultChainRegistrySchema = "https://raw.githubusercontent.com/cosmos/chain-registry/master/chain.schema.json"
DefaultChainRegistryAssetsSchema = "https://github.com/cosmos/chain-registry/blob/master/assetlist.schema.json"
DefaultThemeHexColor = "#FF2D00"
type (
MetadataFile struct {
Display Display `json:"display"`
}
Display struct {
Name string `json:"name"`
Description string `json:"description"`
Links Links `json:"links"`
Widget *Widget `json:"widget,omitempty"`
}
Links struct {
Logo string `json:"logo"`
Discord string `json:"discord"`
Email string `json:"email"`
Github string `json:"github"`
Telegram string `json:"telegram"`
Twitter string `json:"twitter"`
Website string `json:"website"`
Whitepaper string `json:"whitepaper"`
}
Widget struct {
Title string `json:"title,omitempty"`
Description string `json:"description,omitempty"`
ButtonText string `json:"buttonText,omitempty"`
ButtonURL string `json:"buttonUrl,omitempty"`
}
)

func (cfg *NewChainConfig) MetadataFile() MetadataFile {
now := time.Now().UTC()
now = now.Round(time.Minute)

mf := MetadataFile{
Token: TokenMeta{
DisplayDenom: strings.ToUpper(cfg.Denom),
Denom: cfg.Denom,
Decimals: 6,
Inflation: "0.10",
InitialSupply: "1000000000000000000",
MaxSupply: "1000000000000000000",
},
Project: ProjectMeta{
Github: cfg.GithubPath(),
TargetLaunchDate: now,
Logo: DefaultLogo,
Website: DefaultWebsite,
Description: DefaultDescription,
ShortDescription: DefaultDescription,
Whitepaper: "https://example.com/whitepaper.pdf",
Contact: ContactMeta{
Email: "",
Telegram: "",
Twitter: "",
Name: "",
Discord: "",
Display: Display{
Name: cfg.ProjectName,
Description: cfg.ProjectName + " is an Interchain blockchain.",
Links: Links{
Logo: DefaultLogoPNG,
Discord: DefaultDiscord,
Email: DefaultEmail,
Github: "https://" + cfg.GithubPath(),
Telegram: "https://t.me/example",
Twitter: "https://twitter.com/example_account",
Website: DefaultWebsite,
Whitepaper: "https://bitcoin.org/bitcoin.pdf",
},
},
ICS: ICSMeta{},
}
}}

if cfg.IsFeatureEnabled(InterchainSecurity) {
mf.ICS = ICSMeta{
SpawnTime: now,
Title: cfg.BinDaemon,
Summary: DefaultDescription + " ( in .md format)",
ChainID: DefaultChainID,
InitialHeight: ICSClientTypes{
RevisionHeight: 0,
RevisionNumber: 1,
},
UnbondingPeriod: 21 * 24 * time.Hour.Nanoseconds(), // 21 days
CcvTimeoutPeriod: 28 * 24 * time.Hour.Nanoseconds(), // 28 days
TransferTimeoutPeriod: 1 * time.Hour.Nanoseconds(), // 1 hour (matches stride-1 and neutron-1)
ConsumerRedistributionFraction: "0.75",
BlocksPerDistributionTransmission: 1_000,
HistoricalEntries: 10_000,
GenesisHash: "",
BinaryHash: "",
DistributionTransmissionChannel: "",
TopN: 0,
ValidatorsPowerCap: 0,
ValidatorSetCap: 25,
Allowlist: []any{},
Denylist: []any{},
mf.Display.Widget = &Widget{
Title: cfg.ProjectName,
Description: cfg.ProjectName + " is a Interchain blockchain.",
ButtonText: "Learn More",
ButtonURL: DefaultWebsite,
}
}

return mf
}

type MetadataFile struct {
ICS ICSMeta `json:"ics"`
Token TokenMeta `json:"token"`
Project ProjectMeta `json:"project"`
}

func (mf MetadataFile) SaveJSON(loc string) error {
var bz []byte
var err error

if mf.ICS.IsZero() {
// Non-ICS chains would save 0 state to file despite IsZero() being true.
// Hacky override with a new type to save instead.
type MetadataFileBare struct {
Token TokenMeta `json:"token"`
Project ProjectMeta `json:"project"`
}

bz, err = json.MarshalIndent(MetadataFileBare{
Token: mf.Token,
Project: mf.Project,
}, "", " ")
} else {
bz, err = json.MarshalIndent(mf, "", " ")
if err != nil {
return err
}
bz, err := json.MarshalIndent(mf, "", " ")
if err != nil {
return err
}

return os.WriteFile(loc, bz, 0644)
}

type ICSClientTypes struct {
// IBC clienttypes.Height just without omitempty

// the revision that the client is currently on
RevisionNumber uint64 `protobuf:"varint,1,opt,name=revision_number,json=revisionNumber,proto3" json:"revision_number"`
// the height within the given revision
RevisionHeight uint64 `protobuf:"varint,2,opt,name=revision_height,json=revisionHeight,proto3" json:"revision_height"`
}

type ICSMeta struct {
SpawnTime time.Time `json:"spawn_time"`
Title string `json:"title"`
Summary string `json:"summary"`
ChainID string `json:"chain_id"`
InitialHeight ICSClientTypes `json:"initial_height"`
UnbondingPeriod int64 `json:"unbonding_period"`
CcvTimeoutPeriod int64 `json:"ccv_timeout_period"`
TransferTimeoutPeriod int64 `json:"transfer_timeout_period"`
ConsumerRedistributionFraction string `json:"consumer_redistribution_fraction"`
BlocksPerDistributionTransmission int `json:"blocks_per_distribution_transmission"`
HistoricalEntries int `json:"historical_entries"`
GenesisHash string `json:"genesis_hash"`
BinaryHash string `json:"binary_hash"`
DistributionTransmissionChannel string `json:"distribution_transmission_channel"`
TopN int `json:"top_N"`
ValidatorsPowerCap int `json:"validators_power_cap"`
ValidatorSetCap int `json:"validator_set_cap"`
Allowlist []any `json:"allowlist"`
Denylist []any `json:"denylist"`
}

// impl IsZero on ICSMeta
func (ics ICSMeta) IsZero() bool {
// can't compare []any, so checking most defaults
return (ics.Title == "" &&
ics.Summary == "" &&
ics.ChainID == "")
}

type TokenMeta struct {
DisplayDenom string `json:"display_denom"`
Denom string `json:"denom"`
Decimals int `json:"decimals"`
Inflation string `json:"inflation"`
InitialSupply string `json:"initial_supply"`
MaxSupply string `json:"max_supply"`
}

type ProjectMeta struct {
Github string `json:"github"`
TargetLaunchDate time.Time `json:"target_launch_date"`
Logo string `json:"logo"`
Website string `json:"website"`
Description string `json:"description"`
ShortDescription string `json:"short_description"`
Whitepaper string `json:"whitepaper"`
Contact ContactMeta `json:"contact"`
}

type ContactMeta struct {
Email string `json:"email"`
Telegram string `json:"telegram"`
Twitter string `json:"twitter"`
Name string `json:"name"`
Discord string `json:"discord"`
}