Create bucket

Create a new Atlantic bucket for grouping multiple queries into a single on-chain verification via Applicative Recursion.

POST /buckets

Create a new Atlantic bucket.

cURL

curl --request POST \
  --url https://atlantic.api.herodotus.cloud/buckets \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "externalId": null,
  "nodeWidth": null,
  "aggregatorParams": null,
  "mockProof": false
}
'

import requests

url = "https://atlantic.api.herodotus.cloud/buckets"

payload = {
    "externalId": None,
    "nodeWidth": None,
    "aggregatorParams": None,
    "mockProof": False
}
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({externalId: null, nodeWidth: null, aggregatorParams: null, mockProof: false})
};

fetch('https://atlantic.api.herodotus.cloud/buckets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://atlantic.api.herodotus.cloud/buckets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'externalId' => null,
    'nodeWidth' => null,
    'aggregatorParams' => null,
    'mockProof' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://atlantic.api.herodotus.cloud/buckets"

	payload := strings.NewReader("{\n  \"externalId\": null,\n  \"nodeWidth\": null,\n  \"aggregatorParams\": null,\n  \"mockProof\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://atlantic.api.herodotus.cloud/buckets")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": null,\n  \"nodeWidth\": null,\n  \"aggregatorParams\": null,\n  \"mockProof\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://atlantic.api.herodotus.cloud/buckets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": null,\n  \"nodeWidth\": null,\n  \"aggregatorParams\": null,\n  \"mockProof\": false\n}"

response = http.request(request)
puts response.read_body

200

{
  "atlanticBucket": {
    "id": "<string>",
    "externalId": "<string>",
    "aggregatorParams": "<string>",
    "nodeWidth": -1,
    "leaves": -1,
    "mockProof": true,
    "projectId": "<string>",
    "createdByClient": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "MISSING_API_KEY"
}

{}

Authorizations

api-key · string · header · required

Query Parameters

apiKey · string

Body

application/json

aggregatorVersion · enum<string> · required

Available options: snos_aggregator_0.13.3, snos_aggregator_0.13.4, snos_aggregator_0.14.0, snos_aggregator_0.14.1

externalId · string | null

nodeWidth · number | null

aggregatorParams · object | null

Show child attributes

mockProof · boolean | null · default: false

Response

200

application/json

Default Response

atlanticBucket · object · required

Show child attributes