Merge pull request #14 from lightninglabs/update-protos-0323

proto: update all protos to the latest releases

Author: jamaljsr

.prettierignore

@@ -1,6 +1,5 @@
 .github/**
 dist/**
-lib/types/**
 package-lock.json
 package.json
 README.md

lib/types/proto/autopilotrpc.ts

@@ -1 +1 @@
-export * from './lnd/autopilotrpc/autopilot';
+export * from './lnd/autopilotrpc/autopilot';

lib/types/proto/chainrpc.ts

@@ -1 +1 @@
-export * from './lnd/chainrpc/chainnotifier';
+export * from './lnd/chainrpc/chainnotifier';

lib/types/proto/faraday/faraday.ts

@@ -508,21 +508,27 @@ export interface FaradayServer {
      * Example request:
      * http://localhost:8466/v1/faraday/exchangerate
      */
-    exchangeRate(request?: DeepPartial<ExchangeRateRequest>): Promise<ExchangeRateResponse>;
+    exchangeRate(
+        request?: DeepPartial<ExchangeRateRequest>
+    ): Promise<ExchangeRateResponse>;
     /**
      * Get a report of your node's activity over a period.
      *
      * Example request:
      * http://localhost:8466/v1/faraday/nodeaudit
      */
-    nodeAudit(request?: DeepPartial<NodeAuditRequest>): Promise<NodeAuditResponse>;
+    nodeAudit(
+        request?: DeepPartial<NodeAuditRequest>
+    ): Promise<NodeAuditResponse>;
     /**
      * Get a channel close report for a specific channel.
      *
      * Example request:
      * http://localhost:8466/v1/faraday/closereport
      */
-    closeReport(request?: DeepPartial<CloseReportRequest>): Promise<CloseReportResponse>;
+    closeReport(
+        request?: DeepPartial<CloseReportRequest>
+    ): Promise<CloseReportResponse>;
 }
 
 type Builtin =
@@ -543,4 +549,3 @@ type DeepPartial<T> = T extends Builtin
     : T extends {}
     ? { [K in keyof T]?: DeepPartial<T[K]> }
     : Partial<T>;
-    

lib/types/proto/frdrpc.ts

@@ -1 +1 @@
-export * from './faraday/faraday';
+export * from './faraday/faraday';

lib/types/proto/index.ts

@@ -11,4 +11,18 @@ import * as watchtowerrpc from './watchtowerrpc';
 import * as wtclientrpc from './wtclientrpc';
 import * as looprpc from './looprpc';
 import * as poolrpc from './poolrpc';
-export { frdrpc, litrpc, autopilotrpc, chainrpc, invoicesrpc, lnrpc, routerrpc, signrpc, walletrpc, watchtowerrpc, wtclientrpc, looprpc, poolrpc };
+export {
+    frdrpc,
+    litrpc,
+    autopilotrpc,
+    chainrpc,
+    invoicesrpc,
+    lnrpc,
+    routerrpc,
+    signrpc,
+    walletrpc,
+    watchtowerrpc,
+    wtclientrpc,
+    looprpc,
+    poolrpc
+};

lib/types/proto/invoicesrpc.ts

@@ -1 +1 @@
-export * from './lnd/invoicesrpc/invoices';
+export * from './lnd/invoicesrpc/invoices';

lib/types/proto/lit/firewall.ts

@@ -138,7 +138,27 @@ export interface Action {
 }
 
 export interface Firewall {
-    listActions(request?: DeepPartial<ListActionsRequest>): Promise<ListActionsResponse>;
+    /**
+     * litcli: `actions`
+     * ListActions will return a list of actions that have been performed on the
+     * node. The actions that will be persisted depends on the value of the
+     * `--firewall.request-logger.level` config option. The default value of the
+     * option is the "interceptor" mode which will persist only the actions (with
+     * all request parameters) made with macaroons with caveats that force them
+     * to be checked by an rpc middleware interceptor. If the "all" mode is used
+     * then all actions will be persisted but only full request parameters will
+     * only be stored if the actions are interceptor actions, otherwise only the
+     * URI and timestamp of the actions will be stored. The "full" mode will
+     * persist all request data for all actions.
+     */
+    listActions(
+        request?: DeepPartial<ListActionsRequest>
+    ): Promise<ListActionsResponse>;
+    /**
+     * litcli: `privacy`
+     * PrivacyMapConversion can be used map real values to their pseudo
+     * counterpart and vice versa.
+     */
     privacyMapConversion(
         request?: DeepPartial<PrivacyMapConversionRequest>
     ): Promise<PrivacyMapConversionResponse>;
@@ -162,4 +182,3 @@ type DeepPartial<T> = T extends Builtin
     : T extends {}
     ? { [K in keyof T]?: DeepPartial<T[K]> }
     : Partial<T>;
-    

lib/types/proto/lit/lit-autopilot.ts

@@ -70,6 +70,10 @@ export interface ListAutopilotFeaturesResponse_FeaturesEntry {
 }
 
 export interface RevokeAutopilotSessionRequest {
+    /**
+     * The local static public key of the Autopilot session to be revoked.
+     * When using REST, this field must be encoded as base64url.
+     */
     localPublicKey: Uint8Array | string;
 }
 
@@ -123,15 +127,35 @@ export interface Permissions {
 }
 
 export interface Autopilot {
+    /**
+     * litcli: `autopilot features`
+     * ListAutopilotFeatures fetches all the features supported by the Autopilot
+     * server along with the rules that we need to support in order to subscribe
+     * to those features.
+     */
     listAutopilotFeatures(
         request?: DeepPartial<ListAutopilotFeaturesRequest>
     ): Promise<ListAutopilotFeaturesResponse>;
+    /**
+     * litcli: `autopilot add`
+     * AddAutopilotSession creates a new LNC session and attempts to register it
+     * with the Autopilot server.
+     */
     addAutopilotSession(
         request?: DeepPartial<AddAutopilotSessionRequest>
     ): Promise<AddAutopilotSessionResponse>;
+    /**
+     * litcli: `autopilot list`
+     * ListAutopilotSessions lists all the sessions that are of type
+     * TypeAutopilot.
+     */
     listAutopilotSessions(
         request?: DeepPartial<ListAutopilotSessionsRequest>
     ): Promise<ListAutopilotSessionsResponse>;
+    /**
+     * litcli: `autopilot revoke`
+     * RevokeAutopilotSession revokes an Autopilot session.
+     */
     revokeAutopilotSession(
         request?: DeepPartial<RevokeAutopilotSessionRequest>
     ): Promise<RevokeAutopilotSessionResponse>;
@@ -155,4 +179,3 @@ type DeepPartial<T> = T extends Builtin
     : T extends {}
     ? { [K in keyof T]?: DeepPartial<T[K]> }
     : Partial<T>;
-    

lib/types/proto/lit/lit-sessions.ts

@@ -18,12 +18,25 @@ export enum SessionState {
 }
 
 export interface AddSessionRequest {
+    /** A user assigned label for the session. */
     label: string;
+    /**
+     * The session type. This will be used during macaroon construction to
+     * determine how restrictive to make the macaroon and thus the session access.
+     */
     sessionType: SessionType;
+    /** The time at which the session should automatically be revoked. */
     expiryTimestampSeconds: string;
+    /** The address of the mailbox server that the LNC connection should use. */
     mailboxServerAddr: string;
+    /** If set to true, tls will be skipped  when connecting to the mailbox. */
     devServer: boolean;
+    /** Any custom permissions to add the session's macaroon. */
     macaroonCustomPermissions: MacaroonPermission[];
+    /**
+     * The ID of the account to associate this session with. This should only be
+     * set if the session_type is TYPE_MACAROON_ACCOUNT.
+     */
     accountId: string;
 }
 
@@ -37,34 +50,74 @@ export interface MacaroonPermission {
     /**
      * The action that is granted. If entity is set to "uri", then action must
      * be set to either:
-     *  - a particular URI to which access should be granted.
-     *  - a URI regex, in which case access will be granted to each URI that
-     *    matches the regex.
-     *  - the "***readonly***" keyword. This will result in the access being
-     *    granted to all read-only endpoints.
+     * - a particular URI to which access should be granted.
+     * - a URI regex, in which case access will be granted to each URI that
+     * matches the regex.
+     * - the "***readonly***" keyword. This will result in the access being
+     * granted to all read-only endpoints.
      */
     action: string;
 }
 
 export interface AddSessionResponse {
+    /** The session of the newly created session. */
     session: Session | undefined;
 }
 
 export interface Session {
+    /**
+     * A unique ID assigned to the session. It is derived from the session
+     * macaroon.
+     */
     id: Uint8Array | string;
+    /** A user assigned label for the session. */
     label: string;
+    /**
+     * The current state that the session is in. This will give an indication of
+     * if the session is currently usable or not.
+     */
     sessionState: SessionState;
+    /**
+     * The session type. The will given an indication of the restrictions applied
+     * to the macaroon assigned to the session.
+     */
     sessionType: SessionType;
+    /** The time at which the session will automatically be revoked. */
     expiryTimestampSeconds: string;
+    /** The address of the mailbox server that the LNC connection should use. */
     mailboxServerAddr: string;
+    /** If set to true, tls will be skipped  when connecting to the mailbox. */
     devServer: boolean;
+    /** The LNC pairing phrase in byte form. */
     pairingSecret: Uint8Array | string;
+    /** The LNC pairing phrase in mnemonic form. */
     pairingSecretMnemonic: string;
+    /**
+     * The long term, local static public key used by this node for the LNC
+     * connection.
+     */
     localPublicKey: Uint8Array | string;
+    /**
+     * The long term, remote static public key used by the remote party for the
+     * LNC connection.
+     */
     remotePublicKey: Uint8Array | string;
+    /** The time at which the session was created. */
     createdAt: string;
+    /**
+     * The recipe used for creating a macaroon to use with this session. This will
+     * be closely linked to the session type.
+     */
     macaroonRecipe: MacaroonRecipe | undefined;
+    /**
+     * If the session is for a specific account, then this will be the account ID
+     * it is associated with.
+     */
     accountId: string;
+    /**
+     * If this session is for Autopilot use, then this will be the set of features
+     * that the session can be used for along with the rules for each feature.
+     */
     autopilotFeatureInfo: { [key: string]: RulesMap };
     /**
      * The unix timestamp indicating the time at which the session was revoked.
@@ -83,17 +136,24 @@ export interface Session_AutopilotFeatureInfoEntry {
 }
 
 export interface MacaroonRecipe {
+    /** A list of permissions that should be included in the macaroon. */
     permissions: MacaroonPermission[];
+    /** A list of caveats to add to the macaroon. */
     caveats: string[];
 }
 
 export interface ListSessionsRequest {}
 
 export interface ListSessionsResponse {
+    /** A list of sessions. */
     sessions: Session[];
 }
 
 export interface RevokeSessionRequest {
+    /**
+     * The local static key of the session to be revoked.
+     * When using REST, this field must be encoded as base64url.
+     */
     localPublicKey: Uint8Array | string;
 }
 
@@ -170,22 +230,31 @@ export interface ChannelPolicyBounds {
 }
 
 export interface OffChainBudget {
+    /** The maximum amount that can be spent off-chain excluding fees. */
     maxAmtMsat: string;
+    /** The maximum amount that can be spent off-chain on fees. */
     maxFeesMsat: string;
 }
 
 export interface OnChainBudget {
+    /** The maximum amount that can be spent on-chain including fees. */
     absoluteAmtSats: string;
+    /** The maximum amount that can be spent on-chain in fees. */
     maxSatPerVByte: string;
 }
 
 export interface SendToSelf {}
 
 export interface ChannelRestrict {
+    /**
+     * A list of channel IDs that the Autopilot should _not_ perform any actions
+     * on.
+     */
     channelIds: string[];
 }
 
 export interface PeerRestrict {
+    /** A list of peer IDs that the Autopilot should _not_ perform any actions on. */
     peerIds: string[];
 }
 
@@ -194,8 +263,25 @@ export interface PeerRestrict {
  * daemon's session system.
  */
 export interface Sessions {
-    addSession(request?: DeepPartial<AddSessionRequest>): Promise<AddSessionResponse>;
-    listSessions(request?: DeepPartial<ListSessionsRequest>): Promise<ListSessionsResponse>;
+    /**
+     * litcli: `sessions add`
+     * AddSession adds and starts a new LNC session.
+     */
+    addSession(
+        request?: DeepPartial<AddSessionRequest>
+    ): Promise<AddSessionResponse>;
+    /**
+     * litcli: `sessions list`
+     * ListSessions returns all sessions known to the session store.
+     */
+    listSessions(
+        request?: DeepPartial<ListSessionsRequest>
+    ): Promise<ListSessionsResponse>;
+    /**
+     * litcli: `sessions revoke`
+     * RevokeSession revokes a single session and also stops it if it is currently
+     * active.
+     */
     revokeSession(
         request?: DeepPartial<RevokeSessionRequest>
     ): Promise<RevokeSessionResponse>;
@@ -219,4 +305,3 @@ type DeepPartial<T> = T extends Builtin
     : T extends {}
     ? { [K in keyof T]?: DeepPartial<T[K]> }
     : Partial<T>;
-