API Reference Anoma v0.34.0

I am an action in shielded resource machine.

I represent the resource's instance.

I represent a compliance's private inputs.

I represent the resource logic's instance.

I am a proof record for a shielded resource.

I am a shielded resource.

I am a shielded resource machine transaction.

I represent a resource merkle tree. The resource tree should be quite small, such as with a depth of 4

I am a bunch of utility functions useful for the Cairo backend.

I am a bunch of workflow functions for creating a shielded transaction.

Documentation for Client.

The Anoma client application acts as a proxy between a third-party client and an Anoma node.

I implement the logic for the Anoma client commandline interface.

I contain functions to test the public interface of the client.

I contain functions to test the public interface of the client.

I contain functions to test the public interface of the client.

I contain functions to test the public interface of the client.

I contain functions to test the public interface of the client.

I contain functions to test the public interface of the client.

I contain functions to test the public interface of the client.

I contain functions to test the public interface of the client.

I contain functions that test and showcase the Runer module.

I contain examples for the GRPC proxy.

I test the GRPC Proxy its executor endpoint.

I test the GRPC Proxy its intents endpoint.

I test the GRPC Proxy its intents endpoint.

I am the GRPC endpoint for the client.

I handle all incoming request for the PubSub endpoint of the client.

I am the client supervisor. I monitor all the processed regarding a connection to a single remote node.

I am the GRPC proxy. I am responsible to translate requests to a node into GRPC requests. I return the value from the requests, or return an error.

I contain functions that make requests to the GRPC endpoint of a node.

I contain logic to run nock code.

I am the Client Storage module.

I contain logic to deal with transactions within the client.

The entrypoint for defining your web interface, such as controllers, components, channels, and so on.

This module defines the test case to be used by tests that require setting up a connection.

This module is invoked by your endpoint in case of errors on JSON requests.

ReadOnlyTransaction

Result

AddIntent

AddResult

IntentList

AddResult

AddTransaction

ProveRequest

Result of Nock evaluation

RunRequest

SubscribeRequest

SubscribeResult

ComposeResult

ComposeTransactions

VerifyRequest

VerifyResult

I represent the Identity

I am an implementation of the Local Randomness Engine

I am an Node Event module for Anoma Node. I provide a wrapper around all Anoma Events.

I contain the defevent macro, which facilitates the definition of typed event structs and optionally associated filters. Require or use me to use defevent.

I am the Anoma.Node.Event.NodeFilter filter generated by deffilter in Anoma.Node.Event.

I contain logic to send node events and wait for node events.

I define custom events FooEvent and BarEvent with filters.

I am the Anoma.Node.Examples.EEvent.EDefEvent.EventExample.BarFilter filter generated by deffilter in Anoma.Node.Examples.EEvent.EDefEvent.EventExample.

I am the Anoma.Node.Examples.EEvent.EDefEvent.EventExample.FooFilter filter generated by deffilter in Anoma.Node.Examples.EEvent.EDefEvent.EventExample.

I contain examples to test the GRPC endpoint of the node.

I contain several examples on how to run the intent pool.

I define examples that test the behavior of the replay mechanism.

I define examples on how the start state of a node is computed.

I contain several examples on how to use the solver.

I contain generic helper functions to write examples.

I contain examples on how to interact with the mempool.

I define examples on how to serialize events to json.

I define examples on how to serialize events to json.

I define examples on how to serialize events to json.

I define examples on how to serialize common structs to json. I am merely a test suite, rather than examples.

I am the intent pool for the Anoma node. m1dnight still has to write these docs.

I define all events that are being sent by the intent pool.

I am the Anoma.Node.Intents.IntentPool.Events.IntentAddErrorFilter filter generated by deffilter in Anoma.Node.Intents.IntentPool.Events.

I am the Anoma.Node.Intents.IntentPool.Events.IntentAddSuccessFilter filter generated by deffilter in Anoma.Node.Intents.IntentPool.Events.

I am the Anoma.Node.Intents.IntentPool.TRMFilter filter generated by deffilter in Anoma.Node.Intents.IntentPool.

I am a strawman intent solver for testing purposes.

I am the supervisor for the intents subsystem.

I am the Logging Engine.

I am the Anoma.Node.Logging.BlocksFilter filter generated by deffilter in Anoma.Node.Logging.

I am the Anoma.Node.Logging.LoggingFilter filter generated by deffilter in Anoma.Node.Logging.

I am the Node Registry module.

I contain logic to replay storage.

I define logic that determines the startup state for the node.

I am the top level supervisor for the Anoma node.

I am the Transaction Backend module.

I define all events that are being sent by the backend.

I am the Anoma.Node.Transaction.Backends.Events.CompleteFilter filter generated by deffilter in Anoma.Node.Transaction.Backends.Events.

I am the Anoma.Node.Transaction.Backends.Events.ForMempoolExecutionFilter filter generated by deffilter in Anoma.Node.Transaction.Backends.Events.

I am the Anoma.Node.Transaction.Backends.Events.ForMempoolFilter filter generated by deffilter in Anoma.Node.Transaction.Backends.Events.

I am the Executor Engine.

I define all events that are being sent by the mempool.

I am the Mempool Engine.

I define all events that are being sent by the mempool.

I am the Anoma.Node.Transaction.Mempool.Events.BlockFilter filter generated by deffilter in Anoma.Node.Transaction.Mempool.Events.

I am the Anoma.Node.Transaction.Mempool.Events.ConsensusFilter filter generated by deffilter in Anoma.Node.Transaction.Mempool.Events.

I am the Anoma.Node.Transaction.Mempool.Events.TxFilter filter generated by deffilter in Anoma.Node.Transaction.Mempool.Events.

I am the Ordering Engine.

I define the events and event filters for the ordering engine.

I am the Anoma.Node.Transaction.Ordering.Events.TxIdFilter filter generated by deffilter in Anoma.Node.Transaction.Ordering.Events.

I am the Storage Engine.

I define all events that are being sent by the storage engine.

I am the Anoma.Node.Transaction.Storage.Events.HeightFilter filter generated by deffilter in Anoma.Node.Transaction.Storage.Events.

I am the supervisor for the transaction subsystem.

Implementation of the GRPC endpoint for node advertisement.

I am the network registry.

I am a node advertisement.

I am an engine proxy. I proxy messages for a remote engine. I am a child of the Node proxy.

I define all events that are being sent by the backend.

I am the node proxy. I am responsible for communication with a remote node.

I am the Anoma.Node.Transport.Proxy.Node.ExcludeNode filter generated by deffilter in Anoma.Node.Transport.Proxy.Node.

I am the supervisor for a proxy to a specific node.

I am the implementation of the transport protocol engine. https://specs.anoma.net/pr-320/arch/node/engines/transport_protocol.html

I am the transport supervisor.

I define functions that deal with errors during the handling of GRPC requests.

I am the Intent protocol.

I am the Compliance Unit module for the TRM.

I am the commitment accumulator module for the TRM.

I am the Delta Hash module for the TRM.

I am the FixedSize interface module for the TRM.

I am the compliance proving system module for the TRM.

I am the instance module for the compliance proving system of the TRM.

I am the delta proving system module for the TRM.

I am the instance module for the delta proving system of the TRM.

I am the resource logic proving system module for the TRM.

I am the instance module for the resource logic proving system of the TRM.

I am the Resource module of the TRM.

I am the Transaction module for the TRM.

I am the top level supervisor for the Anoma node application.

I provide out utilities for ensuring user Data, Config, etc. directories are properly setup for the host operating system.

I provide utility functions for users.

A simple commitment tree.

I represent a compact proof that a particular element is contained within the commitment tree.

A specification for a commitment tree.

I am the EventBroker Application Module.

I am a Broker module.

I contain the deffilter macro. Require or use me to use deffilter.

I am an Event module for the Event Broker.

I am a filter module for the Event Broker. I provide the callbacks for all the filters used in the PubSub system.

I am a Filter Agent module.

I contain submodules for the default filters supported by the event broker.

I am the EventBroker.Filters.LessTrivial filter generated by deffilter in EventBroker.Filters.

I am the EventBroker.Filters.ManyFields filter generated by deffilter in EventBroker.Filters.

I am the EventBroker.Filters.SourceModule filter generated by deffilter in EventBroker.Filters.

I am the EventBroker.Filters.Trivial filter generated by deffilter in EventBroker.Filters.

I am the Registry for the PubSub system.

I am the EventBroker Supervisor for PubSub.

I contain the with_subscription macro. Require me or use me to use with_subscription.

I define examples on how to use the deffilter macro to create filters for the event broker.

I am the Examples.EEVentBroker.EFilter.AcceptAll filter generated by deffilter in Examples.EEVentBroker.EFilter.

I am the Examples.EEVentBroker.EFilter.Error filter generated by deffilter in Examples.EEVentBroker.EFilter.

I am the Examples.EEVentBroker.EFilter.RejectAll filter generated by deffilter in Examples.EEVentBroker.EFilter.

I contain examples of how the with_subscription block works.

I define examples on how to susbcribe to topics in the event broker.

I catch specific Nock encoding errors, and turn them into a generic GRPC.RPCError instance.

I am the Glossary module. I provide a way to define and document terms throughout the codebase.

A map with an identity value; all keys not explicitly assigned a value map to the identity.

I generate out extra information for Livebook

An IdentityMap where the values are MapSets, plus some convenient helper functions.

Nock, a universal function on nouns.

Jets for the Nock interpreter, taking a gate core. Not fully general.

I am the Mugs module for the Nock Jet system.

I am the Nock Library module.

The noun data structure.

Parsing and printing of nouns.

I am the implementation of Nock de/serialization functions, cue and jam.

I am the exception thrown by cue!/1 when it cannot decode further.

I am the exception thrown by jam/1 when it encounters a non-noun which it is incapable of encoding.

I am the module implementing noun ordering functionality.

I generate test cases for all public functions with arity 0 from the given module.

I am a module populated by macros associated to Anoma Testing.

I am a protocol that can be used to validate a struct. I am used to validate GRPC requests.

I contain helper functions for the Validate protocol. I implement genertic data traversal and constraint checking.

I compile the protobuf files before compiling the project.

I generate out the TOC for each liveview doc