Export types

kadena-community · Aug 21, 2023 · d938330 · d938330
1 parent 9871095
commit d938330
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 7 deletions.
diff --git a/packages/libs/client/etc/client.api.md b/packages/libs/client/etc/client.api.md
@@ -30,13 +30,9 @@ export { ChainId }
 // @public
 export const createClient: ICreateClient;
 
-// Warning: (ae-forgotten-export) The symbol "IEckoSignFunction" needs to be exported by the entry point index.d.ts
-//
 // @public
 export function createEckoWalletQuicksign(): IEckoSignFunction;
 
-// Warning: (ae-forgotten-export) The symbol "IEckoSignSingleFunction" needs to be exported by the entry point index.d.ts
-//
 // @public
 export function createEckoWalletSign(): IEckoSignSingleFunction;
 
@@ -102,6 +98,22 @@ export { ICommand }
 
 export { ICommandResult }
 
+// @public
+export interface ICommonEckoFunctions {
+    // Warning: (ae-forgotten-export) The symbol "connect" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    connect: typeof connect;
+    // Warning: (ae-forgotten-export) The symbol "isConnected" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    isConnected: typeof isConnected;
+    // Warning: (ae-forgotten-export) The symbol "isInstalled" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    isInstalled: typeof isInstalled;
+}
+
 // @public
 export interface IContinuationPayloadObject {
     // (undocumented)
@@ -123,6 +135,14 @@ export interface ICreateClient {
     }) => string): IClient;
 }
 
+// @public
+export interface IEckoSignFunction extends ISignFunction, ICommonEckoFunctions {
+}
+
+// @public
+export interface IEckoSignSingleFunction extends ISingleSignFunction, ICommonEckoFunctions {
+}
+
 // @public
 export interface IExecutionPayloadObject {
     // (undocumented)

diff --git a/packages/libs/client/src/signing/ISignFunction.ts b/packages/libs/client/src/signing/ISignFunction.ts
@@ -1,15 +1,15 @@
 import { ICommand, IUnsignedCommand } from '@kadena/types';
 
 /**
- * Interface to use when writing a singing function that accepts multiple transactions
+ * Interface to use when writing a signing function that accepts a single transaction
  * @public
  */
 export interface ISingleSignFunction {
   (transaction: IUnsignedCommand): Promise<ICommand | IUnsignedCommand>;
 }
 
 /**
- * Interface to use when writing a singing function that accepts multiple transactions
+ * Interface to use when writing a signing function that accepts multiple transactions
  * @public
  */
 export interface ISignFunction extends ISingleSignFunction {

diff --git a/packages/libs/client/src/signing/eckoWallet/eckoTypes.ts b/packages/libs/client/src/signing/eckoWallet/eckoTypes.ts
@@ -5,16 +5,27 @@ import { ISignFunction, ISingleSignFunction } from '../ISignFunction';
 
 export type EckoStatus = 'success' | 'fail';
 
+/**
+ * Interface that describes the common functions to be used with Ecko Wallet
+ * @public
+ */
 export interface ICommonEckoFunctions {
   isInstalled: () => boolean;
   isConnected: (networkId: string) => Promise<boolean>;
   connect: (networkId: string) => Promise<boolean>;
 }
-
+/**
+ * Interface to use when writing a signing function for Ecko Wallet that accepts a single transaction
+ * @public
+ */
 export interface IEckoSignSingleFunction
   extends ISingleSignFunction,
     ICommonEckoFunctions {}
 
+/**
+ * Interface to use when writing a signing function for Ecko Wallet that accepts multiple transactions
+ * @public
+ */
 export interface IEckoSignFunction
   extends ISignFunction,
     ICommonEckoFunctions {}

diff --git a/packages/libs/client/src/signing/index.ts b/packages/libs/client/src/signing/index.ts
@@ -1,3 +1,8 @@
+export {
+  ICommonEckoFunctions,
+  IEckoSignSingleFunction,
+  IEckoSignFunction,
+} from './eckoWallet/eckoTypes';
 export { TWalletConnectChainId } from './walletconnect/walletConnectTypes';
 export { ISingleSignFunction, ISignFunction } from './ISignFunction';