Class AssetGroup

constructor

• new AssetGroup(
      assetId: AssetId | null,
      controlAsset: AssetRef | null,
      inputs: AssetInput[],
      outputs: AssetOutput[],
      metadata: Metadata[],
  ): AssetGroup

  Parameters

  • assetId: AssetId | null
  • controlAsset: AssetRef | null
  • inputs: AssetInput[]
  • outputs: AssetOutput[]
  • metadata: Metadata[]

  Returns AssetGroup

  See

  create

ReadonlyassetId

ReadonlycontrolAsset

Readonlyinputs

Readonlyoutputs

isIssuance

• isIssuance(): boolean

  Return true when the group represents an issuance.

  Returns boolean

  true when the group has no asset id

isReissuance

• isReissuance(): boolean

  Return true when the group represents a reissuance.

  Returns boolean

  true when the group has an asset id and outputs exceed local inputs

  Remarks

  Only local inputs contribute to the comparison; intent-backed inputs contribute 0 here.

serialize

• serialize(): Uint8Array

  Serialize the asset group to raw bytes.

  Returns Uint8Array

  Serialized asset group bytes

  See

  fromBytes

serializeTo

• serializeTo(writer: BufferWriter): void

  Serialize the asset group into an existing binary writer.

  Parameters

  • writer: BufferWriter

    Writer to append the asset group to

  Returns void

toBatchLeafAssetGroup

• toBatchLeafAssetGroup(intentTxid: Uint8Array): AssetGroup

  Convert the group into its batch-leaf representation for the given intent txid.

  Parameters

  • intentTxid: Uint8Array

    Intent transaction id used to build the leaf input reference

  Returns AssetGroup

  Batch-leaf asset group

  See

  AssetInput.createIntent

toString

• toString(): string

  Encode the asset group to a hex string.

  Returns string

  Hex-encoded asset group

  See

  fromString

validate

• validate(): void

  Validate the asset group and its child structures.

  Returns void

  Throws

  Error if the group is empty or violates issuance invariants

Staticcreate

• create(
      assetId: AssetId | null,
      controlAsset: AssetRef | null,
      inputs: AssetInput[],
      outputs: AssetOutput[],
      metadata: Metadata[],
  ): AssetGroup

  Create and validate an asset group.

  Parameters

  • assetId: AssetId | null

    Asset id for this group, or null for fresh issuance

  • controlAsset: AssetRef | null

    Optional control asset reference for (re) issuance

  • inputs: AssetInput[]

    Asset inputs in the group

  • outputs: AssetOutput[]

    Asset outputs in the group

  • metadata: Metadata[]

    Metadata entries associated with the group

  Returns AssetGroup

  A validated asset group

  Throws

  Error if the group fails validation

  See

  validate

StaticfromBytes

• fromBytes(buf: Uint8Array): AssetGroup

  Decode an asset group from its serialized bytes.

  Parameters

  • buf: Uint8Array

    Serialized asset group bytes

  Returns AssetGroup

  Decoded asset group

  Throws

  Error if the buffer is empty or malformed

StaticfromReader

• fromReader(reader: BufferReader): AssetGroup

  Decode an asset group from a binary reader.

  Parameters

  • reader: BufferReader

    Reader positioned at an asset group

  Returns AssetGroup

  Decoded asset group

  Throws

  Error if the encoded group is malformed

StaticfromString

• fromString(s: string): AssetGroup

  Decode an asset group from its hex string form.

  Parameters

  • s: string

    Hex-encoded asset group

  Returns AssetGroup

  Decoded asset group

  Throws

  Error if the string is not valid hex or does not encode a valid asset group

  See

  toString