WAX icon

WAX

Interact with the WAX blockchain

Overview

The node interacts with the WAX blockchain to retrieve asset information associated with a specified WAX account. Specifically, the "Get Assets" operation fetches assets owned by an account, optionally filtered by template IDs, collections, or schemas. This is useful for applications that need to display or process blockchain-based digital assets such as NFTs on the WAX platform.

Practical examples include:

  • Displaying all assets owned by a user in a marketplace or portfolio.
  • Filtering assets by specific templates or collections for targeted queries.
  • Integrating asset data into workflows for analytics or reporting.

Properties

Name Meaning
API Endpoint The URL of the WAX blockchain API endpoint to connect to (default: https://wax.greymass.com).
Account Name The WAX blockchain account name whose assets are to be retrieved.
Template ID (Optional) Comma-separated list of template IDs to filter the assets returned.
Collection (Optional) Comma-separated list of collections to filter the assets returned.
Schema (Optional) Comma-separated list of schemas to filter the assets returned.
Code The smart contract code to query against (default: atomicassets).

Output

The node outputs an array of JSON objects representing the assets retrieved from the WAX blockchain. Each object contains detailed information about an individual asset, including its identifiers and metadata as provided by the blockchain API.

If any error occurs during execution and the node is configured to continue on failure, the output will include JSON objects with an error field describing the issue.

No binary data output is indicated.

Dependencies

  • Requires access to a WAX blockchain API endpoint (default is https://wax.greymass.com).
  • Optionally requires an API key credential if the endpoint demands authentication (not explicitly shown but implied by the presence of credentials in the node definition).
  • No other external dependencies are indicated.

Troubleshooting

  • Common issues:
    • Incorrect or missing account name will result in no assets being returned or an error.
    • Invalid or malformed template IDs, collections, or schemas may cause the API to reject the request.
    • Network connectivity issues to the specified API endpoint can cause failures.
  • Error messages:
    • Errors from the blockchain API will be surfaced in the output under an error field if "continue on fail" is enabled.
    • Typical errors might include authentication failures, rate limiting, or invalid parameters.
  • Resolution:
    • Verify the correctness of the account name and optional filters.
    • Ensure the API endpoint is reachable and correct.
    • Check for required API keys or authentication tokens if needed.

Links and References

Discussion