1. Providers
  2. Template Searcher Documentation


Template Searcher Documentation

Once you’re up and ready with an instance of Boost, we recommend you create a set of documentation for searchers to easily connect to you. The following is a standard template you can fill in with your network configurations.

Searcher Documentation

Builder Hints

Builder hints are metadata details about a block builders currently built template, below is an example metadata payload from a Mainnet node running Boost.

    "timestamp":"Tue, 11 Jul 2023 17:27:11 UTC",


Builder Details

Builder Address is <Insert-Your-Builder-Address-Here>

Builder Endpoint is <Insert-Your-Builder-Endpoint-Here>

Registration Process

Step 1. First construct the Authentication Token.

The Authentication Token is similar to Flashbots Authentication Token here, but with a fixed payload of the builder address.

The Authentication is passed in as a header: X-Primev-Signature, however instead of signing an arbitrary payload, the signature is made for your target builder address, your consumers wallet address is passed as the prefix: <User Address>:<Signature(Builder Address)>

Here is a go snippet to construct the token for our service:

        msg := <Insert-Your-Builder-Address-Here> // Searchers can retrieve this from the builder info 
hash := crypto.Keccak256Hash([]byte(msg)).Hex()
signature, err := crypto.Sign(accounts.TextHash(hash), searcherPrivateKey) // We use an EIP 
token := crypto.PubkeyToAddress(searcherPrivateKey.PublicKey).Hex() + ":" + hexutil.Encode(sig)


Step 2. Use this token to Receive a special commitment from our Builder

Make a GET request with X-Primev-Signature: <token> to the /authorization endpoint. You should receive back a payload as follows:

"commitment": "0xabc"


Step 3. Connect to the Builder via WebSockets

Make a GET Request X-Primev-Signature: <token> to the /ws endpoint

Congrats! You should be connected!