Anoma.Client (Anoma v0.34.0)

Documentation for Client.

Summary

t()

I return the list of intents in the node I'm connected to.

I add a transaction to the mempool of the node I'm connected to.

I compose a list of transactions.

I connect to a remote node over GRPC.

Given a Client, I disconnect it and cleanup.

list_intents()

I return the list of intents in the node I'm connected to.

I prove a Nock program with its public and private inputs, and return the result.

I run a Nock program with its inputs, and return the result.

subscribe(topic)

I prove a Nock program with its public and private inputs, and return the result.

@type t() :: %Anoma.Client{pid: pid() | nil}

@spec add_intent(Noun.t()) :: {:ok, :added} | {:error, String.t()}

I return the list of intents in the node I'm connected to.

@spec add_transaction(Noun.t(), atom()) :: {:ok, :added} | {:error, String.t()}

I add a transaction to the mempool of the node I'm connected to.

I compose a list of transactions.

@spec connect(String.t(), integer(), String.t()) ::
  {:ok, t()} | {:error, :node_unreachable} | {:error, :unknown_error, any()}

I connect to a remote node over GRPC.

@spec disconnect(t()) :: :ok

Given a Client, I disconnect it and cleanup.

@spec list_intents() :: {:ok, [binary()]} | {:error, :failed_to_fetch_intents}

I return the list of intents in the node I'm connected to.

@spec prove(Noun.t(), [Noun.t()], [Noun.t()]) ::
  {:ok, Noun.t(), [Noun.t()]} | {:error, any(), [Noun.t()]}

I prove a Nock program with its public and private inputs, and return the result.

@spec run(Noun.t(), [Noun.t()]) ::
  {:ok, Noun.t(), [Noun.t()]} | {:error, any(), [Noun.t()]}

I run a Nock program with its inputs, and return the result.