Generate an RPC Proxy Postman Collection

You can automatically create a Postman collection for a deployed package’s token and account/identity ABIs.

The generated collection targets the Oracle Blockchain Platform RPC proxy API and is intended for testing contract calls outside of the Visual Studio Code Execute form.

Confirm that the project imports the generate-rpc-proxy-postman Hardhat task in hardhat.config.ts or hardhat.config.js. The generation tool does not deploy contracts or create a saved environment. It generates a Postman collection from ABI artifacts. You must provide the deployed proxy addresses and environment variables in Postman when you run requests.

  1. Open Developer Tools in the Blockchain App Builder For Besu activity bar.
  2. Select Generate RPC Proxy Postman Collection.
  3. Select the Hardhat project.
  4. Select the token package. Composed packages and supported imported packages resolve their paired token and account/identity artifacts. Review the token and account artifact paths to ensure that they are correct.
  5. Enter an output path, or retain the following default path: 
    generated/rpc-proxy-postman/<token-name>-rpc-proxy.postman.collection.json
  6. Select Generate. The status area reports the output location and exposes the full Hardhat log if collection generation fails or produces warnings.

To use the generated collection, import the JSON output file into Postman. Configure the collection variables that are required by the generated requests, such as the Oracle Blockchain Platform RPC proxy host, authentication token, deployed token/account proxy addresses, and any caller or wallet information that is required by the endpoint.

The collection represents the ABI surface at the time of compilation. Regenerate it whenever token/account sources, generated composition, or compiled artifacts change.

Troubleshooting Postman Collection Generation

Condition Resolution
Token or account artifact is required Compile the selected project, and then open or select the token package again.
The project does not include generate-rpc-proxy-postman Import the project task in hardhat.config.ts, as showing in the following example.
import "./tasks/generate-rpc-proxy-postman";
Output file is missing Check the selected project root and the relative output path in the full log.
Postman calls an unexpected method set Recompile the current project and regenerate the collection from the intended token package.