Skip to main content

Testing Overview

This section provides comprehensive testing tools and guidelines for validating your Jupiter RFQ webhook implementation. The tests are written using Vitest.

Requirements​

To run the tests, you need to have the following installed:

Suites​

Two suites are available for testing the webhook API, acceptance and integration tests.

To install the dependencies for the tests, run:

make prepare-tests

Acceptance tests​

These tests simulate the interaction between the Jupiter RFQ module and the webhook API. The tests are useful to verify that your implementation is compatible with the Jupiter RFQ module,

The tests can be found in the tests/suites/acceptance/ directory in the webhook toolkit repository.

To run the tests, you need to provide the webhook URL:

WEBHOOK_URL=<your_webhook_url> make run-acceptance-tests

you can also provide an api key if your webhook requires it:

WEBHOOK_URL=<your_webhook_url> WEBHOOK_API_KEY=<your_webhook_api_key> make run-acceptance-tests

for an example, you can run the tests against the bundled sample server:

make run-acceptance-tests-against-sample-server

To run the test directly with pnpm run:

pnpm run acceptance

Integration tests​

Integration tests are end to end tests that simulate the user interaction. The tests are running against our edge (pre-production) environment and require that the webhook has been registered with Jupiter RFQ.

The tests can be found in the tests/suites/integration/ directory in the webhook toolkit repository.

TAKER_KEYPAIR=<path_to_your_keypair.json> \
WEBHOOK_ID=<your_webhook_id> \
make run-integration-tests

By default, the tests will attempt to get a quote for 1 USDC to SOL, upon a successful quote, the tests will proceed to swap the tokens. To modify the parameters of the quote and swap, you can override the environment variables defined in the params.ts file in the webhook toolkit repository.

⚠️ Warning: Running the integration tests will perform a real swap on the Solana mainnet. Make sure you have the necessary funds in your wallet before running the tests.

To run the test directly with pnpm run:

pnpm run integration

Manual tests​

To test a webhook via the edge UI with you can use a browser extension (example) that allows to modify http request params, adding the rules:

  • host: https://preprod.ultra-api.jup.ag/*
  • param: webhookId=<your_webhook_id>