Help us shape the future of Go! Take the 2026 Go Developer Survey

clerk

package
v0.1.123 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 22, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package clerk implements the `polycli heimdall state-sync` umbrella command (aliases `clerk` and `ss`) and its subcommands targeting Heimdall v2's `x/clerk` module: count, latest-id, get, list, range, sequence, is-old.

Per HEIMDALLCAST_REQUIREMENTS.md §3.2.5 these endpoints live under a single umbrella rather than at the top level of the heimdall tree. The umbrella also accepts a bare integer (`state-sync 36610`) as a shorthand for `state-sync get 36610`.

Pagination note: `/clerk/event-records/list` is page-based (page + limit query params), NOT Cosmos pagination, and rejects `page=0` with HTTP 400. `/clerk/time` is Cosmos-paginated (pagination.limit).

Index

Constants

This section is empty.

Variables

View Source
var ClerkCmd = &cobra.Command{
	Use:     "state-sync [ID]",
	Aliases: []string{"clerk", "ss"},
	Short:   "Query state-sync (clerk) module endpoints.",
	Long:    usage,
	Args:    cobra.MaximumNArgs(1),

	RunE: func(cmd *cobra.Command, args []string) error {
		if len(args) == 0 {
			return cmd.Help()
		}
		if _, err := strconv.ParseUint(args[0], 10, 64); err != nil {
			return &client.UsageError{Msg: fmt.Sprintf("unknown state-sync subcommand or id %q", args[0])}
		}
		return runGet(cmd, args[0], false)
	},
}

ClerkCmd is the umbrella `state-sync` command (aliases `clerk`, `ss`). Subcommands are attached by Register.

Functions

func Register

func Register(parent *cobra.Command, f *config.Flags)

Register attaches the state-sync umbrella command and all of its subcommands to parent, wiring in the shared flag struct.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL