org.web3j.eth2.api.beacon.pool.AttestationsResource.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of beacon-node-api Show documentation
Web3j Eth2 Beacon API Client.
The newest version!
/*
 * Copyright 2020 Web3 Labs Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.web3j.eth2.api.beacon.pool

import org.web3j.eth2.api.schema.Attestation
import org.web3j.eth2.api.schema.BeaconResponse
import javax.ws.rs.Consumes
import javax.ws.rs.GET
import javax.ws.rs.POST
import javax.ws.rs.QueryParam
import javax.ws.rs.core.MediaType

interface AttestationsResource {

    /**
     * Get [Attestation]s from operations pool.
     *
     * Retrieves attestations known by the node but not necessarily incorporated into any block.
     *
     * @throws javax.ws.rs.InternalServerErrorException Beacon node internal error.
     */
    @GET
    fun findAll(): BeaconResponse>

    /**
     * Get [Attestation]s from operations pool.
     *
     * Retrieves attestations known by the node but not necessarily incorporated into any block.
     *
     * @throws javax.ws.rs.BadRequestException The slot could not be parsed.
     * @throws javax.ws.rs.InternalServerErrorException Beacon node internal error.
     */
    @GET
    fun findBySlot(@QueryParam("slot") slot: String): BeaconResponse>

    /**
     * Get [Attestation]s from operations pool.
     *
     * Retrieves attestations known by the node but not necessarily incorporated into any block.
     *
     * @throws javax.ws.rs.BadRequestException The committee index could not be parsed.
     * @throws javax.ws.rs.InternalServerErrorException Beacon node internal error.
     */
    @GET
    fun findByCommitteeIndex(@QueryParam("committee_index") committeeIndex: String):
            BeaconResponse>

    /**
     * Get [Attestation]s from operations pool.
     *
     * Retrieves attestations known by the node but not necessarily incorporated into any block.
     *
     * @throws javax.ws.rs.BadRequestException The slot or committee index could not be parsed.
     * @throws javax.ws.rs.InternalServerErrorException Beacon node internal error.
     */
    @GET
    fun findBySlotAndCommitteeIndex(
        @QueryParam("slot") slot: String,
        @QueryParam("committee_index") committeeIndex: String
    ): BeaconResponse>

    /**
     * Submits [Attestation] object to node. If attestation passes all validation constraints,
     * node MUST publish attestation on appropriate subnet.
     *
     * @throws javax.ws.rs.BadRequestException Invalid attestation.
     * @throws javax.ws.rs.InternalServerErrorException Beacon node internal error.
     */
    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    fun submit(body: Attestation)
}