org.web3j.eth2.api.debug.StatesResource.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.debug

import org.web3j.eth2.api.schema.BeaconResponse
import org.web3j.eth2.api.schema.BeaconState
import org.web3j.eth2.api.schema.NamedStateId
import javax.ws.rs.GET
import javax.ws.rs.Path
import javax.ws.rs.PathParam

interface StatesResource {
    /**
     * Returns full [BeaconState] object for given state ID.
     *
     * @param stateId State identifier. Can be one of: `head` (canonical head in node's view),
     * `genesis`, `finalized`, `justified`, ``, ``.
     *
     * @throws javax.ws.rs.BadRequestException Invalid state ID.
     * @throws javax.ws.rs.InternalServerErrorException Beacon node internal error.
     */
    @GET
    @Path("{state_id}")
    fun findById(@PathParam("state_id") stateId: String): BeaconResponse

    /**
     * Returns full [BeaconState] object for given state ID.
     *
     * @param stateId State identifier. Can be one of: `head` (canonical head in node's view),
     * `genesis`, `finalized`, `justified`, ``, ``.
     *
     * @throws javax.ws.rs.BadRequestException Invalid state ID.
     * @throws javax.ws.rs.InternalServerErrorException Beacon node internal error.
     */
    @GET
    @Path("{state_id}")
    fun findById(@PathParam("state_id") stateId: NamedStateId): BeaconResponse
}