Class CodeMetadata

constructor

• new CodeMetadata(
      upgradeable?: boolean,
      readable?: boolean,
      payable?: boolean,
      payableBySc?: boolean,
  ): CodeMetadata

  Creates a metadata object. By default, set the upgradeable attribute, and uset all others.

  Parameters

  • upgradeable: boolean = true

    Whether the contract is upgradeable
  • readable: boolean = false

    Whether other contracts can read this contract's data (without calling one of its pure functions)
  • payable: boolean = false

    Whether the contract is payable
  • payableBySc: boolean = false

    Whether the contract is payable by other smart contracts

  Returns CodeMetadata

payable

payableBySc

readable

upgradeable

StaticByteOne

StaticByteZero

equals

• equals(other: CodeMetadata): boolean

  Parameters

  • other: CodeMetadata

  Returns boolean

toBuffer

• toBuffer(): Buffer

  Returns Buffer

  Deprecated

  Use toBytes instead.

toBytes

• toBytes(): Uint8Array

  Converts the metadata to the protocol-friendly representation.

  Returns Uint8Array

togglePayable

• togglePayable(value: boolean): void

  Adjust the metadata (the payable attribute), when preparing the deployment transaction.

  Parameters

  • value: boolean

  Returns void

togglePayableBySc

• togglePayableBySc(value: boolean): void

  Adjust the metadata (the payableBySc attribute), when preparing the deployment transaction.

  Parameters

  • value: boolean

  Returns void

toggleReadable

• toggleReadable(value: boolean): void

  Adjust the metadata (the readable attribute), when preparing the deployment transaction.

  Parameters

  • value: boolean

  Returns void

toggleUpgradeable

• toggleUpgradeable(value: boolean): void

  Adjust the metadata (the upgradeable attribute), when preparing the deployment transaction.

  Parameters

  • value: boolean

  Returns void

toJSON

• toJSON(): object

  Converts the metadata to a pretty, plain JavaScript object.

  Returns object

toString

• toString(): string

  Converts the metadata to a hex-encoded string.

  Returns string

StaticnewFromBuffer

• newFromBuffer(buffer: Buffer): CodeMetadata

  Parameters

  • buffer: Buffer

  Returns CodeMetadata

  Deprecated

  Use newFromBytes instead. Creates a metadata object from a buffer.

StaticnewFromBytes

• newFromBytes(bytes: Uint8Array): CodeMetadata

  Named constructor Creates a metadata object from a buffer. Also checks that data has correct length (2 bytes)

  Parameters

  • bytes: Uint8Array

  Returns CodeMetadata