{ "item": [ { "id": "c31e3fa8-4c1d-45a1-a1a7-7fb33715150e", "name": "instructions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4233d8b9-55d2-42ff-b8eb-dbdc356ded4f", "name": "Build Hyperliquid deposit instructions", "request": { "name": "Build Hyperliquid deposit instructions", "description": { "content": "Build instructions for depositing USDC from Arbitrum to Hyperliquid", "type": "text/plain" }, "url": { "path": [ "v1", "instructions", "hyperliquid", "deposit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"ownerAddress\": \"\",\n \"mode\": \"\",\n \"sourceToken\": {},\n \"sourceChainId\": {},\n \"amount\": {},\n \"orchestratorAddressOverride\": \"\",\n \"feeToken\": {\n \"address\": \"\",\n \"chainId\": \"\",\n \"gasRefundAddress\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5b8dd6b1-f8c2-427d-ad93-420382138ad0", "name": "Response schema for a Hyperliquid deposit quote, including MEE quote information for bridging USDC from Arbitrum to Hyperliquid.", "originalRequest": { "url": { "path": [ "v1", "instructions", "hyperliquid", "deposit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ownerAddress\": \"0x742d35cc6639cb8d4b5d1c5d7b8b5e2e7c0c7a8a\",\n \"mode\": \"smart-account\",\n \"sourceToken\": {},\n \"sourceChainId\": {},\n \"amount\": {},\n \"orchestratorAddressOverride\": \"0x742d35cc6639cb8d4b5d1c5d7b8b5e2e7c0c7a8a\",\n \"feeToken\": {\n \"address\": \"0xaf88d065e77c8cc2239327c5edb3a432268e5831\",\n \"chainId\": 42161\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ownerAddress\": \"0x1234567890abcdef1234567890abcdef12345678\",\n \"fee\": {\n \"amount\": \"10000000000000000\",\n \"token\": \"0x0000000000000000000000000000000000000000\",\n \"chainId\": 8453\n },\n \"quoteType\": \"permit\",\n \"quote\": {\n \"hash\": \"0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdef\",\n \"node\": \"0x9876543210abcdef9876543210abcdef98765432\",\n \"commitment\": \"0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef\",\n \"paymentInfo\": {\n \"sender\": \"0x742d35C9a91B1D5b5D24Dc30e8F0dF8E84b5d1c4\",\n \"initCode\": \"0x1234abcd\",\n \"nonce\": \"0\",\n \"token\": \"0x00000069E0Fb590E092Dd0E36FF93ac28ff11a3a\",\n \"chainId\": 1,\n \"shortEncoding\": false,\n \"tokenValue\": \"1000 (for 1000 USDC), 250000 (for 1 WBTC very soon)\",\n \"tokenWeiAmount\": \"1000000000000000000000 (1000 ether), 250000 (0.25 USDC)\",\n \"verificationGasLimit\": \"21000\",\n \"eoa\": \"0x00000069E0Fb590E092Dd0E36FF93ac28ff11a3a\",\n \"eip7702Auth\": {\n \"address\": \"0x00000069E0Fb590E092Dd0E36FF93ac28ff11a3a\",\n \"chainId\": 8453,\n \"nonce\": 38,\n \"r\": \"0x192a2503401595804c35cdc5b748fe35cceb77ef534bf5d670f7797376487ded\",\n \"s\": \"0x1fd3c8acd0b7c5f64a8d72c35c39988544fca961b838277ab11750041cccc3d1\",\n \"yParity\": 1,\n \"v\": \"28\"\n },\n \"callGasLimit\": \"50000\",\n \"sponsored\": true,\n \"sponsorshipUrl\": \"https://sponsorship.abc.org\",\n \"tokenAmount\": \"1000 (1000 USDC), 1 (1 ether)\",\n \"gasFee\": \"21000000000000000\",\n \"orchestrationFee\": \"1000000000000000\"\n },\n \"userOps\": [\n {\n \"userOp\": {\n \"sender\": \"0x00000069E0Fb590E092Dd0E36FF93ac28ff11a3a\",\n \"nonce\": \"0\",\n \"callData\": \"0x1234abcd\",\n \"callGasLimit\": \"21000\",\n \"verificationGasLimit\": \"100000\",\n \"preVerificationGas\": \"21000\",\n \"maxFeePerGas\": \"1000000000\",\n \"maxPriorityFeePerGas\": \"100000000\",\n \"initCode\": \"0x1234abcd\",\n \"paymasterAndData\": \"0x\",\n \"signature\": \"0xabcdef123456\"\n },\n \"userOpHash\": \"0x1234abcd5678ef90\",\n \"meeUserOpHash\": \"0xabcdef1234567890\",\n \"lowerBoundTimestamp\": 1710000000,\n \"upperBoundTimestamp\": 1710003600,\n \"maxGasLimit\": \"1000000\",\n \"maxFeePerGas\": \"1000000000\",\n \"chainId\": 8453,\n \"eip7702Auth\": {\n \"address\": \"0x00000069E0Fb590E092Dd0E36FF93ac28ff11a3a\",\n \"chainId\": 8453,\n \"nonce\": 38,\n \"r\": \"0x192a2503401595804c35cdc5b748fe35cceb77ef534bf5d670f7797376487ded\",\n \"s\": \"0x1fd3c8acd0b7c5f64a8d72c35c39988544fca961b838277ab11750041cccc3d1\",\n \"yParity\": 1,\n \"v\": \"28\"\n },\n \"isCleanUpUserOp\": false,\n \"shortEncoding\": true\n },\n {\n \"userOp\": {\n \"sender\": \"0x00000069E0Fb590E092Dd0E36FF93ac28ff11a3a\",\n \"nonce\": \"0\",\n \"callData\": \"0x1234abcd\",\n \"callGasLimit\": \"21000\",\n \"verificationGasLimit\": \"100000\",\n \"preVerificationGas\": \"21000\",\n \"maxFeePerGas\": \"1000000000\",\n \"maxPriorityFeePerGas\": \"100000000\",\n \"initCode\": \"0x1234abcd\",\n \"paymasterAndData\": \"0x\",\n \"signature\": \"0xabcdef123456\"\n },\n \"userOpHash\": \"0x1234abcd5678ef90\",\n \"meeUserOpHash\": \"0xabcdef1234567890\",\n \"lowerBoundTimestamp\": 1710000000,\n \"upperBoundTimestamp\": 1710003600,\n \"maxGasLimit\": \"1000000\",\n \"maxFeePerGas\": \"1000000000\",\n \"chainId\": 8453,\n \"eip7702Auth\": {\n \"address\": \"0x00000069E0Fb590E092Dd0E36FF93ac28ff11a3a\",\n \"chainId\": 8453,\n \"nonce\": 38,\n \"r\": \"0x192a2503401595804c35cdc5b748fe35cceb77ef534bf5d670f7797376487ded\",\n \"s\": \"0x1fd3c8acd0b7c5f64a8d72c35c39988544fca961b838277ab11750041cccc3d1\",\n \"yParity\": 1,\n \"v\": \"28\"\n },\n \"isCleanUpUserOp\": false,\n \"shortEncoding\": true\n }\n ],\n \"fundingTokens\": [\n {\n \"tokenAddress\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\",\n \"chainId\": 1,\n \"amount\": \"1000000000\"\n },\n {\n \"tokenAddress\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\",\n \"chainId\": 1,\n \"amount\": \"1000000000\"\n }\n ]\n },\n \"payloadToSign\": [\n {\n \"signablePayload\": {\n \"types\": {\n \"key_0\": [\n {\n \"name\": \"owner\",\n \"type\": \"address\"\n },\n {\n \"name\": \"spender\",\n \"type\": \"address\"\n },\n {\n \"name\": \"value\",\n \"type\": \"uint256\"\n },\n {\n \"name\": \"nonce\",\n \"type\": \"uint256\"\n },\n {\n \"name\": \"deadline\",\n \"type\": \"uint256\"\n }\n ]\n },\n \"message\": {\n \"key_0\": {}\n },\n \"primaryType\": \"Permit\",\n \"domain\": {\n \"name\": \"USD Coin\",\n \"version\": \"2\",\n \"chainId\": 1,\n \"verifyingContract\": \"0xA0b86a33E6441c1a7C4FB1e50Fc5F5ED69DC3D2B\",\n \"salt\": \"0x0000000000000000000000000000000000000000000000000000000000000000\"\n }\n },\n \"metadata\": {\n \"nonce\": \"0\",\n \"name\": \"USD Coin\",\n \"version\": \"2\",\n \"domainSeparator\": \"0x06c37168a7db5138defc7866392bb87a741f9b3d104deb5094588ce041cae335\",\n \"owner\": \"0x742d35C9a91B1D5b5D24Dc30e8F0dF8E84b5d1c4\",\n \"spender\": \"0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45\",\n \"amount\": \"1000000000000000000000\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d15fd54b-17ce-4692-bc84-049aeca4df64", "name": "400", "originalRequest": { "url": { "path": [ "v1", "instructions", "hyperliquid", "deposit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ownerAddress\": \"0x742d35cc6639cb8d4b5d1c5d7b8b5e2e7c0c7a8a\",\n \"mode\": \"smart-account\",\n \"sourceToken\": {},\n \"sourceChainId\": {},\n \"amount\": {},\n \"orchestratorAddressOverride\": \"0x742d35cc6639cb8d4b5d1c5d7b8b5e2e7c0c7a8a\",\n \"feeToken\": {\n \"address\": \"0xaf88d065e77c8cc2239327c5edb3a432268e5831\",\n \"chainId\": 42161\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": \"string\",\n \"path\": [\n \"string\",\n \"string\"\n ],\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"path\": [\n \"string\",\n \"string\"\n ],\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fed1c972-7e29-4a2b-baaf-dc4ef7f87c61", "name": "500", "originalRequest": { "url": { "path": [ "v1", "instructions", "hyperliquid", "deposit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ownerAddress\": \"0x742d35cc6639cb8d4b5d1c5d7b8b5e2e7c0c7a8a\",\n \"mode\": \"smart-account\",\n \"sourceToken\": {},\n \"sourceChainId\": {},\n \"amount\": {},\n \"orchestratorAddressOverride\": \"0x742d35cc6639cb8d4b5d1c5d7b8b5e2e7c0c7a8a\",\n \"feeToken\": {\n \"address\": \"0xaf88d065e77c8cc2239327c5edb3a432268e5831\",\n \"chainId\": 42161\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": \"string\",\n \"path\": [\n \"string\",\n \"string\"\n ],\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"path\": [\n \"string\",\n \"string\"\n ],\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a26c475d-5ddb-4ae8-aa25-7959f0ce7f2d", "name": "Build CCIP token bridge instructions", "request": { "name": "Build CCIP token bridge instructions", "description": { "content": "Build CCIP token bridge instructions for your supertransaction", "type": "text/plain" }, "url": { "path": [ "v1", "instructions", "build-ccip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"srcToken\": \"\",\n \"dstToken\": \"\",\n \"srcChainId\": \"\",\n \"dstChainId\": \"\",\n \"ownerAddress\": \"\",\n \"amount\": {},\n \"mode\": \"\",\n \"gasLimit\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d5ac6fc6-6b6b-401f-a234-4423875de02c", "name": "200", "originalRequest": { "url": { "path": [ "v1", "instructions", "build-ccip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"srcToken\": \"0x833589fcd6edb6e08f4c7c32d4f71b54bda02913\",\n \"dstToken\": \"0x94b008aa00579c1307b0ef2c499ad98a8ce58e58\",\n \"srcChainId\": 8453,\n \"dstChainId\": 10,\n \"ownerAddress\": \"0x742d35cc6639cb8d4b5d1c5d7b8b5e2e7c0c7a8a\",\n \"amount\": {},\n \"mode\": \"\",\n \"gasLimit\": \"50000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instructions\": [\n {\n \"calls\": [\n {\n \"to\": \"0x1111111254EEB25477B68fb85Ed929f73A960582\",\n \"value\": \"0\",\n \"functionSig\": \"transfer(address,uint256)\",\n \"inputParams\": [\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x742d35C9a91B1D5b5D24Dc30e8F0dF8E84b5d1c4\"\n }\n ],\n \"outputParams\": [\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x\"\n }\n ],\n \"gasLimit\": \"100000\"\n },\n {\n \"to\": \"0x1111111254EEB25477B68fb85Ed929f73A960582\",\n \"value\": \"0\",\n \"functionSig\": \"transfer(address,uint256)\",\n \"inputParams\": [\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x742d35C9a91B1D5b5D24Dc30e8F0dF8E84b5d1c4\",\n \"constraints\": [\n {\n \"constraintType\": 1,\n \"referenceData\": \"500\"\n }\n ]\n },\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x742d35C9a91B1D5b5D24Dc30e8F0dF8E84b5d1c4\",\n \"constraints\": [\n {\n \"constraintType\": 1,\n \"referenceData\": \"500\"\n }\n ]\n }\n ],\n \"outputParams\": [\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x\"\n }\n ],\n \"gasLimit\": \"100000\"\n }\n ],\n \"chainId\": 1,\n \"isComposable\": true\n },\n {\n \"calls\": [\n {\n \"to\": \"0x1111111254EEB25477B68fb85Ed929f73A960582\",\n \"value\": \"0\",\n \"functionSig\": \"transfer(address,uint256)\",\n \"inputParams\": [\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x742d35C9a91B1D5b5D24Dc30e8F0dF8E84b5d1c4\",\n \"constraints\": [\n {\n \"constraintType\": 1,\n \"referenceData\": \"500\"\n }\n ]\n },\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x742d35C9a91B1D5b5D24Dc30e8F0dF8E84b5d1c4\",\n \"constraints\": [\n {\n \"constraintType\": 1,\n \"referenceData\": \"500\"\n }\n ]\n }\n ],\n \"outputParams\": [\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x\"\n }\n ],\n \"gasLimit\": \"100000\"\n },\n {\n \"to\": \"0x1111111254EEB25477B68fb85Ed929f73A960582\",\n \"value\": \"0\",\n \"functionSig\": \"transfer(address,uint256)\",\n \"inputParams\": [\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x742d35C9a91B1D5b5D24Dc30e8F0dF8E84b5d1c4\",\n \"constraints\": [\n {\n \"constraintType\": 1,\n \"referenceData\": \"500\"\n }\n ]\n },\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x742d35C9a91B1D5b5D24Dc30e8F0dF8E84b5d1c4\",\n \"constraints\": [\n {\n \"constraintType\": 1,\n \"referenceData\": \"500\"\n }\n ]\n }\n ],\n \"outputParams\": [\n {\n \"fetcherType\": 0,\n \"paramData\": \"0x\"\n }\n ],\n \"gasLimit\": \"100000\"\n }\n ],\n \"chainId\": 1,\n \"isComposable\": true\n }\n ],\n \"simulationTokenOverrides\": [\n {\n \"tokenAddress\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n \"accountAddress\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n \"chainId\": 8453,\n \"balance\": \"12345678901234567890\"\n },\n {\n \"tokenAddress\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n \"accountAddress\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n \"chainId\": 8453,\n \"balance\": \"12345678901234567890\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31773dc7-b730-4e32-890d-27ddca5f6c78", "name": "400", "originalRequest": { "url": { "path": [ "v1", "instructions", "build-ccip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"srcToken\": \"0x833589fcd6edb6e08f4c7c32d4f71b54bda02913\",\n \"dstToken\": \"0x94b008aa00579c1307b0ef2c499ad98a8ce58e58\",\n \"srcChainId\": 8453,\n \"dstChainId\": 10,\n \"ownerAddress\": \"0x742d35cc6639cb8d4b5d1c5d7b8b5e2e7c0c7a8a\",\n \"amount\": {},\n \"mode\": \"\",\n \"gasLimit\": \"50000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": \"string\",\n \"path\": [\n \"string\",\n \"string\"\n ],\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"path\": [\n \"string\",\n \"string\"\n ],\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71fafc1b-8ec2-488b-8e24-8c130b3f0120", "name": "500", "originalRequest": { "url": { "path": [ "v1", "instructions", "build-ccip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"srcToken\": \"0x833589fcd6edb6e08f4c7c32d4f71b54bda02913\",\n \"dstToken\": \"0x94b008aa00579c1307b0ef2c499ad98a8ce58e58\",\n \"srcChainId\": 8453,\n \"dstChainId\": 10,\n \"ownerAddress\": \"0x742d35cc6639cb8d4b5d1c5d7b8b5e2e7c0c7a8a\",\n \"amount\": {},\n \"mode\": \"\",\n \"gasLimit\": \"50000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": \"string\",\n \"path\": [\n \"string\",\n \"string\"\n ],\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"path\": [\n \"string\",\n \"string\"\n ],\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.biconomy.io", "key": "baseUrl" } ], "info": { "_postman_id": "cc226151-0f05-4fb1-99af-d8deecdf7174", "name": "Supertransaction instructions API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "A comprehensive Supertransaction API documentation", "type": "text/plain" } } }