Create a VM instance on the network by posting an INSTANCE message. It will be rejected by the network if the account does not have enough funds.
Create a POST message on the aleph.im network. It is associated with a channel and owned by an account.
Post a (create) PROGRAM message.
Create a STORE message to store a file on the aleph.im network. Can be passed either a file path, an IPFS hash or the file's content as raw bytes.
Downloads a file from the Aleph network.
The hash of the STORE message of the file to retrieve.
Estimates the cost of an instance from its content, without publishing a message.
The instance content to estimate.
Fetches an aggregate value from the Aleph network. Aggregates are a key-value store on the Aleph network. Aggregates are bound by address and each address can have multiple keys. By default, only the address that signs the aggregate can modify it.
The address of the aggregate's owner
The key of the aggregate to fetch
Fetches multiple aggregates from the Aleph network. Aggregates are a key-value store on the Aleph network. Aggregates are bound by address and each address can have multiple keys. By default, only the address that signs the aggregate can modify it.
The address of the aggregate's owner
Optionalkeys: string[]The keys of the aggregates to fetch
Create a FORGET message to remove one or multiple messages from the network.
Fetches the channels used by an address.
The address to query.
Fetches the files stored by an address, along with their total size.
The address to query.
Optional file-hash filter, sort order and pagination.
Fetches the POST types used by an address.
The address to query.
Fetches message statistics for one or more addresses (v0 endpoint).
Optional list of addresses to filter on.
Fetches paginated message statistics across addresses (v1 endpoint).
Optional substring filter, sort and pagination.
Fetches a paginated list of aggregates across addresses.
Optional key/address filters, sorting and pagination.
Fetches the token balance of an address, including the locked amount and credit balance.
The address to query.
Optional chain filter and credit-details toggle.
Fetches a paginated list of token balances across chains.
Optional chain filter, minimum balance and pagination.
Fetches the amount of credits consumed by a resource, identified by its message hash.
The hash of the resource's message.
Fetches a paginated list of credit balances.
Optional minimum balance and pagination.
Fetches the credit history of an address.
The address to query.
Optional filters and pagination.
Fetches a stored file by its hash, returning the base64 encoded content and its storage metadata.
The hash of the file to retrieve.
Fetches the raw stored metadata of a file by its hash.
The hash of the file.
Fetches a file's metadata from the hash of the STORE message that references it.
The hash of the STORE message.
Fetches a file's metadata from its reference.
The reference of the file.
Fetches the number of pins referencing a given file hash.
The hash of the file.
Tries to fetch a specific message from the Aleph network. Throws an error if the message is not found or forgotten.
The hash of the message to fetch.
Fetches only the content of a message, without the surrounding message envelope.
The hash of the message to query.
Fetches the reason why a message has been rejected from the network. If the message has no error, returns null.
The hash of the message to fetch the error from.
Retrieves raw messages from the Aleph network. Similar to getPosts, but with more options.
The configuration used to fetch messages.
Retrieves messages using cursor-based pagination. More efficient than page-based pagination for large result sets.
The configuration used to fetch messages (same filters as getMessages, minus page).
Returns an async iterator over all messages matching the given filters. Handles cursor-based pagination automatically, yielding individual messages.
The filters used to query messages (same as getMessages, minus page).
Fetches the processing status of a message (pending, processed, rejected or forgotten), along with its reception time, without fetching the message content.
The hash of the message to query.
Fetches the node's public information, including its P2P multiaddresses.
Fetches the node software version.
Fetches a POST message on the Aleph network. POST messages are used to store arbitrary JSON data on the Aleph network. They can be queried by type, channel, reference, address, tag, or hash. POSTs can be modified by amend messages. This endpoint returns the latest version of the POST.
The configuration used to fetch a post message.
Fetches multiple POST messages on the Aleph network. POST messages are used to store arbitrary JSON data on the Aleph network.
The configuration used to fetch a post message.
Retrieves posts using cursor-based pagination. More efficient than page-based pagination for large result sets.
The configuration used to fetch posts (same filters as getPosts, minus page).
Returns an async iterator over all posts matching the given filters. Handles cursor-based pagination automatically, yielding individual posts.
The filters used to query posts (same as getPosts, minus page).
Fetches the list of channels known to the node.
Triggers a recalculation of message costs and returns a summary of the changes found.
Watches for new messages on the Aleph network. This method returns a socket that can be used to listen for new messages.
The filters used to watch for new messages, similar to getMessages.
Create an AGGREGATE message. It is meant to be used as a quick access storage associated with an account.