Update typedefs

Author: jribbink

packages/typedefs/src/index.ts

@@ -459,4 +459,4 @@ export type EventStream = StreamConnection<{
 
 export * from "./interaction"
 export * from "./fvm-errors"
-export * as Subscription from "./subscriptions"
+export * as SdkTransport from "./sdk-transport"

packages/typedefs/src/sdk-transport/index.ts

@@ -0,0 +1,16 @@
+import {SendFn} from "./requests"
+import {SubscribeFn} from "./subscriptions"
+
+export type Transport = {
+  send: SendFn
+  subscribe: SubscribeFn
+}
+
+export type TransportConfig = {
+  node: string
+}
+
+export type TransportFactory = (config: TransportConfig) => Transport
+
+export * from "./subscriptions"
+export * from "./requests"

packages/typedefs/src/sdk-transport/requests.ts

@@ -0,0 +1,85 @@
+import {Interaction} from "../interaction"
+
+interface InteractionModule {
+  isTransaction: (ix: Interaction) => boolean
+  isGetTransactionStatus: (ix: Interaction) => boolean
+  isGetTransaction: (ix: Interaction) => boolean
+  isScript: (ix: Interaction) => boolean
+  isGetAccount: (ix: Interaction) => boolean
+  isGetEvents: (ix: Interaction) => boolean
+  isGetBlock: (ix: Interaction) => boolean
+  isGetBlockHeader: (ix: Interaction) => boolean
+  isGetCollection: (ix: Interaction) => boolean
+  isPing: (ix: Interaction) => boolean
+  isGetNetworkParameters: (ix: Interaction) => boolean
+  isSubscribeEvents?: (ix: Interaction) => boolean
+  isGetNodeVersionInfo?: (ix: Interaction) => boolean
+}
+interface IContext {
+  ix: InteractionModule
+}
+interface IOptsCommon {
+  node?: string
+}
+
+interface IOpts extends IOptsCommon {
+  sendTransaction?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+  sendGetTransactionStatus?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+  sendGetTransaction?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+  sendExecuteScript?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+  sendGetAccount?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+  sendGetEvents?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+  sendGetBlockHeader?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+  sendGetCollection?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+  sendPing?: (ix: Interaction, context: IContext, opts: IOptsCommon) => void
+  sendGetBlock?: (ix: Interaction, context: IContext, opts: IOptsCommon) => void
+  sendGetNetworkParameters?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+  connectSubscribeEvents?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+  sendGetNodeVersionInfo?: (
+    ix: Interaction,
+    context: IContext,
+    opts: IOptsCommon
+  ) => void
+}
+
+export type SendFn = (ix: Interaction, context: IContext, opts: IOpts) => void

packages/typedefs/src/sdk-transport/subscriptions.ts

@@ -0,0 +1,51 @@
+type SchemaItem<TArgs, TData> = {
+  args: TArgs
+  data: TData
+}
+
+export enum SubscriptionTopic {
+  EVENTS = "events",
+  BLOCKS = "blocks",
+}
+
+export type SubscriptionSchema = {
+  [SubscriptionTopic.EVENTS]: SchemaItem<
+    {
+      startBlock: number
+      endBlock: number
+    },
+    {
+      type: string
+      data: any
+    }
+  >
+  [SubscriptionTopic.BLOCKS]: SchemaItem<
+    {
+      startBlock: number
+      endBlock: number
+    },
+    {
+      type: string
+      data: any
+    }
+  >
+}
+
+export type SubscriptionArguments<T extends SubscriptionTopic> =
+  SubscriptionSchema[T]["args"]
+export type SubscriptionData<T extends SubscriptionTopic> =
+  SubscriptionSchema[T]["data"]
+
+export type Subscription = {
+  unsubscribe: () => void
+}
+
+export type SubscribeFn = <T extends SubscriptionTopic>(
+  params: {
+    topic: T
+    args: SubscriptionArguments<T>
+    onData: (data: SubscriptionData<T>) => void
+    onError: (error: Error) => void
+  },
+  opts: {node: string}
+) => Promise<Subscription>