Kadena v0.19.1

View Source Kadena.Chainweb.P2P.BlockPayload (Kadena v0.19.1)

BlockPayload endpoints implementation for P2P API.

Link to this section Summary

Types

batch_with_outputs_response()
error()
json()
network_opts()
payload_hashes()
retrieve_batch_response()
retrieve_response()
with_outputs_response()

Functions

batch_with_outputs(payload_hashes \\ [], network_opts \\ [])
retrieve(payload_hash, network_opts \\ [])
retrieve_batch(payload_hashes \\ [], network_opts \\ [])
with_outputs(payload_hash, network_opts \\ [])

Link to this section Types

Link to this type

batch_with_outputs_response()

View Source 
@type batch_with_outputs_response() ::
  {:ok, Kadena.Chainweb.P2P.BlockPayloadBatchWithOutputsResponse.t()} | error()
Link to this type

error()

View Source 
@type error() :: {:error, Kadena.Chainweb.Error.t()}
Link to this type

json()

View Source 
@type json() :: String.t()
Link to this type

network_opts()

View Source 
@type network_opts() :: Keyword.t()
Link to this type

payload_hashes()

View Source 
@type payload_hashes() :: [String.t()]
Link to this type

retrieve_batch_response()

View Source 
@type retrieve_batch_response() ::
  {:ok, Kadena.Chainweb.P2P.BlockPayloadBatchResponse.t()} | error()
Link to this type

retrieve_response()

View Source 
@type retrieve_response() ::
  {:ok, Kadena.Chainweb.P2P.BlockPayloadResponse.t()} | error()
Link to this type

with_outputs_response()

View Source 
@type with_outputs_response() ::
  {:ok, Kadena.Chainweb.P2P.BlockPayloadWithOutputsResponse.t()} | error()

Link to this section Functions

Link to this function

batch_with_outputs(payload_hashes \\ [], network_opts \\ [])

View Source 
@spec batch_with_outputs(
  payload_hashes :: payload_hashes(),
  network_opts :: network_opts()
) ::
  batch_with_outputs_response()
Link to this function

retrieve(payload_hash, network_opts \\ [])

View Source 
@spec retrieve(payload_hash :: String.t(), network_opts :: network_opts()) ::
  retrieve_response()
Link to this function

retrieve_batch(payload_hashes \\ [], network_opts \\ [])

View Source 
@spec retrieve_batch(
  payload_hashes :: payload_hashes(),
  network_opts :: network_opts()
) ::
  retrieve_batch_response()
Link to this function

with_outputs(payload_hash, network_opts \\ [])

View Source 
@spec with_outputs(payload_hash :: String.t(), network_opts :: network_opts()) ::
  with_outputs_response()