Mukan Erkin Törük
26b204bd04
Some checks are pending
Docs Deploy / build_and_deploy (push) Waiting to run
Generate Docs / cli (push) Waiting to run
Generate Config Doc / cli (push) Waiting to run
Go formatting / go-formatting (push) Waiting to run
Check links / markdown-link-check (push) Waiting to run
Integration / pre-test (push) Waiting to run
Integration / test on (push) Blocked by required conditions
Integration / status (push) Blocked by required conditions
Lint / Lint Go code (push) Waiting to run
Test / test (ubuntu-latest) (push) Waiting to run
77 lines
3.1 KiB
Go
77 lines
3.1 KiB
Go
package plugin
|
|
|
|
import (
|
|
"context"
|
|
|
|
v1 "github.com/ignite/cli/v29/ignite/services/plugin/grpc/v1"
|
|
)
|
|
|
|
// Flag type aliases.
|
|
const (
|
|
FlagTypeString = v1.Flag_TYPE_FLAG_STRING_UNSPECIFIED
|
|
FlagTypeInt = v1.Flag_TYPE_FLAG_INT
|
|
FlagTypeUint = v1.Flag_TYPE_FLAG_UINT
|
|
FlagTypeInt64 = v1.Flag_TYPE_FLAG_INT64
|
|
FlagTypeUint64 = v1.Flag_TYPE_FLAG_UINT64
|
|
FlagTypeBool = v1.Flag_TYPE_FLAG_BOOL
|
|
FlagTypeStringSlice = v1.Flag_TYPE_FLAG_STRING_SLICE
|
|
)
|
|
|
|
// Type aliases for the current plugin version.
|
|
type (
|
|
Command = v1.Command
|
|
ChainInfo = v1.ChainInfo
|
|
IgniteInfo = v1.IgniteInfo
|
|
ExecutedCommand = v1.ExecutedCommand
|
|
ExecutedHook = v1.ExecutedHook
|
|
Flag = v1.Flag
|
|
FlagType = v1.Flag_Type
|
|
Hook = v1.Hook
|
|
Manifest = v1.Manifest
|
|
)
|
|
|
|
// Interface defines the interface that all Ignite App must implement.
|
|
//
|
|
//go:generate mockery --srcpkg . --name Interface --structname PluginInterface --filename interface.go --with-expecter
|
|
type Interface interface {
|
|
// Manifest declares the app's Command(s) and Hook(s).
|
|
Manifest(context.Context) (*Manifest, error)
|
|
|
|
// Execute will be invoked by ignite when an app Command is executed.
|
|
// It is global for all commands declared in Manifest, if you have declared
|
|
// multiple commands, use cmd.Path to distinguish them.
|
|
// The clientAPI argument can be used by plugins to get chain app analysis info.
|
|
Execute(context.Context, *ExecutedCommand, ClientAPI) error
|
|
|
|
// ExecuteHookPre is invoked by ignite when a command specified by the Hook
|
|
// path is invoked.
|
|
// It is global for all hooks declared in Manifest, if you have declared
|
|
// multiple hooks, use hook.Name to distinguish them.
|
|
// The clientAPI argument can be used by plugins to get chain app analysis info.
|
|
ExecuteHookPre(context.Context, *ExecutedHook, ClientAPI) error
|
|
|
|
// ExecuteHookPost is invoked by ignite when a command specified by the hook
|
|
// path is invoked.
|
|
// It is global for all hooks declared in Manifest, if you have declared
|
|
// multiple hooks, use hook.Name to distinguish them.
|
|
// The clientAPI argument can be used by plugins to get chain app analysis info.
|
|
ExecuteHookPost(context.Context, *ExecutedHook, ClientAPI) error
|
|
|
|
// ExecuteHookCleanUp is invoked by ignite when a command specified by the
|
|
// hook path is invoked. Unlike ExecuteHookPost, it is invoked regardless of
|
|
// execution status of the command and hooks.
|
|
// It is global for all hooks declared in Manifest, if you have declared
|
|
// multiple hooks, use hook.Name to distinguish them.
|
|
// The clientAPI argument can be used by plugins to get chain app analysis info.
|
|
ExecuteHookCleanUp(context.Context, *ExecutedHook, ClientAPI) error
|
|
}
|
|
|
|
// ClientAPI defines the interface for plugins to get chain app code analysis info.
|
|
//
|
|
//go:generate mockery --srcpkg . --name ClientAPI --structname PluginClientAPI --filename client_api.go --with-expecter
|
|
type ClientAPI interface {
|
|
// GetChainInfo returns basic info for the configured blockchain app.
|
|
GetChainInfo(context.Context) (*ChainInfo, error)
|
|
// GetIgniteInfo returns basic info for the Ignite.
|
|
GetIgniteInfo(context.Context) (*IgniteInfo, error)
|
|
}
|