@lodestar/api 1.20.0-dev.f6d3bce802 → 1.20.0-dev.fe23f68998

package/lib/keymanager/routes.d.ts

@@ -1,7 +1,8 @@
+import { ContainerType, ValueOf } from "@chainsafe/ssz";
+import { ChainForkConfig } from "@lodestar/config";
 import { Epoch, phase0 } from "@lodestar/types";
-import { ApiClientResponse } from "../interfaces.js";
-import { HttpStatusCode } from "../utils/client/httpStatusCode.js";
-import { ReturnTypes, RoutesData, ReqSerializers, ReqEmpty } from "../utils/index.js";
+import { Endpoint, RouteDefinitions } from "../utils/index.js";
+import { EmptyArgs, EmptyMeta, EmptyRequest, EmptyResponseData } from "../utils/codecs.js";
 export declare enum ImportStatus {
     /** Keystore successfully decrypted and imported to keymanager permanent storage */
     imported = "imported",
@@ -44,22 +45,26 @@ export type ResponseStatus<Status> = {
     status: Status;
     message?: string;
 };
-export type FeeRecipientData = {
-    pubkey: string;
-    ethaddress: string;
-};
-export type GraffitiData = {
-    pubkey: string;
-    graffiti: string;
-};
-export type GasLimitData = {
-    pubkey: string;
-    gasLimit: number;
-};
-export type BuilderBoostFactorData = {
-    pubkey: string;
-    builderBoostFactor: bigint;
-};
+export declare const FeeRecipientDataType: ContainerType<{
+    pubkey: import("@lodestar/types").StringType<string>;
+    ethaddress: import("@lodestar/types").StringType<string>;
+}>;
+export declare const GraffitiDataType: ContainerType<{
+    pubkey: import("@lodestar/types").StringType<string>;
+    graffiti: import("@lodestar/types").StringType<string>;
+}>;
+export declare const GasLimitDataType: ContainerType<{
+    pubkey: import("@lodestar/types").StringType<string>;
+    gasLimit: import("@chainsafe/ssz").UintNumberType;
+}>;
+export declare const BuilderBoostFactorDataType: ContainerType<{
+    pubkey: import("@lodestar/types").StringType<string>;
+    builderBoostFactor: import("@chainsafe/ssz").UintBigintType;
+}>;
+export type FeeRecipientData = ValueOf<typeof FeeRecipientDataType>;
+export type GraffitiData = ValueOf<typeof GraffitiDataType>;
+export type GasLimitData = ValueOf<typeof GasLimitDataType>;
+export type BuilderBoostFactorData = ValueOf<typeof BuilderBoostFactorDataType>;
 export type SignerDefinition = {
     pubkey: PubkeyHex;
     /**
@@ -70,6 +75,7 @@ export type SignerDefinition = {
     /** The signer associated with this pubkey cannot be deleted from the API */
     readonly: boolean;
 };
+export type RemoteSignerDefinition = Pick<SignerDefinition, "pubkey" | "url">;
 /**
  * JSON serialized representation of a single keystore in EIP-2335: BLS12-381 Keystore format.
  * ```
@@ -91,41 +97,57 @@ export type SlashingProtectionData = string;
  * ```
  */
 export type PubkeyHex = string;
-export type Api = {
+/**
+ * An address on the execution (Ethereum 1) network.
+ * ```
+ * "0xAbcF8e0d4e9587369b2301D0790347320302cc09"
+ * ```
+ */
+export type EthAddress = string;
+/**
+ * Arbitrary data to set in the graffiti field of BeaconBlockBody
+ * ```
+ * "plain text value"
+ * ```
+ */
+export type Graffiti = string;
+export type Endpoints = {
     /**
      * List all validating pubkeys known to and decrypted by this keymanager binary
      *
      * https://github.com/ethereum/keymanager-APIs/blob/0c975dae2ac6053c8245ebdb6a9f27c2f114f407/keymanager-oapi.yaml
      */
-    listKeys(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: {
-                validatingPubkey: PubkeyHex;
-                /** The derivation path (if present in the imported keystore) */
-                derivationPath?: string;
-                /** The key associated with this pubkey cannot be deleted from the API */
-                readonly?: boolean;
-            }[];
-        };
-    }>>;
+    listKeys: Endpoint<"GET", EmptyArgs, EmptyRequest, {
+        validatingPubkey: PubkeyHex;
+        /** The derivation path (if present in the imported keystore) */
+        derivationPath?: string;
+        /** The key associated with this pubkey cannot be deleted from the API */
+        readonly?: boolean;
+    }[], EmptyMeta>;
     /**
      * Import keystores generated by the Eth2.0 deposit CLI tooling. `passwords[i]` must unlock `keystores[i]`.
      *
      * Users SHOULD send slashing_protection data associated with the imported pubkeys. MUST follow the format defined in
      * EIP-3076: Slashing Protection Interchange Format.
      *
-     * @param keystores JSON-encoded keystore files generated with the Launchpad
-     * @param passwords Passwords to unlock imported keystore files. `passwords[i]` must unlock `keystores[i]`
-     * @param slashingProtection Slashing protection data for some of the keys of `keystores`
-     * @returns Status result of each `request.keystores` with same length and order of `request.keystores`
+     * Returns status result of each `request.keystores` with same length and order of `request.keystores`
      *
      * https://github.com/ethereum/keymanager-APIs/blob/0c975dae2ac6053c8245ebdb6a9f27c2f114f407/keymanager-oapi.yaml
      */
-    importKeystores(keystoresStr: KeystoreStr[], passwords: string[], slashingProtectionStr?: SlashingProtectionData): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: ResponseStatus<ImportStatus>[];
+    importKeystores: Endpoint<"POST", {
+        /** JSON-encoded keystore files generated with the Launchpad */
+        keystores: KeystoreStr[];
+        /** Passwords to unlock imported keystore files. `passwords[i]` must unlock `keystores[i]` */
+        passwords: string[];
+        /** Slashing protection data for some of the keys of `keystores` */
+        slashingProtection?: SlashingProtectionData;
+    }, {
+        body: {
+            keystores: KeystoreStr[];
+            passwords: string[];
+            slashing_protection?: SlashingProtectionData;
         };
-    }>>;
+    }, ResponseStatus<ImportStatus>[], EmptyMeta>;
     /**
      * DELETE must delete all keys from `request.pubkeys` that are known to the keymanager and exist in its
      * persistent storage. Additionally, DELETE must fetch the slashing protection data for the requested keys from
@@ -142,214 +164,170 @@ export type Api = {
      * Slashing protection data must only be returned for keys from `request.pubkeys` for which a
      * `deleted` or `not_active` status is returned.
      *
-     * @param pubkeys List of public keys to delete.
-     * @returns Deletion status of all keys in `request.pubkeys` in the same order.
+     * Returns deletion status of all keys in `request.pubkeys` in the same order.
      *
      * https://github.com/ethereum/keymanager-APIs/blob/0c975dae2ac6053c8245ebdb6a9f27c2f114f407/keymanager-oapi.yaml
      */
-    deleteKeys(pubkeysHex: string[]): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: ResponseStatus<DeletionStatus>[];
-            slashingProtection: SlashingProtectionData;
+    deleteKeys: Endpoint<"DELETE", {
+        /** List of public keys to delete */
+        pubkeys: PubkeyHex[];
+    }, {
+        body: {
+            pubkeys: string[];
         };
-    }>>;
+    }, {
+        statuses: ResponseStatus<DeletionStatus>[];
+        slashingProtection: SlashingProtectionData;
+    }, EmptyMeta>;
     /**
      * List all remote validating pubkeys known to this validator client binary
      */
-    listRemoteKeys(): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: SignerDefinition[];
-        };
-    }>>;
+    listRemoteKeys: Endpoint<"GET", EmptyArgs, EmptyRequest, SignerDefinition[], EmptyMeta>;
     /**
      * Import remote keys for the validator client to request duties for
      */
-    importRemoteKeys(remoteSigners: Pick<SignerDefinition, "pubkey" | "url">[]): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: ResponseStatus<ImportRemoteKeyStatus>[];
-        };
-    }>>;
-    deleteRemoteKeys(pubkeys: PubkeyHex[]): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: ResponseStatus<DeleteRemoteKeyStatus>[];
-        };
-    }>>;
-    listFeeRecipient(pubkey: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: FeeRecipientData;
-        };
-    }>>;
-    setFeeRecipient(pubkey: string, ethaddress: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-        [HttpStatusCode.NO_CONTENT]: void;
-    }, HttpStatusCode.UNAUTHORIZED | HttpStatusCode.FORBIDDEN | HttpStatusCode.NOT_FOUND>>;
-    deleteFeeRecipient(pubkey: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-        [HttpStatusCode.NO_CONTENT]: void;
-    }, HttpStatusCode.UNAUTHORIZED | HttpStatusCode.FORBIDDEN | HttpStatusCode.NOT_FOUND>>;
-    listGraffiti(pubkey: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: GraffitiData;
-        };
-    }>>;
-    setGraffiti(pubkey: string, graffiti: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-        [HttpStatusCode.NO_CONTENT]: void;
-    }, HttpStatusCode.UNAUTHORIZED | HttpStatusCode.FORBIDDEN | HttpStatusCode.NOT_FOUND>>;
-    deleteGraffiti(pubkey: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-        [HttpStatusCode.NO_CONTENT]: void;
-    }, HttpStatusCode.UNAUTHORIZED | HttpStatusCode.FORBIDDEN | HttpStatusCode.NOT_FOUND>>;
-    getGasLimit(pubkey: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: GasLimitData;
-        };
-    }>>;
-    setGasLimit(pubkey: string, gasLimit: number): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-        [HttpStatusCode.NO_CONTENT]: void;
-    }, HttpStatusCode.UNAUTHORIZED | HttpStatusCode.FORBIDDEN | HttpStatusCode.NOT_FOUND>>;
-    deleteGasLimit(pubkey: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-        [HttpStatusCode.NO_CONTENT]: void;
-    }, HttpStatusCode.UNAUTHORIZED | HttpStatusCode.FORBIDDEN | HttpStatusCode.NOT_FOUND>>;
-    getBuilderBoostFactor(pubkey: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: BuilderBoostFactorData;
+    importRemoteKeys: Endpoint<"POST", {
+        remoteSigners: RemoteSignerDefinition[];
+    }, {
+        body: {
+            remote_keys: RemoteSignerDefinition[];
         };
-    }>>;
-    setBuilderBoostFactor(pubkey: string, builderBoostFactor: bigint): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-        [HttpStatusCode.NO_CONTENT]: void;
-    }, HttpStatusCode.UNAUTHORIZED | HttpStatusCode.FORBIDDEN | HttpStatusCode.NOT_FOUND>>;
-    deleteBuilderBoostFactor(pubkey: string): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: void;
-        [HttpStatusCode.NO_CONTENT]: void;
-    }, HttpStatusCode.UNAUTHORIZED | HttpStatusCode.FORBIDDEN | HttpStatusCode.NOT_FOUND>>;
+    }, ResponseStatus<ImportRemoteKeyStatus>[], EmptyMeta>;
     /**
-     * Create a signed voluntary exit message for an active validator, identified by a public key known to the validator
-     * client. This endpoint returns a `SignedVoluntaryExit` object, which can be used to initiate voluntary exit via the
-     * beacon node's [submitPoolVoluntaryExit](https://ethereum.github.io/beacon-APIs/#/Beacon/submitPoolVoluntaryExit) endpoint.
-     *
-     * @param pubkey Public key of an active validator known to the validator client
-     * @param epoch Minimum epoch for processing exit. Defaults to the current epoch if not set
-     * @returns Signed voluntary exit message
+     * DELETE must delete all keys from `request.pubkeys` that are known to the validator client and exist in its
+     * persistent storage.
      *
-     * https://github.com/ethereum/keymanager-APIs/blob/7105e749e11dd78032ea275cc09bf62ecd548fca/keymanager-oapi.yaml
+     * DELETE should never return a 404 response, even if all pubkeys from `request.pubkeys` have no existing keystores.
      */
-    signVoluntaryExit(pubkey: PubkeyHex, epoch?: Epoch): Promise<ApiClientResponse<{
-        [HttpStatusCode.OK]: {
-            data: phase0.SignedVoluntaryExit;
-        };
-    }, HttpStatusCode.UNAUTHORIZED | HttpStatusCode.FORBIDDEN | HttpStatusCode.NOT_FOUND>>;
-};
-export declare const routesData: RoutesData<Api>;
-export type ReqTypes = {
-    listKeys: ReqEmpty;
-    importKeystores: {
-        body: {
-            keystores: KeystoreStr[];
-            passwords: string[];
-            slashing_protection?: SlashingProtectionData;
-        };
-    };
-    deleteKeys: {
+    deleteRemoteKeys: Endpoint<"DELETE", {
+        pubkeys: PubkeyHex[];
+    }, {
         body: {
             pubkeys: string[];
         };
-    };
-    listRemoteKeys: ReqEmpty;
-    importRemoteKeys: {
-        body: {
-            remote_keys: Pick<SignerDefinition, "pubkey" | "url">[];
-        };
-    };
-    deleteRemoteKeys: {
-        body: {
-            pubkeys: string[];
-        };
-    };
-    listFeeRecipient: {
+    }, ResponseStatus<DeleteRemoteKeyStatus>[], EmptyMeta>;
+    listFeeRecipient: Endpoint<"GET", {
+        pubkey: PubkeyHex;
+    }, {
         params: {
             pubkey: string;
         };
-    };
-    setFeeRecipient: {
+    }, FeeRecipientData, EmptyMeta>;
+    setFeeRecipient: Endpoint<"POST", {
+        pubkey: PubkeyHex;
+        ethaddress: EthAddress;
+    }, {
         params: {
             pubkey: string;
         };
         body: {
             ethaddress: string;
         };
-    };
-    deleteFeeRecipient: {
+    }, EmptyResponseData, EmptyMeta>;
+    deleteFeeRecipient: Endpoint<"DELETE", {
+        pubkey: PubkeyHex;
+    }, {
         params: {
             pubkey: string;
         };
-    };
-    listGraffiti: {
+    }, EmptyResponseData, EmptyMeta>;
+    getGraffiti: Endpoint<"GET", {
+        pubkey: PubkeyHex;
+    }, {
         params: {
             pubkey: string;
         };
-    };
-    setGraffiti: {
+    }, GraffitiData, EmptyMeta>;
+    setGraffiti: Endpoint<"POST", {
+        pubkey: PubkeyHex;
+        graffiti: Graffiti;
+    }, {
         params: {
             pubkey: string;
         };
         body: {
             graffiti: string;
         };
-    };
-    deleteGraffiti: {
+    }, EmptyResponseData, EmptyMeta>;
+    deleteGraffiti: Endpoint<"DELETE", {
+        pubkey: PubkeyHex;
+    }, {
         params: {
             pubkey: string;
         };
-    };
-    getGasLimit: {
+    }, EmptyResponseData, EmptyMeta>;
+    getGasLimit: Endpoint<"GET", {
+        pubkey: PubkeyHex;
+    }, {
         params: {
             pubkey: string;
         };
-    };
-    setGasLimit: {
+    }, GasLimitData, EmptyMeta>;
+    setGasLimit: Endpoint<"POST", {
+        pubkey: PubkeyHex;
+        gasLimit: number;
+    }, {
         params: {
             pubkey: string;
         };
         body: {
             gas_limit: string;
         };
-    };
-    deleteGasLimit: {
+    }, EmptyResponseData, EmptyMeta>;
+    deleteGasLimit: Endpoint<"DELETE", {
+        pubkey: PubkeyHex;
+    }, {
         params: {
             pubkey: string;
         };
-    };
-    getBuilderBoostFactor: {
+    }, EmptyResponseData, EmptyMeta>;
+    getBuilderBoostFactor: Endpoint<"GET", {
+        pubkey: PubkeyHex;
+    }, {
         params: {
             pubkey: string;
         };
-    };
-    setBuilderBoostFactor: {
+    }, BuilderBoostFactorData, EmptyMeta>;
+    setBuilderBoostFactor: Endpoint<"POST", {
+        pubkey: PubkeyHex;
+        builderBoostFactor: bigint;
+    }, {
         params: {
             pubkey: string;
         };
         body: {
             builder_boost_factor: string;
         };
-    };
-    deleteBuilderBoostFactor: {
+    }, EmptyResponseData, EmptyMeta>;
+    deleteBuilderBoostFactor: Endpoint<"DELETE", {
+        pubkey: PubkeyHex;
+    }, {
         params: {
             pubkey: string;
         };
-    };
-    signVoluntaryExit: {
+    }, EmptyResponseData, EmptyMeta>;
+    /**
+     * Create a signed voluntary exit message for an active validator, identified by a public key known to the validator
+     * client. This endpoint returns a `SignedVoluntaryExit` object, which can be used to initiate voluntary exit via the
+     * beacon node's [submitPoolVoluntaryExit](https://ethereum.github.io/beacon-APIs/#/Beacon/submitPoolVoluntaryExit) endpoint.
+     *
+     * Returns the signed voluntary exit message
+     *
+     * https://github.com/ethereum/keymanager-APIs/blob/7105e749e11dd78032ea275cc09bf62ecd548fca/keymanager-oapi.yaml
+     */
+    signVoluntaryExit: Endpoint<"POST", {
+        /** Public key of an active validator known to the validator client */
+        pubkey: PubkeyHex;
+        /** Minimum epoch for processing exit. Defaults to the current epoch if not set */
+        epoch?: Epoch;
+    }, {
         params: {
             pubkey: string;
         };
         query: {
             epoch?: number;
         };
-    };
+    }, phase0.SignedVoluntaryExit, EmptyMeta>;
 };
-export declare function getReqSerializers(): ReqSerializers<Api, ReqTypes>;
-export declare function getReturnTypes(): ReturnTypes<Api>;
+export declare function getDefinitions(_config: ChainForkConfig): RouteDefinitions<Endpoints>;
 //# sourceMappingURL=routes.d.ts.map