pypergraph.network.api package

Submodules

pypergraph.network.api.block_explorer_api module

class pypergraph.network.api.block_explorer_api.BlockExplorerApi(host: str, client: RESTClient | None = None, timeout: int = 25)

Bases: object

config(host: str | None = None, client: RESTClient | None = None)

Reconfigure the RestAPIClient.

async get_address_balance(hash: str) → Balance

Retrieve the balance for a given address from the block explorer.

Parameters:

hash – Address hash.

Returns:

Balance object.

async get_currency_address_balance(metagraph_id: str, hash: str) → Balance

async get_currency_snapshot(metagraph_id: str, hash_or_ordinal: str) → CurrencySnapshot

async get_currency_snapshot_rewards(metagraph_id: str, hash_or_ordinal: str) → List[RewardTransaction]

async get_currency_transaction(metagraph_id: str, hash: str) → Transaction

async get_currency_transactions(metagraph_id: str, limit: int | None, search_after: str | None = None, search_before: str | None = None) → List[Transaction]

async get_currency_transactions_by_address(metagraph_id: str, address: str, limit: int = 0, search_after: str = '', sent_only: bool = False, received_only: bool = False, search_before: str = '') → List[Transaction]

async get_currency_transactions_by_snapshot(metagraph_id: str, hash_or_ordinal: str, limit: int = 0, search_after: str = '', search_before: str = '') → List[Transaction]

async get_latest_currency_snapshot(metagraph_id: str) → CurrencySnapshot

async get_latest_currency_snapshot_rewards(metagraph_id: str) → List[RewardTransaction]

async get_latest_snapshot() → Snapshot

Get the latest snapshot from the block explorer.

Returns:

Snapshot object.

async get_latest_snapshot_rewards() → List[RewardTransaction]

async get_latest_snapshot_transactions() → List[Transaction]

Retrieve transactions for the latest snapshot.

Returns:

List of Transaction objects.

async get_rewards_by_snapshot(id: str | int) → List[RewardTransaction]

Retrieve reward objects for a given snapshot.

Parameters:

id – Hash or ordinal.

Returns:

List of Reward objects.

async get_snapshot(id: str | int) → Snapshot

Retrieve a snapshot by its hash or ordinal.

Parameters:

id – Hash or ordinal identifier.

Returns:

Snapshot object.

async get_transaction(hash: str) → Transaction

Retrieve a transaction by its hash.

Parameters:

hash – Transaction hash.

Returns:

Transaction object.

async get_transactions(limit: int | None, search_after: str | None = None, search_before: str | None = None) → List[Transaction]

Get transactions from the block explorer. Supports pagination.

Parameters:

• limit – Maximum number of transactions.

• search_after – Pagination parameter.

• search_before – Pagination parameter.

Returns:

List of Transaction objects.

async get_transactions_by_address(address: str, limit: int = 0, search_after: str = '', sent_only: bool = False, received_only: bool = False, search_before: str = '') → List[Transaction]

Retrieve transactions for a specific DAG address. Supports pagination.

Parameters:

• address – DAG address.

• limit – Maximum number of transactions.

• search_after – Pagination parameter.

• sent_only – Filter for sent transactions.

• received_only – Filter for received transactions.

• search_before – Pagination parameter.

Returns:

List of Transaction objects.

async get_transactions_by_snapshot(id: str | int) → List[Transaction]

Retrieve transactions for a given snapshot.

Parameters:

id – Hash or ordinal identifier.

Returns:

List of Transaction objects.

pypergraph.network.api.layer_0_api module

class pypergraph.network.api.layer_0_api.L0Api(host: str, client: RESTClient | None = None, timeout: int = 25)

Bases: object

config(host: str | None = None, client: RESTClient | None = None)

Reconfigure the RestAPIClient.

async get_address_balance(address: str) → Balance

async get_cluster_info() → List[PeerInfo]

async get_delegated_stake_last_reference(address: str) → TransactionReference

async get_delegated_stakes_info(address) → DelegatedStakesInfo

async get_delegated_stakes_reward_info()

async get_latest_snapshot() → SignedGlobalIncrementalSnapshot

async get_latest_snapshot_ordinal() → Ordinal

async get_metrics() → List[Dict[str, Any]]

Get metrics from the L0 endpoint.

Returns:

Prometheus output as a list of dictionaries.

async get_node_collateral_last_reference(address: str) → TransactionReference

async get_node_collaterals_info(address) → NodeCollateralsInfo

async get_node_parameters(search_name_or_id: str | None = None, sort: Literal['name', 'peerID', 'address', 'totalAddressesAssigned', 'totalAmountDelegated'] | None = None, sort_order: Literal['ASC', 'DESC'] | None = None)

async get_node_parameters_by_address(address)

async get_total_supply() → TotalSupply

async post_delegated_stake(tx: SignedCreateDelegatedStake)

async post_node_collateral(tx: SignedCreateNodeCollateral)

async post_node_parameters(tx: SignedUpdateNodeParameters)

Register validator parameters for delegated staking

async post_state_channel_snapshot(address: str, snapshot: dict)

async put_delegated_stake_withdrawal(tx: SignedWithdrawDelegatedStake)

async put_node_collateral_withdrawal(tx: SignedWithdrawNodeCollateral)

pypergraph.network.api.layer_1_api module

class pypergraph.network.api.layer_1_api.L1Api(host: str, client: RESTClient | None = None, timeout: int = 25)

Bases: object

config(host: str | None = None, client: RESTClient | None = None)

Reconfigure the RestAPIClient.

async get_allow_spend_last_reference(address: str) → AllowSpendReference

async get_cluster_info() → List[PeerInfo]

async get_last_reference(address: str) → TransactionReference

async get_metrics() → List[Dict[str, Any]]

Get metrics from the L1 endpoint.

Returns:

Prometheus output as a list of dictionaries.

async get_pending_transaction(hash: str) → PendingTransaction

async get_token_lock_last_reference(address: str) → TokenLockReference

async post_allow_spend(tx: SignedAllowSpend)

async post_token_lock(tx: SignedTokenLock)

async post_transaction(tx: SignedTransaction)

pypergraph.network.api.metagraph_currency_layer_1_api module

class pypergraph.network.api.metagraph_currency_layer_1_api.ML1Api(host: str, client: RESTClient | None = None, timeout: int = 25)

Bases: L1Api

pypergraph.network.api.metagraph_data_layer_1_api module

class pypergraph.network.api.metagraph_data_layer_1_api.MDL1Api(host: str, client: RESTClient | None = None, timeout: int = 25)

Bases: object

config(host: str | None = None, client: RESTClient | None = None)

Reconfigure the RestAPIClient.

async get_cluster_info() → List[PeerInfo]

async get_data() → List[SignedTransaction]

Retrieve enqueued data update objects.

async get_metrics() → List[Dict[str, Any]]

Get metrics from the Metagraph data layer 1 endpoint.

Returns:

Prometheus output as a list of dictionaries.

async post_data(tx: Dict)

Submit a data update object for processing.

Parameters:

tx – SignedTransaction object containing data and proofs

pypergraph.network.api.metagraph_layer_0_api module

class pypergraph.network.api.metagraph_layer_0_api.ML0Api(host: str, client: RESTClient | None = None, timeout: int = 25)

Bases: L0Api

async get_address_balance(address: str) → Balance

async get_address_balance_at_ordinal(ordinal: int, address: str) → Balance

async get_total_supply() → TotalSupply

async get_total_supply_at_ordinal(ordinal: int) → TotalSupply

Module contents

class pypergraph.network.api.BlockExplorerApi(host: str, client: RESTClient | None = None, timeout: int = 25)

Bases: object

config(host: str | None = None, client: RESTClient | None = None)

Reconfigure the RestAPIClient.

async get_address_balance(hash: str) → Balance

Retrieve the balance for a given address from the block explorer.

Parameters:

hash – Address hash.

Returns:

Balance object.

async get_currency_address_balance(metagraph_id: str, hash: str) → Balance

async get_currency_snapshot(metagraph_id: str, hash_or_ordinal: str) → CurrencySnapshot

async get_currency_snapshot_rewards(metagraph_id: str, hash_or_ordinal: str) → List[RewardTransaction]

async get_currency_transaction(metagraph_id: str, hash: str) → Transaction

async get_currency_transactions(metagraph_id: str, limit: int | None, search_after: str | None = None, search_before: str | None = None) → List[Transaction]

async get_currency_transactions_by_address(metagraph_id: str, address: str, limit: int = 0, search_after: str = '', sent_only: bool = False, received_only: bool = False, search_before: str = '') → List[Transaction]

async get_currency_transactions_by_snapshot(metagraph_id: str, hash_or_ordinal: str, limit: int = 0, search_after: str = '', search_before: str = '') → List[Transaction]

async get_latest_currency_snapshot(metagraph_id: str) → CurrencySnapshot

async get_latest_currency_snapshot_rewards(metagraph_id: str) → List[RewardTransaction]

async get_latest_snapshot() → Snapshot

Get the latest snapshot from the block explorer.

Returns:

Snapshot object.

async get_latest_snapshot_rewards() → List[RewardTransaction]

async get_latest_snapshot_transactions() → List[Transaction]

Retrieve transactions for the latest snapshot.

Returns:

List of Transaction objects.

async get_rewards_by_snapshot(id: str | int) → List[RewardTransaction]

Retrieve reward objects for a given snapshot.

Parameters:

id – Hash or ordinal.

Returns:

List of Reward objects.

async get_snapshot(id: str | int) → Snapshot

Retrieve a snapshot by its hash or ordinal.

Parameters:

id – Hash or ordinal identifier.

Returns:

Snapshot object.

async get_transaction(hash: str) → Transaction

Retrieve a transaction by its hash.

Parameters:

hash – Transaction hash.

Returns:

Transaction object.

async get_transactions(limit: int | None, search_after: str | None = None, search_before: str | None = None) → List[Transaction]

Get transactions from the block explorer. Supports pagination.

Parameters:

• limit – Maximum number of transactions.

• search_after – Pagination parameter.

• search_before – Pagination parameter.

Returns:

List of Transaction objects.

async get_transactions_by_address(address: str, limit: int = 0, search_after: str = '', sent_only: bool = False, received_only: bool = False, search_before: str = '') → List[Transaction]

Retrieve transactions for a specific DAG address. Supports pagination.

Parameters:

• address – DAG address.

• limit – Maximum number of transactions.

• search_after – Pagination parameter.

• sent_only – Filter for sent transactions.

• received_only – Filter for received transactions.

• search_before – Pagination parameter.

Returns:

List of Transaction objects.

async get_transactions_by_snapshot(id: str | int) → List[Transaction]

Retrieve transactions for a given snapshot.

Parameters:

id – Hash or ordinal identifier.

Returns:

List of Transaction objects.

pypergraph.network.api.Layer0Api

alias of L0Api

pypergraph.network.api.Layer1Api

alias of L1Api

pypergraph.network.api.MetagraphCurrencyLayerApi

alias of ML1Api

pypergraph.network.api.MetagraphDataLayerApi

alias of MDL1Api

pypergraph.network.api.MetagraphLayer0Api

alias of ML0Api