Class HttpBridge<TParams, TEventData, TModule>

Type Parameters

TParams extends XyoHttpBridgeParams = XyoHttpBridgeParams
TEventData extends ModuleEventData = ModuleEventData
TModule extends Module<ModuleParams, TEventData> = Module<ModuleParams, TEventData>

Hierarchy

AbstractBridge<TParams, TEventData, TModule>
- HttpBridge

Implements

BridgeModule<TParams, TEventData, TModule>

Index

Constructors

constructor

Accessors

_queryAccountPaths address allowAnonymous axios config discoverCache discoverCacheConfig logger nodeUrl queries queryAccountPaths queryAccounts rootAddress

Constructors

constructor

new HttpBridge<TParams, TEventData, TModule>(params): HttpBridge<TParams, TEventData, TModule>
Type Parameters
- TParams extends XyoHttpBridgeParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.bridge.http.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      discoverCache?: true | CacheConfig;
      schema: "network.xyo.bridge.http.config";
  } & {
      nodeUrl?: string;
      schema: "network.xyo.bridge.http.config";
  }, "schema">, "schema"> & {
      schema: string;
  }, "schema">> = XyoHttpBridgeParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.bridge.http.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      discoverCache?: true | CacheConfig;
      schema: "network.xyo.bridge.http.config";
  } & {
      nodeUrl?: string;
      schema: "network.xyo.bridge.http.config";
  }, "schema">, "schema"> & {
      schema: string;
  }, "schema">>
- TEventData extends ModuleEventData<TEventData> = ModuleEventData
- TModule extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>> & EventFunctions<TEventData, TModule> = Module<ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, TEventData>
Parameters
- params: TParams
Returns HttpBridge<TParams, TEventData, TModule>
Inherited from AbstractBridge.constructor
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:22

Properties

`Private` `Optional` _axios

_axios?: any

`Protected` `Readonly` _baseModuleQueryAccountPaths

_baseModuleQueryAccountPaths: Record<"network.xyo.query.module.discover" | "network.xyo.query.module.account" | "network.xyo.query.module.subscribe", string>

`Private` `Optional` _discoverCache

_discoverCache?: any

`Protected` `Readonly` _queryAccounts

_queryAccounts: Record<"network.xyo.query.module.discover" | "network.xyo.query.module.account" | "network.xyo.query.module.subscribe", undefined | AccountInstance>

`Private` `Optional` _rootAddress

_rootAddress?: any

`Protected` _started

_started: boolean

`Private` _targetConfigs

_targetConfigs: any

`Protected` _targetDownResolvers

_targetDownResolvers: Record<string, BridgeModuleResolver>

`Private` _targetQueries

_targetQueries: any

`Protected` `Readonly` account

account: AccountInstance

`Protected` commitArchivist

commitArchivist: (() => Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>)

Type declaration

- (): Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>
- Returns Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>

`Readonly` downResolver

downResolver: CompositeModuleResolver

eventData

eventData: TEventData

`Private` initRootAddress

initRootAddress: any

`Protected` `Readonly` moduleConfigQueryValidator

moduleConfigQueryValidator: Queryable<SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}>

`Readonly` params

params: TParams

`Protected` readArchivist

readArchivist: (() => Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>)

Type declaration

- (): Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>
- Returns Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>

`Protected` `Readonly` supportedQueryValidator

supportedQueryValidator: Queryable<SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}>

`Readonly` upResolver

upResolver: CompositeModuleResolver

`Protected` writeArchivist

writeArchivist: (() => Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>)

Type declaration

- (): Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>
- Returns Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>

`Static` configSchema

configSchema: "network.xyo.bridge.http.config"

`Static` `Optional` defaultLogger

defaultLogger?: Logger

Accessors

`Protected` _queryAccountPaths

get _queryAccountPaths(): Record<"network.xyo.query.bridge.connect" | "network.xyo.query.bridge.disconnect", string>
Returns Record<"network.xyo.query.bridge.connect" | "network.xyo.query.bridge.disconnect", string>
Inherited from AbstractBridge._queryAccountPaths
- Defined in modules/packages/bridge/packages/abstract/dist/types/AbstractBridge.d.ts:10

address

get address(): string
Returns string
Implementation of BridgeModule.address

Inherited from AbstractBridge.address
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:23

allowAnonymous

get allowAnonymous(): boolean
Returns boolean
Inherited from AbstractBridge.allowAnonymous
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:24

axios

get axios(): AxiosJson
Returns AxiosJson
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:19

config

get config(): TParams["config"]
Returns TParams["config"]
Implementation of BridgeModule.config

Inherited from AbstractBridge.config
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:25

discoverCache

get discoverCache(): LRUCache<string, (SchemaFields & PayloadFields & {
schema: string;
})[], unknown>
Returns LRUCache<string, (SchemaFields & PayloadFields & {
schema: string;
})[], unknown>
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:20

discoverCacheConfig

get discoverCacheConfig(): Options<string, (SchemaFields & PayloadFields & {
schema: string;
})[], unknown>
Returns Options<string, (SchemaFields & PayloadFields & {
schema: string;
})[], unknown>
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:23

`Protected` logger

get logger(): Logger | Console
Returns Logger | Console
Inherited from AbstractBridge.logger
- Defined in protocol/packages/core/dist/types/lib/Base.d.ts:23

nodeUrl

get nodeUrl(): URLParse<string>
Returns URLParse<string>
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:24

queries

get queries(): string[]
Returns string[]
Implementation of BridgeModule.queries

Inherited from AbstractBridge.queries
- Defined in modules/packages/bridge/packages/abstract/dist/types/AbstractBridge.d.ts:9

queryAccountPaths

get queryAccountPaths(): Readonly<Record<string, undefined | string>>
Returns Readonly<Record<string, undefined | string>>
Inherited from AbstractBridge.queryAccountPaths
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:27

queryAccounts

get queryAccounts(): Readonly<Record<string, undefined | AccountInstance>>
Returns Readonly<Record<string, undefined | AccountInstance>>
Inherited from AbstractBridge.queryAccounts
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:28

rootAddress

get rootAddress(): string
Returns string
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:25

Methods

`Protected` bindHashes

bindHashes(hashes, schema, account?): PromiseEx<unknown, AccountInstance>
Parameters
- hashes: string[]
- schema: string[]
- Optional account: AccountInstance
Returns PromiseEx<unknown, AccountInstance>
Inherited from AbstractBridge.bindHashes
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:39

`Protected` bindHashesInternal

bindHashesInternal(hashes, schema, account?): Promise<SchemaFields & PayloadFields & BoundWitnessFields & {
schema: "network.xyo.boundwitness";
}>
Parameters
- hashes: string[]
- schema: string[]
- Optional account: AccountInstance
Returns Promise<SchemaFields & PayloadFields & BoundWitnessFields & {
schema: "network.xyo.boundwitness";
}>
Inherited from AbstractBridge.bindHashesInternal
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:40

`Protected` bindQuery

bindQuery<T>(query, payloads?, account?): PromiseEx<[SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
    schema: string;
})[]], AccountInstance>
Type Parameters
- T extends SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  }>
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional account: AccountInstance
Returns PromiseEx<[SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
    schema: string;
})[]], AccountInstance>
Inherited from AbstractBridge.bindQuery
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:41

`Protected` bindQueryInternal

bindQueryInternal<T>(query, payloads?, account?): Promise<[SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
    schema: string;
})[]]>
Type Parameters
- T extends SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  }>
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional account: AccountInstance
Returns Promise<[SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
    schema: string;
})[]]>
Inherited from AbstractBridge.bindQueryInternal
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:42

`Protected` bindQueryResult

bindQueryResult<T>(query, payloads, additionalWitnesses?): PromiseEx<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, AccountInstance[]>
Type Parameters
- T extends SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  }>
Parameters
- query: T
- payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional additionalWitnesses: AccountInstance[]
Returns PromiseEx<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, AccountInstance[]>
Inherited from AbstractBridge.bindQueryResult
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:43

clearListeners

clearListeners(eventNames): void
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns void
Implementation of BridgeModule.clearListeners

Inherited from AbstractBridge.clearListeners
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:7

connect

connect(): Promisable<boolean, never>
Returns Promisable<boolean, never>
Implementation of BridgeModule.connect

Overrides AbstractBridge.connect
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:26

disconnect

disconnect(): Promisable<boolean, never>
Returns Promisable<boolean, never>
Implementation of BridgeModule.disconnect

Overrides AbstractBridge.disconnect
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:27

discover

discover(): Promisable<(SchemaFields & PayloadFields & {
schema: string;
})[], never>
Returns Promisable<(SchemaFields & PayloadFields & {
schema: string;
})[], never>
Inherited from AbstractBridge.discover
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:32

emit

emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends string | number | symbol = keyof TEventData
- TEventArgs extends EventArgs = TEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Implementation of BridgeModule.emit

Inherited from AbstractBridge.emit
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:8

emitSerial

emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends string | number | symbol = keyof TEventData
- TEventArgs extends EventArgs = TEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Implementation of BridgeModule.emitSerial

Inherited from AbstractBridge.emitSerial
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:9

`Protected` initializeQueryAccounts

initializeQueryAccounts(): void
Returns void
Inherited from AbstractBridge.initializeQueryAccounts
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:77

listenerCount

listenerCount(eventNames): number
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns number
Implementation of BridgeModule.listenerCount

Inherited from AbstractBridge.listenerCount
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:10

`Protected` loadAccount

loadAccount(account?): AccountInstance
Parameters
- Optional account: AccountInstance
Returns AccountInstance
Inherited from AbstractBridge.loadAccount
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:78

moduleAccountQuery

moduleAccountQuery(): Promisable<(SchemaFields & PayloadFields & {
    address: string;
    name?: string;
    schema: "network.xyo.address";
} | SchemaFields & PayloadFields & {
    address: string;
    previousHash?: string;
    schema: string;
})[], never>
Returns Promisable<(SchemaFields & PayloadFields & {
    address: string;
    name?: string;
    schema: "network.xyo.address";
} | SchemaFields & PayloadFields & {
    address: string;
    previousHash?: string;
    schema: string;
})[], never>
Inherited from AbstractBridge.moduleAccountQuery
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:33

moduleUrl

moduleUrl(address): URL
Parameters
- address: string
Returns URL
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:28

off

off<TEventName>(eventNames, listener): void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns void
Implementation of BridgeModule.off

Inherited from AbstractBridge.off
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:11

offAny

offAny(listener): void
Parameters
- listener: EventAnyListener<EventArgs>
Returns void
Implementation of BridgeModule.offAny

Inherited from AbstractBridge.offAny
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:12

on

on<TEventName>(eventNames, listener): (() => void)
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Implementation of BridgeModule.on

Inherited from AbstractBridge.on
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:13

onAny

onAny(listener): (() => void)
Parameters
- listener: EventAnyListener<EventArgs>
Returns (() => void)
- - (): void
  - Returns void
Implementation of BridgeModule.onAny

Inherited from AbstractBridge.onAny
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:14

once

once<TEventName>(eventName, listener): (() => void)
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- listener: EventListener<TEventData[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Implementation of BridgeModule.once

Inherited from AbstractBridge.once
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:15

query

query<T, TConfig>(query, payloads?, queryConfig?): Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Type Parameters
- T extends SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  } = SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }
- TConfig extends SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema"> = SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional queryConfig: TConfig
Returns Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Implementation of BridgeModule.query

Inherited from AbstractBridge.query
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:34

`Protected` queryHandler

queryHandler<T>(query, payloads?): Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Type Parameters
- T extends SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  } = SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
Returns Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Inherited from AbstractBridge.queryHandler
- Defined in modules/packages/bridge/packages/abstract/dist/types/AbstractBridge.d.ts:13

queryable

queryable<T, TConfig>(query, payloads?, queryConfig?): boolean
Type Parameters
- T extends SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  } = SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }
- TConfig extends SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema"> = SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional queryConfig: TConfig
Returns boolean
Implementation of BridgeModule.queryable

Inherited from AbstractBridge.queryable
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:35

`Protected` resolve

resolve<TModule>(filter?): Promise<TModule[]>
Type Parameters
- TModule extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>> & EventFunctions<ModuleEventData, TModule> = Module<ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ModuleEventData>
Parameters
- Optional filter: ModuleFilter
Returns Promise<TModule[]>
Inherited from AbstractBridge.resolve
- Defined in modules/packages/bridge/packages/abstract/dist/types/AbstractBridge.d.ts:14

start

start(): Promise<void>
Returns Promise<void>
Implementation of BridgeModule.start

Overrides AbstractBridge.start
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:29

started

started(notStartedAction?): boolean
Parameters
- Optional notStartedAction: "error" | "throw" | "warn" | "log" | "none"
Returns boolean
Inherited from AbstractBridge.started
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:37

`Protected` stop

stop(_timeout?): Promisable<HttpBridge<TParams, TEventData, TModule>, never>
Parameters
- Optional _timeout: number
Returns Promisable<HttpBridge<TParams, TEventData, TModule>, never>
Inherited from AbstractBridge.stop
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:114

subscribe(_queryAccount?): void
Parameters
- Optional _queryAccount: AccountInstance
Returns void
Inherited from AbstractBridge.subscribe
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:38

targetConfig

targetConfig(address): SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.module.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<undefined, "schema">
Parameters
- address: string
Returns SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.module.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<undefined, "schema">
Implementation of BridgeModule.targetConfig

Overrides AbstractBridge.targetConfig
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:30

targetDiscover

targetDiscover(address?): Promise<(SchemaFields & PayloadFields & {
schema: string;
})[]>
Parameters
- Optional address: string
Returns Promise<(SchemaFields & PayloadFields & {
schema: string;
})[]>
Implementation of BridgeModule.targetDiscover

Overrides AbstractBridge.targetDiscover
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:31

targetDownResolver

targetDownResolver(address?): BridgeModuleResolver
Parameters
- Optional address: string
Returns BridgeModuleResolver
Implementation of BridgeModule.targetDownResolver

Inherited from AbstractBridge.targetDownResolver
- Defined in modules/packages/bridge/packages/abstract/dist/types/AbstractBridge.d.ts:11

targetQueries

targetQueries(address): string[]
Parameters
- address: string
Returns string[]
Implementation of BridgeModule.targetQueries

Overrides AbstractBridge.targetQueries
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:32

targetQuery

targetQuery(address, query, payloads?): Promise<undefined | ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Parameters
- address: string
- query: SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
Returns Promise<undefined | ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Implementation of BridgeModule.targetQuery

Overrides AbstractBridge.targetQuery
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:33

targetQueryable

targetQueryable(_address, _query, _payloads?, _queryConfig?): boolean
Parameters
- _address: string
- _query: SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }
- Optional _payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional _queryConfig: SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">
Returns boolean
Implementation of BridgeModule.targetQueryable

Overrides AbstractBridge.targetQueryable
- Defined in modules/packages/bridge/packages/http/dist/types/HttpBridge.d.ts:34

targetResolve

targetResolve(address, filter?): Promise<TModule[]>
Parameters
- address: string
- Optional filter: ModuleFilter
Returns Promise<TModule[]>
Implementation of BridgeModule.targetResolve

Inherited from AbstractBridge.targetResolve
- Defined in modules/packages/bridge/packages/abstract/dist/types/AbstractBridge.d.ts:12

`Protected` validateConfig

validateConfig(config?, parents?): boolean
Parameters
- Optional config: unknown
- Optional parents: string[]
Returns boolean
Inherited from AbstractBridge.validateConfig
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:115

`Static` create

create<TModule>(this, params?): Promise<TModule>
Type Parameters
- TModule extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>> & EventFunctions<ModuleEventData, TModule>
Parameters
- this: CreatableModule<TModule>
- Optional params: TModule["params"]
Returns Promise<TModule>
Inherited from AbstractBridge.create
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:30

`Static` factory

factory<TModule>(this, params?): CreatableModuleFactory<TModule>
Type Parameters
- TModule extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>> & EventFunctions<ModuleEventData, TModule>
Parameters
- this: CreatableModule<TModule>
- Optional params: TModule["params"]
Returns CreatableModuleFactory<TModule>
Inherited from AbstractBridge.factory
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:31

Class HttpBridge<TParams, TEventData, TModule>

Type Parameters

TParams extends XyoHttpBridgeParams = XyoHttpBridgeParams

TEventData extends ModuleEventData = ModuleEventData

TModule extends Module<ModuleParams, TEventData> = Module<ModuleParams, TEventData>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TEventData extends ModuleEventData<TEventData> = ModuleEventData

Parameters

params: TParams

Returns HttpBridge<TParams, TEventData, TModule>

Properties

Private Optional _axios

Protected Readonly _baseModuleQueryAccountPaths

Private Optional _discoverCache

Protected Readonly _queryAccounts

Private Optional _rootAddress

Protected _started

Private _targetConfigs

Protected _targetDownResolvers

Private _targetQueries

Protected Readonly account

Protected commitArchivist

Type declaration

Readonly downResolver

eventData

Private initRootAddress

Protected Readonly moduleConfigQueryValidator

Readonly params

Protected readArchivist

Type declaration

Protected Readonly supportedQueryValidator

Readonly upResolver

Protected writeArchivist

Type declaration

Static configSchema

Static Optional defaultLogger

Accessors

Protected _queryAccountPaths

Returns Record<"network.xyo.query.bridge.connect" | "network.xyo.query.bridge.disconnect", string>

address

Returns string

allowAnonymous

Returns boolean

axios

Returns AxiosJson

config

Returns TParams["config"]

discoverCache

Returns LRUCache<string, (SchemaFields & PayloadFields & { schema: string; })[], unknown>

discoverCacheConfig

Returns Options<string, (SchemaFields & PayloadFields & { schema: string; })[], unknown>

Protected logger

Returns Logger | Console

nodeUrl

Returns URLParse<string>

queries

Returns string[]

queryAccountPaths

Returns Readonly<Record<string, undefined | string>>

queryAccounts

Returns Readonly<Record<string, undefined | AccountInstance>>

rootAddress

Returns string

Methods

Protected bindHashes

Parameters

hashes: string[]

schema: string[]

Optional account: AccountInstance

Returns PromiseEx<unknown, AccountInstance>

Protected bindHashesInternal

`Private` `Optional` _axios

`Protected` `Readonly` _baseModuleQueryAccountPaths

`Private` `Optional` _discoverCache

`Protected` `Readonly` _queryAccounts

`Private` `Optional` _rootAddress

`Protected` _started

`Private` _targetConfigs

`Protected` _targetDownResolvers

`Private` _targetQueries

`Protected` `Readonly` account

`Protected` commitArchivist

`Readonly` downResolver

`Private` initRootAddress

`Protected` `Readonly` moduleConfigQueryValidator

`Readonly` params

`Protected` readArchivist

`Protected` `Readonly` supportedQueryValidator

`Readonly` upResolver

`Protected` writeArchivist

`Static` configSchema

`Static` `Optional` defaultLogger

`Protected` _queryAccountPaths

Returns LRUCache<string, (SchemaFields & PayloadFields & {
schema: string;
})[], unknown>

Returns Options<string, (SchemaFields & PayloadFields & {
schema: string;
})[], unknown>

`Protected` logger

`Protected` bindHashes

`Optional` account: AccountInstance

`Protected` bindHashesInternal

`Optional` account: AccountInstance

Returns Promise<SchemaFields & PayloadFields & BoundWitnessFields & {
schema: "network.xyo.boundwitness";
}>

`Protected` bindQuery

T extends SchemaFields & PayloadFields & QueryFields & {
schema: string;
} | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
schema: string;
}>

`Optional` payloads: (SchemaFields & PayloadFields & {
schema: string;
})[]

`Optional` account: AccountInstance

Returns PromiseEx<[SchemaFields & PayloadFields & BoundWitnessFields & {
query: string;
resultSet?: string;
schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
schema: string;
})[]], AccountInstance>

`Protected` bindQueryInternal

T extends SchemaFields & PayloadFields & QueryFields & {
schema: string;
} | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
schema: string;
}>

`Optional` payloads: (SchemaFields & PayloadFields & {
schema: string;
})[]

`Optional` account: AccountInstance

Returns Promise<[SchemaFields & PayloadFields & BoundWitnessFields & {
query: string;
resultSet?: string;
schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
schema: string;
})[]]>

`Protected` bindQueryResult

T extends SchemaFields & PayloadFields & QueryFields & {
schema: string;
} | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
schema: string;
}>

payloads: (SchemaFields & PayloadFields & {
schema: string;
})[]

`Optional` additionalWitnesses: AccountInstance[]

Returns PromiseEx<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, AccountInstance[]>

Returns Promisable<(SchemaFields & PayloadFields & {
schema: string;
})[], never>

`Protected` initializeQueryAccounts

`Protected` loadAccount

`Optional` account: AccountInstance