getwalletdetails

README

get_wallet_details Task

Description

The get_wallet_details task retrieves detailed information about a wallet on the Ethereum blockchain. It is instrumental for validating wallet configurations and assessing their current states within various testing and operational environments.

Configuration Parameters

• privateKey: The private key of the wallet for which details are sought. If the private key is provided, the address will be derived from it and does not need to be separately specified.

• address: The public address of the wallet. Specify this if you want to query the blockchain for wallet details without providing the private key. Either the privateKey or the address can be specified, but not both.

Outputs

The get_wallet_details task provides the following outputs after execution:

• address: The public address of the wallet, either derived from the provided private key or as directly specified.

• balance: The current balance of the wallet in wei, offering insight into the funds available at the time of the query.

• nonce: The transaction count or nonce of the wallet, indicating the number of transactions sent from the wallet's address. This is essential for tracking the wallet's activity and sequence.

• summary: A comprehensive summary of all wallet properties. This summary encapsulates the wallet's address, balance, nonce, and other pertinent details, providing a complete overview of the wallet's status.

Defaults

Default settings for the get_wallet_details task:

- name: get_wallet_details
  config:
    privateKey: ""
    address: ""

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) Execute(ctx context.Context) error
  • func (t *Task) LoadConfig() error
  • func (t *Task) Timeout() time.Duration

Variables

var (
	TaskName       = "get_wallet_details"
	TaskDescriptor = &types.TaskDescriptor{
		Name:        TaskName,
		Description: "Get wallet details.",
		Config:      DefaultConfig(),
		NewTask:     NewTask,
	}
)

Functions

func NewTask

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

Types

type Config

type Config struct {
	PrivateKey string `yaml:"privateKey" json:"privateKey"`
	Address    string `yaml:"address" json:"address"`
}

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) Execute

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

func (*Task) LoadConfig

func (t *Task) LoadConfig() error

func (*Task) Timeout

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