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

import org.web3j.eth2.api.beacon.BeaconResource
import org.web3j.eth2.api.config.ConfigResource
import org.web3j.eth2.api.debug.DebugResource
import org.web3j.eth2.api.events.EventsResource
import org.web3j.eth2.api.node.NodeResource
import org.web3j.eth2.api.validator.ValidatorResource
import javax.ws.rs.Path

/**
 * Beacon API specification for the beacon node,
 * which enables users to query and participate in Ethereum 2.0 phase 0 beacon chain.
 */
@Path("/eth/v1")
interface BeaconNodeApi {

    /**
     * Set of endpoints to query beacon chain.
     */
    @get:Path("beacon")
    val beacon: BeaconResource

    /**
     * Endpoints to query chain configuration, specification, and fork schedules.
     */
    @get:Path("config")
    val config: ConfigResource

    /**
     * Set of endpoints to debug chain and shouldn't be exposed publicly.
     */
    @get:Path("debug")
    val debug: DebugResource

    /**
     * Set of endpoints to for event subscription.
     */
    @get:Path("events")
    val events: EventsResource

    /**
     * Endpoints to query node related information.
     */
    @get:Path("node")
    val node: NodeResource

    /**
     * Endpoints intended for validator clients.
     */
    @get:Path("validator")
    val validator: ValidatorResource
}