flashbots-cli/oclif.manifest.json

Flashbots CLI tool.

{"version":"1.0.3","commands":{"bundleCache":{"id":"bundleCache","description":"Add txs to a bundle one at a time. \n  Specify [BUNDLE_ID] AND [RAW_TX] to add a new transaction to a bundle. \n  To get the current cached bundle, only set [BUNDLE_ID].","strict":true,"pluginName":"flashbots-cli","pluginAlias":"flashbots-cli","pluginType":"core","aliases":[],"examples":["# Add a transaction to a bundle\n<%= config.bin %> <%= command.id %> 5b479f88-01ca 0x02f8d30182024...","# Get transactions in a bundle\n<%= config.bin %> <%= command.id %> 5b479f88-01ca"],"flags":{},"args":[{"name":"bundle_id","description":"Unique ID to identify your bundle (UUIDv4 recommended)","required":true},{"name":"raw_tx","description":"Raw signed transaction (0x-prefixed hex data)"}]},"cancelPrivateTransaction":{"id":"cancelPrivateTransaction","description":"Cancel a pending private transaction.","strict":true,"pluginName":"flashbots-cli","pluginAlias":"flashbots-cli","pluginType":"core","aliases":[],"examples":["# Cancel a pending private transaction\n<%= config.bin %> <%= command.id %> 0x1030b9b9c685b0c63543ce2b14d286b3dcc82852a9d3404e3f1aaaf5108bb73c"],"flags":{},"args":[{"name":"tx_hash","description":"Transaction hash of private tx to be cancelled","required":true}]},"getBundleStats":{"id":"getBundleStats","description":"Get info about a bundle.","strict":true,"pluginName":"flashbots-cli","pluginAlias":"flashbots-cli","pluginType":"core","aliases":[],"examples":["# Get bundle stats for block 14798035\n<%= config.bin %> <%= command.id %> 0x47b1f5ea1b924acd88459b2e4f0ccfd2326ca0a134b982c1bc4a97e9002ff051 14798035"],"flags":{},"args":[{"name":"bundle_hash","description":"Bundle hash returned by simulateBundle","required":true},{"name":"target_block","description":"Block in which the bundle was targeted/executed","required":true}]},"getConflictingBundle":{"id":"getConflictingBundle","description":"Get information about competing bundles.","strict":true,"pluginName":"flashbots-cli","pluginAlias":"flashbots-cli","pluginType":"core","aliases":[],"examples":["# Get conflicting bundles (if any)\n<%= config.bin %> <%= command.id %> '[\"0x02f8d37c496de...\", \"0x02f8d38a7bf47...\"]' 14797973","# Get conflicting bundles (if any) and skip gas pricing calculations\n<%= config.bin %> <%= command.id %> -g '[\"0x02f8d37c496de...\", \"0x02f8d38a7bf47...\"]' 14797973"],"flags":{"ignore-gas-pricing":{"name":"ignore-gas-pricing","type":"boolean","char":"g","description":"Gets conflicting bundle(s) without calculating gas pricing data","allowNo":false}},"args":[{"name":"bundle_txs","description":"JSON string-encoded array of raw signed transactions (0x-prefixed)","required":true},{"name":"target_block","description":"Block in which the conflicting bundle was mined","required":true}],"_globalFlags":{}},"getUserStats":{"id":"getUserStats","description":"Get Flashbots reputation data for your account. \n  You may optionally specify a private key, otherwise the environment variable FB_AUTH_SIGNER will be used.\n  Note: your private key is not sent over the web. It is only used to sign a message which proves you own the account.","strict":true,"pluginName":"flashbots-cli","pluginAlias":"flashbots-cli","pluginType":"core","aliases":[],"examples":["# Get user stats about hardhat account 0\n<%= config.bin %> <%= command.id %> 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"],"flags":{},"args":[{"name":"signer_key","description":"Private key used to sign bundles","required":false}]},"sendBundle":{"id":"sendBundle","description":"Send a bundle to the Flashbots relay. \n  All flags are optional.","strict":true,"pluginName":"flashbots-cli","pluginAlias":"flashbots-cli","pluginType":"core","aliases":[],"examples":["# Send a bundle in the next available block\n<%= config.bin %> <%= command.id %> '[\"0x02f8d37c496de...\", \"0x02f8d38a7bf47...\"]'","# Send a bundle with specific timestamp(s)\n<%= config.bin %> <%= command.id %> '[\"0x02f8d37c496de...\", \"0x02f8d38a7bf47...\"]' --min-timestamp 1652856500 --max-timestamp 1652856700","# Send a bundle with reverting transactions\n<%= config.bin %> <%= command.id %> '[\"0x02f8d37c496de...\", \"0x02f8d38a7bf47...\"]' --reverting-tx 0x60929406276058bc757bc84a576857e6a6118566690fd3604d4f1cdb5ebd89d3 --reverting-tx 0x548efb5c5de7df6d76f8aca4391def510fa575c81dd588d2ff4e8fc5a7c4eb79"],"flags":{"target-block":{"name":"target-block","type":"option","char":"b","description":"Block to target for bundle submission (default latest+1)","multiple":false},"min-timestamp":{"name":"min-timestamp","type":"option","description":"Minimum timestamp at which this bundle can be included","multiple":false},"max-timestamp":{"name":"max-timestamp","type":"option","description":"Maximum timestamp at which this bundle can be included","multiple":false},"reverting-tx":{"name":"reverting-tx","type":"option","description":"Tx hash that is allowed to revert, can be set multiple times","multiple":true}},"args":[{"name":"bundle_txs","description":"JSON string-encoded array of raw signed transactions (0x-prefixed)","required":true}],"exampleBundle":"'[\"0x02f8d37c496de...\", \"0x02f8d38a7bf47...\"]'","_globalFlags":{}},"sendPrivateTransaction":{"id":"sendPrivateTransaction","description":"Send a private transaction to Flashbots miners.","strict":true,"pluginName":"flashbots-cli","pluginAlias":"flashbots-cli","pluginType":"core","aliases":[],"examples":["signedTx=0xf87080853010b8720083010d8894eaa314eb4cc5a16458ba7a94e759252f4fda9ea4808b6c6a7a792077616e6b657f1ba05bf41e534c768493a3a84567e9acca5fdec73164d54b0cd21e4cdd94a11af29ba0591f06662aa673b645378774ee4a665fdf8a7ec8e0418ec0ac0d24f915bc8516","# Send a private transaction for the next 25 blocks\n<%= config.bin %> <%= command.id %> $signedTx","# Send a private transaction up to block 15161558 (note: 25 blocks is still the max duration)\n<%= config.bin %> <%= command.id %> $signedTx --max-block-number 15161558","# Send a private transaction with a custom simulation timestamp\n<%= config.bin %> <%= command.id %> $signedTx --simulation-timestamp 1658080039"],"flags":{"max-block-number":{"name":"max-block-number","type":"option","char":"b","description":"Highest block number to allow transaction to be included","multiple":false},"simulation-timestamp":{"name":"simulation-timestamp","type":"option","char":"t","description":"Timestamp to use for transaction simulation","multiple":false}},"args":[{"name":"signed_transaction","description":"Raw signed transaction to send","required":true}],"_globalFlags":{}},"simulateBundle":{"id":"simulateBundle","description":"Simulate a bundle.","strict":true,"pluginName":"flashbots-cli","pluginAlias":"flashbots-cli","pluginType":"core","aliases":[],"examples":["# Simulate a bundle in the current block\n<%= config.bin %> <%= command.id %> '[\"0x02f8d37c496de...\", \"0x02f8d38a7bf47...\"]'","# Simulate a bundle against a specific timestamp\n<%= config.bin %> <%= command.id %> '[\"0x02f8d37c496de...\", \"0x02f8d38a7bf47...\"]' --block-timestamp 1652859017","# Simulate a bundle against a block tag\n<%= config.bin %> <%= command.id %> '[\"0x02f8d37c496de...\", \"0x02f8d38a7bf47...\"]' --state-block-tag latest"],"flags":{"target-block":{"name":"target-block","type":"option","char":"b","description":"Block to target for bundle submission","multiple":false},"state-block-tag":{"name":"state-block-tag","type":"option","description":"Block tag which specifies block state to execute simulation against","multiple":false},"block-timestamp":{"name":"block-timestamp","type":"option","description":"Timestamp to execute simulation against","multiple":false}},"args":[{"name":"bundle_txs","description":"JSON string-encoded array of raw signed transactions (0x-prefixed)","required":true}],"_globalFlags":{}},"uuid":{"id":"uuid","description":"Generate a random UUID.","strict":true,"pluginName":"flashbots-cli","pluginAlias":"flashbots-cli","pluginType":"core","aliases":[],"flags":{},"args":[]}}}