View Source Radixir.Core.Request.GetEntityInformation (radixir v0.0.3)

Methods to create each map in GetEntityInformation request body.

Link to this section Summary

Functions

Generates stitch plan for entity_identifier map in GetEntityInformation request body.

Generates stitch plan for network_identifier map in GetEntityInformation request body.

Generates stitch plan for sub_entity map in GetEntityInformation request body.

Link to this section Types

Specs

params() :: keyword()

Specs

stitch_plans() :: [keyword()]

Link to this section Functions

Link to this function

entity_identifier(stitch_plans, params)

View Source

Specs

entity_identifier(stitch_plans(), params()) :: stitch_plans()

Generates stitch plan for entity_identifier map in GetEntityInformation request body.

Parameters

  • stitch_plans: On-going stitch plans that will be stitched into a map.
  • params: Keyword list that contains:
    • address (required, string): Radix address.
Link to this function

network_identifier(stitch_plans, params \\ [])

View Source

Specs

network_identifier(stitch_plans(), params()) :: stitch_plans()

Generates stitch plan for network_identifier map in GetEntityInformation request body.

Parameters

  • stitch_plans: On-going stitch plans that will be stitched into a map.
  • params: Keyword list that contains:
    • network (optional, string): If network is not in params it will default to what is returned from Radixir.Config.network().
Link to this function

sub_entity(stitch_plans, params)

View Source

Specs

sub_entity(stitch_plans(), params()) :: stitch_plans()

Generates stitch plan for sub_entity map in GetEntityInformation request body.

Parameters

  • stitch_plans: On-going stitch plans that will be stitched into a map.
  • params: Keyword list that contains:
    • address (required, string): Sub Entity address.
    • validator_address (optional, string): Validator address.
    • epoch_unlock (optional, integer): Epoch unlock.