Class CodeMetadata

The metadata of a Smart Contract, as an abstraction.

Index

Constructors

Properties

payable payableBySc readable upgradeable ByteOne ByteZero codeMetadataLength

Methods

equals toBuffer toJSON toString togglePayable togglePayableBySc toggleReadable toggleUpgradeable fromBuffer fromBytes

Constructors

constructor

new CodeMetadata(upgradeable?, readable?, payable?, payableBySc?): 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
- Defined in src/smartcontracts/codeMetadata.ts:31

Properties

payable

payable: boolean

payableBySc

payableBySc: boolean

readable

readable: boolean

upgradeable

upgradeable: boolean

`Static` ByteOne

ByteOne: {
    Payable: number;
    PayableBySc: number;
    Reserved1: number;
} = ...

Type declaration

Payable: number
PayableBySc: number
Reserved1: number

`Static` ByteZero

ByteZero: {
    Readable: number;
    Reserved2: number;
    Upgradeable: number;
} = ...

Type declaration

Readable: number
Reserved2: number
Upgradeable: number

`Static` `Private` `Readonly` codeMetadataLength

codeMetadataLength: 2 = 2

Methods

equals

equals(other): boolean
Parameters
- other: CodeMetadata
Returns boolean
- Defined in src/smartcontracts/codeMetadata.ts:131

toBuffer

toBuffer(): Buffer
Converts the metadata to the protocol-friendly representation.

Returns Buffer
- Defined in src/smartcontracts/codeMetadata.ts:92

toJSON

toJSON(): object
Converts the metadata to a pretty, plain JavaScript object.

Returns object
- Defined in src/smartcontracts/codeMetadata.ts:122

toString

toString(): string
Converts the metadata to a hex-encoded string.

Returns string
- Defined in src/smartcontracts/codeMetadata.ts:115

togglePayable

togglePayable(value): void
Adjust the metadata (the payable attribute), when preparing the deployment transaction.
Parameters
- value: boolean
Returns void
- Defined in src/smartcontracts/codeMetadata.ts:78

togglePayableBySc

togglePayableBySc(value): void
Adjust the metadata (the payableBySc attribute), when preparing the deployment transaction.
Parameters
- value: boolean
Returns void
- Defined in src/smartcontracts/codeMetadata.ts:85

toggleReadable

toggleReadable(value): void
Adjust the metadata (the readable attribute), when preparing the deployment transaction.
Parameters
- value: boolean
Returns void
- Defined in src/smartcontracts/codeMetadata.ts:71

toggleUpgradeable

toggleUpgradeable(value): void
Adjust the metadata (the upgradeable attribute), when preparing the deployment transaction.
Parameters
- value: boolean
Returns void
- Defined in src/smartcontracts/codeMetadata.ts:64

`Static` fromBuffer

fromBuffer(buffer): CodeMetadata
Creates a metadata object from a buffer.
Parameters
- buffer: Buffer
Returns CodeMetadata
- Defined in src/smartcontracts/codeMetadata.ts:45

`Static` fromBytes

fromBytes(bytes): CodeMetadata
Parameters
- bytes: Uint8Array
Returns CodeMetadata
- Defined in src/smartcontracts/codeMetadata.ts:38