Class Fabric

constructor

• new Fabric(config): Fabric

• Parameters

  • config: Config

  Returns Fabric

ReadonlyfabricId

ReadonlyfabricIndex

ReadonlyidentityProtectionKey

ReadonlyintermediateCACert

label

ReadonlynodeId

ReadonlyoperationalCert

ReadonlyoperationalId

ReadonlyoperationalIdentityProtectionKey

ReadonlyrootCert

ReadonlyrootNodeId

ReadonlyrootPublicKey

ReadonlyrootVendorId

config

• get config(): Config

• Returns Config

externalInformation

• get externalInformation(): ExposedFabricInformation

• Returns ExposedFabricInformation

persistCallback

• set persistCallback(callback): void

• Parameters

  • callback: ((isUpdate?: boolean) => MaybePromise<void>)
    • • (isUpdate?): MaybePromise<void>

      • Parameters

        • OptionalisUpdate: boolean

        Returns MaybePromise<void>

  Returns void

publicKey

• get publicKey(): Uint8Array

• Returns Uint8Array

addRemoveCallback

• addRemoveCallback(callback): void

• Parameters

  • callback: (() => MaybePromise<void>)
    • • (): MaybePromise<void>

      • Returns MaybePromise<void>

  Returns void

addressOf

• addressOf(nodeId): PeerAddress

• Parameters

  • nodeId: NodeId

  Returns PeerAddress

addSession

• addSession(session): void

• Parameters

  • session: SecureSession

  Returns void

deleteRemoveCallback

• deleteRemoveCallback(callback): void

• Parameters

  • callback: (() => MaybePromise<void>)
    • • (): MaybePromise<void>

      • Returns MaybePromise<void>

  Returns void

deleteScopedClusterData

• deleteScopedClusterData(cluster): undefined | MaybePromise<void>

• Parameters

  • cluster: Cluster<any, any, any, any, any>

  Returns undefined | MaybePromise<void>

deleteScopedClusterDataValue

• deleteScopedClusterDataValue(cluster, clusterDataKey): MaybePromise<void>

• Parameters

  • cluster: Cluster<any, any, any, any, any>
  • clusterDataKey: string

  Returns MaybePromise<void>

getAllGroupKeySets

• getAllGroupKeySets(): TypeFromFields<{
      epochKey0: FieldType<null | Uint8Array>;
      epochKey1: FieldType<null | Uint8Array>;
      epochKey2: FieldType<null | Uint8Array>;
      epochStartTime0: FieldType<null | number | bigint>;
      epochStartTime1: FieldType<null | number | bigint>;
      epochStartTime2: FieldType<null | number | bigint>;
      groupKeyMulticastPolicy: OptionalFieldType<GroupKeyManagement.GroupKeyMulticastPolicy>;
      groupKeySecurityPolicy: FieldType<GroupKeyManagement.GroupKeySecurityPolicy>;
      groupKeySetId: FieldType<number>;
  }>[]

• Returns TypeFromFields<{
      epochKey0: FieldType<null | Uint8Array>;
      epochKey1: FieldType<null | Uint8Array>;
      epochKey2: FieldType<null | Uint8Array>;
      epochStartTime0: FieldType<null | number | bigint>;
      epochStartTime1: FieldType<null | number | bigint>;
      epochStartTime2: FieldType<null | number | bigint>;
      groupKeyMulticastPolicy: OptionalFieldType<GroupKeyManagement.GroupKeyMulticastPolicy>;
      groupKeySecurityPolicy: FieldType<GroupKeyManagement.GroupKeySecurityPolicy>;
      groupKeySetId: FieldType<number>;
  }>[]

getDestinationId

• getDestinationId(nodeId, random): Uint8Array

• Parameters

  • nodeId: NodeId
  • random: Uint8Array

  Returns Uint8Array

getGroupKeySet

• getGroupKeySet(groupKeySetId): undefined | TypeFromFields<{
      epochKey0: FieldType<null | Uint8Array>;
      epochKey1: FieldType<null | Uint8Array>;
      epochKey2: FieldType<null | Uint8Array>;
      epochStartTime0: FieldType<null | number | bigint>;
      epochStartTime1: FieldType<null | number | bigint>;
      epochStartTime2: FieldType<null | number | bigint>;
      groupKeyMulticastPolicy: OptionalFieldType<GroupKeyManagement.GroupKeyMulticastPolicy>;
      groupKeySecurityPolicy: FieldType<GroupKeyManagement.GroupKeySecurityPolicy>;
      groupKeySetId: FieldType<number>;
  }>

• Parameters

  • groupKeySetId: number

  Returns undefined | TypeFromFields<{
      epochKey0: FieldType<null | Uint8Array>;
      epochKey1: FieldType<null | Uint8Array>;
      epochKey2: FieldType<null | Uint8Array>;
      epochStartTime0: FieldType<null | number | bigint>;
      epochStartTime1: FieldType<null | number | bigint>;
      epochStartTime2: FieldType<null | number | bigint>;
      groupKeyMulticastPolicy: OptionalFieldType<GroupKeyManagement.GroupKeyMulticastPolicy>;
      groupKeySecurityPolicy: FieldType<GroupKeyManagement.GroupKeySecurityPolicy>;
      groupKeySetId: FieldType<number>;
  }>

getScopedClusterDataKeys

• getScopedClusterDataKeys(cluster): string[]

• Parameters

  • cluster: Cluster<any, any, any, any, any>

  Returns string[]

getScopedClusterDataValue

• getScopedClusterDataValue<T>(cluster, clusterDataKey): undefined | T

• Type Parameters

  • T

  Parameters

  • cluster: Cluster<any, any, any, any, any>
  • clusterDataKey: string

  Returns undefined | T

hasScopedClusterDataValue

• hasScopedClusterDataValue(cluster, clusterDataKey): boolean

• Parameters

  • cluster: Cluster<any, any, any, any, any>
  • clusterDataKey: string

  Returns boolean

matchesFabricIdAndRootPublicKey

• matchesFabricIdAndRootPublicKey(fabricId, rootPublicKey): boolean

• Parameters

  • fabricId: FabricId
  • rootPublicKey: Uint8Array

  Returns boolean

matchesKeyPair

• matchesKeyPair(keyPair): boolean

• Parameters

  • keyPair: Key

  Returns boolean

persist

• persist(isUpdate?): undefined | MaybePromise<void>

• Parameters

  • isUpdate: boolean = true

  Returns undefined | MaybePromise<void>

remove

• remove(currentSessionId?): Promise<void>

• Parameters

  • OptionalcurrentSessionId: number

  Returns Promise<void>

removeSession

• removeSession(session): void

• Parameters

  • session: SecureSession

  Returns void

setLabel

• setLabel(label): Promise<void>

• Parameters

  • label: string

  Returns Promise<void>

setScopedClusterDataValue

• setScopedClusterDataValue<T>(cluster, clusterDataKey, value): undefined | MaybePromise<void>

• Type Parameters

  • T

  Parameters

  • cluster: Cluster<any, any, any, any, any>
  • clusterDataKey: string
  • value: T

  Returns undefined | MaybePromise<void>

sign

• sign(data): Uint8Array

• Parameters

  • data: Uint8Array

  Returns Uint8Array

verifyCredentials

• verifyCredentials(operationalCert, intermediateCACert?): void

• Parameters

  • operationalCert: Uint8Array
  • OptionalintermediateCACert: Uint8Array

  Returns void