Skip to main content

IntentScope

enum IntentScope : Enum<IntentScope>

Byte signifying the scope of an Intent

This enum specifies the intent scope. Two intents for different scopes should never collide, so no signature provided for one intent scope can be used for another, even when the serialized data itself may be the same.

BCS

The BCS serialized form for this type is defined by the following ABNF:

intent-scope = u8

Entries

TRANSACTION_DATATRANSACTION_DATA
Used for a user signature on a transaction data.
TRANSACTION_EFFECTSTRANSACTION_EFFECTS
Used for an authority signature on transaction effects.
CHECKPOINT_SUMMARYCHECKPOINT_SUMMARY
Used for an authority signature on a checkpoint summary.
PERSONAL_MESSAGEPERSONAL_MESSAGE
Used for a user signature on a personal message.
SENDER_SIGNED_TRANSACTIONSENDER_SIGNED_TRANSACTION
Used for an authority signature on a user signed transaction.
PROOF_OF_POSSESSIONPROOF_OF_POSSESSION
Used as a signature representing an authority's proof of possession of its authority key.
BRIDGE_EVENT_DEPRECATEDBRIDGE_EVENT_DEPRECATED
Deprecated. Should not be reused. Introduced for bridge purposes but was never included in messages.
CONSENSUS_BLOCKCONSENSUS_BLOCK
Used for consensus authority signature on block's digest.
DISCOVERY_PEERSDISCOVERY_PEERS
Used for reporting peer addresses in discovery
AUTHORITY_CAPABILITIESAUTHORITY_CAPABILITIES
Used for authority capabilities from non-committee authorities.

Properties

NameSummary
entriesval entries: EnumEntries<IntentScope>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
nameval name: String
ordinalval ordinal: Int

Functions

NameSummary
valueOffun valueOf(value: String): IntentScope
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
valuesfun values(): Array<IntentScope>
Returns an array containing the constants of this enum type, in the order they're declared.

AUTHORITY_CAPABILITIES

AUTHORITY_CAPABILITIES

Used for authority capabilities from non-committee authorities.

Properties

NameSummary
nameval name: String
ordinalval ordinal: Int

BRIDGE_EVENT_DEPRECATED

BRIDGE_EVENT_DEPRECATED

Deprecated. Should not be reused. Introduced for bridge purposes but was never included in messages.

Properties

NameSummary
nameval name: String
ordinalval ordinal: Int

CHECKPOINT_SUMMARY

CHECKPOINT_SUMMARY

Used for an authority signature on a checkpoint summary.

Properties

NameSummary
nameval name: String
ordinalval ordinal: Int

CONSENSUS_BLOCK

CONSENSUS_BLOCK

Used for consensus authority signature on block's digest.

Properties

NameSummary
nameval name: String
ordinalval ordinal: Int

DISCOVERY_PEERS

DISCOVERY_PEERS

Used for reporting peer addresses in discovery

Properties

NameSummary
nameval name: String
ordinalval ordinal: Int

PERSONAL_MESSAGE

PERSONAL_MESSAGE

Used for a user signature on a personal message.

Properties

NameSummary
nameval name: String
ordinalval ordinal: Int

PROOF_OF_POSSESSION

PROOF_OF_POSSESSION

Used as a signature representing an authority's proof of possession of its authority key.

Properties

NameSummary
nameval name: String
ordinalval ordinal: Int

SENDER_SIGNED_TRANSACTION

SENDER_SIGNED_TRANSACTION

Used for an authority signature on a user signed transaction.

Properties

NameSummary
nameval name: String
ordinalval ordinal: Int

TRANSACTION_DATA

TRANSACTION_DATA

Used for a user signature on a transaction data.

Properties

NameSummary
nameval name: String
ordinalval ordinal: Int

TRANSACTION_EFFECTS

TRANSACTION_EFFECTS

Used for an authority signature on transaction effects.

Properties

NameSummary
nameval name: String
ordinalval ordinal: Int