generaterandommnemonic

README

generate_random_mnemonic Task

Description

The generate_random_mnemonic task is designed to create a random mnemonic phrase. This task is particularly useful in scenarios where generating new wallets or accounts is necessary for testing purposes. A mnemonic phrase, often used in cryptocurrency wallets, is a set of words that can be translated into a binary seed, which in turn can be used to generate wallet addresses.

Configuration Parameters

• mnemonicResultVar: The name of the variable where the generated mnemonic will be stored. This allows the mnemonic to be used in subsequent tasks, enabling the dynamic creation of wallets or accounts based on the mnemonic.

Defaults

Default settings for the generate_random_mnemonic task:

- name: generate_random_mnemonic
  config:
    mnemonicResultVar: ""

Documentation

Index

• Variables
• func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)
• type Config
  • func DefaultConfig() Config
  • func (c *Config) Validate() error
• type Task
  • func (t *Task) Config() interface{}
  • func (t *Task) Description() string
  • func (t *Task) Execute(_ context.Context) error
  • func (t *Task) LoadConfig() error
  • func (t *Task) Logger() logrus.FieldLogger
  • func (t *Task) Name() string
  • func (t *Task) Timeout() time.Duration
  • func (t *Task) Title() string

Variables

var (
	TaskName       = "generate_random_mnemonic"
	TaskDescriptor = &types.TaskDescriptor{
		Name:        TaskName,
		Description: "Generate random mnemonic.",
		Config:      DefaultConfig(),
		NewTask:     NewTask,
	}
)

Functions

func NewTask

func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)

Types

type Config

type Config struct {
	MnemonicResultVar string `yaml:"mnemonicResultVar" json:"mnemonicResultVar"`
}

func DefaultConfig

func DefaultConfig() Config

func (*Config) Validate

func (c *Config) Validate() error

type Task

type Task struct {
	// contains filtered or unexported fields
}

func (*Task) Config

func (t *Task) Config() interface{}

func (*Task) Description

func (t *Task) Description() string

func (*Task) Execute

func (t *Task) Execute(_ context.Context) error

func (*Task) LoadConfig

func (t *Task) LoadConfig() error

func (*Task) Logger

func (t *Task) Logger() logrus.FieldLogger

func (*Task) Name

func (t *Task) Name() string

func (*Task) Timeout

func (t *Task) Timeout() time.Duration

func (*Task) Title

func (t *Task) Title() string