Module prelude

Source

Expand description

Scrypto preludes.

Re-exports§

pub extern crate radix_common;
pub extern crate sbor;
pub use crate::engine::scrypto_env::ScryptoVmV1Api;
pub use crate::component::*;
pub use crate::crypto_utils::*;
pub use crate::engine::*;
pub use crate::modules::*;
pub use crate::resource::*;
pub use crate::runtime::*;

Modules§

actor_api
actor_index_api
actor_key_value_entry_api
actor_sorted_index_api
additional_attributes: Documentation for Additional Attributes
basic: SBOR basic, no custom types
blueprint_api
bnum_integer: Definitions of safe integers and uints.
borrow: A module for working with borrowed data.
btree_map
btree_set
categorize: SBOR Categorize trait
codec: SBOR codec for core Rust types.
constants: SBOR constants
costing_api
decimal
decode: SBOR decode trait.
decoder: SBOR decoding.
encode: SBOR encode trait.
encoded_wrappers: SBOR payload wrappers. These are new types around an encoded payload or sub-payload, with helper methods / traits implemented. They can be used as a more efficient wrapper a ScryptoValue if the content of that value is not needed.
encoder: SBOR encoding.
execution_trace_api
field_api
fmt: Utilities for formatting and printing Strings.
hash_map
hash_set
index_map: The methods and macros provided directly in this index_map module (new, with_capacity) work in both std and no-std modes - unlike the corresponding methods on IndexMap itself.
index_set: The methods and macros provided directly in this index_set module (new, with_capacity) work in both std and no-std modes - unlike the corresponding methods on IndexSet itself.
indexmap: IndexMap is a hash table where the iteration order of the key-value pairs is independent of the hash values of the keys.
instant
key_value_entry_api
key_value_store_api
mem: Basic functions for dealing with memory.
non_iter_map
object_api
paste: github crates-io docs-rs
path: SBOR paths.
payload_validation: SBOR payload validation.
precise_decimal
prelude: Each module should have its own prelude, which:
representations: SBOR textual representations
rounding_mode
rust: A facade of Rust types.
schema: SBOR Schema
test_addresses
traits
transaction_runtime_api
traversal: SBOR structured payload traversal.
utc_date_time
value: SBOR value model and any decoding/encoding.
value_kind: SBOR value kinds - ie the types of value that are supported.
vec: A contiguous growable array type with heap-allocated contents, written Vec<T>.
vec_traits: Simpler traits specific to encodability/decodability against vec-based encoders/decoders
versioned: Data model versioning helper macro
well_known_scrypto_custom_types

Macros§

access_and_or
assert_matches: Attempts to be a replacement for assert!(matches!(...)) but with better error messages, and allowing further code on success.
btreemap
btreeset
burn_roles
component_royalties
component_royalty_config
composite_requirement
create_well_known_lookup
debug
dec: Creates a Decimal from literals. It is a compile-time macro. It allows to declare constants and statics. Example: const D1: Decimal = dec!(“1111.11111”) const D2: Decimal = dec!(“-1111.11111”) const D3: Decimal = dec!(1) const D4: Decimal = dec!(-1_0000_000_u128)
define_single_versioned: This macro is intended for creating a data model which supports versioning. This is useful for creating an SBOR data model which can be updated in future.
define_versioned: This macro is intended for creating a data model which supports versioning. This is useful for creating an SBOR data model which can be updated in future. In future, enum variants can be added, and automatically mapped to.
define_wrapped_hash
deposit_roles
eager_replace: NOTE: This should probably be moved out of sbor to its own crate.
enable_function_auth
enable_method_auth
enable_package_royalties
error
extern_blueprint_internal
format: Creates a String using interpolation of runtime expressions.
freeze_roles
hashmap
hashset
i: Creates a safe integer from literals. You must specify the type of the integer you want to create.
indexmap
indexset
info
internal_add_role
internal_component_royalty_entry
internal_roles
labelled_resolvable_using_resolvable_impl
labelled_resolvable_with_identity_impl
look_up_type
main_accessibility
manifest_args
metadata
metadata_init
metadata_init_set_entry
metadata_roles
method_accessibilities
method_accessibility
mint_roles
non_fungible_data_update_roles
numeric_validation_match
pdec: Creates a PreciseDecimal from literals. It is a compile-time macro. It allows to declare constants and statics. Example: const D1: PreciseDecimal = pdec!(“1111.11111”) const D2: PreciseDecimal = pdec!(“-1111.11111”) const D3: PreciseDecimal = pdec!(1) const D4: PreciseDecimal = pdec!(-1_0000_000_u128)
recall_roles
resolvable_with_identity_impl
resolvable_with_try_into_impls
return_type_mismatch_error
role_entry
role_list
roles: Roles macro for main module
roles2
rule
scrypto_args
to_manifest_value_and_unwrap
to_role_key
trace
vec: Creates a Vec containing the arguments.
warn
withdraw_roles

Structs§

Enums§

Constants§

Statics§

Traits§

AccessRuleVisitor
ArrayMetadataVal
AsMut: Used to do a cheap mutable-to-mutable reference conversion.
AsRef: Used to do a cheap reference-to-reference conversion.
AsStaticRefDeprecated: A cheap reference-to-reference conversion. Used to convert a value to a reference value with 'static lifetime within generic code.
BasicCategorize
BasicDecode
BasicDescribe
BasicEncode
BasicSbor
BasicSborEnum
BasicSborEnumVariantFor
BasicSborTuple
BlueprintPartitionOffset
BorrowingDecoder
Categorize: The Categorize trait marks a rust type as having a fixed value kind for SBOR encoding/decoding.
Cbrt
CheckedAdd
CheckedBackwardsCompatibleSchema
CheckedDiv
CheckedFixedSchema: Marker traits intended to be implemented by the SborAssert macros
CheckedMul
CheckedNeg
CheckedSub
CheckedTruncate
Clone: A common trait that allows explicit creation of a duplicate value.
CollectionDescriptor
ComparableSchema: Marker trait for SingleTypeSchema and TypeCollectionSchema which includes named pointers to types, and can be used for comparisons of different versions of the same schema.
ContextualDisplay: This trait is used where context is required to correctly display a value.
ContextualTryFrom
ContextualTryInto
Copy: Types whose values can be duplicated simply by copying bits.
CustomExtension
CustomSchema
CustomTypeKind
CustomTypeKindLabel
CustomTypeValidation
CustomValue: Represents a custom SBOR value.
CustomValueKind
Debug: ? formatting.
Decode: A data structure that can be decoded from a byte array using SBOR.
Decoder
Default: A trait for giving a type a useful default value.
Describe: The Describe trait allows a type to describe how to interpret and validate a corresponding SBOR payload.
Display: Format trait for an empty format, {}.
DoubleEndedIterator: An iterator able to yield elements from both ends.
Drop: Custom code within the destructor.
Encode: A data structure that can be serialized into a byte array using SBOR.
Encoder
EnumCount: A trait for capturing the number of variants in Enum. This trait can be autoderived by strum_macros.
EnumMessage: Associates additional pieces of information with an Enum. This can be autoimplemented by deriving EnumMessage and annotating your variants with #[strum(message="...")].
EnumProperty: EnumProperty is a trait that makes it possible to store additional information with enum variants. This trait is designed to be used with the macro of the same name in the strum_macros crate. Currently, the only string literals are supported in attributes, the other methods will be implemented as additional attribute types become stabilized.
Eq: Trait for comparisons corresponding to equivalence relations.
ExactSizeIterator: An iterator that knows its exact length.
Extend: Extend a collection with the contents of an iterator.
FieldDescriptor
FieldPayloadMarker
Fn: The version of the call operator that takes an immutable receiver.
FnMut: The version of the call operator that takes a mutable receiver.
FnOnce: The version of the call operator that takes a by-value receiver.
ForWithdrawal
From: Used to do value-to-value conversions while consuming the input value. It is the reciprocal of Into.
FromIterator: Conversion from an Iterator.
FromPrimitive: A generic trait for converting a number to a value.
FromPublicKey
FromStr: Parse a value from a string
HasPublicKeyHash
HasSchemaHash
Into: A value-to-value conversion that consumes the input value. The opposite of From.
IntoComparableSchema
IntoEnumIterator: This trait designates that an Enum can be iterated over. It can be auto generated using strum_macros on your behalf.
IntoIterator: Conversion into an Iterator.
IsHash
IsNonAutoGeneratedNonFungibleLocalId: Marks the rust type that represents a non-fungible id, of non-auto-generated kind (i.e. String, Integer and Bytes).
IsNonFungibleLocalId: Marks the rust type that represents a non-fungible id, of any kind (i.e. String, Integer, Bytes and RUID).
IsPublicKeyHash
IsSborFixedEnumVariant
Iterator: A trait for dealing with iterators.
LabelResolver
LabelledResolvable: LabelledResolvable is a marker trait, serving a few purposes:
LabelledResolve: This trait is intended to be used as an impl argument in helper methods, to accept a wider range of arguments.
LabelledResolveFrom: The inverse trait of LabelledResolve.
ManifestCategorize
ManifestDecode
ManifestEncode
ManifestSborEnum
ManifestSborEnumVariantFor
ManifestSborTuple
MetadataVal
NonFungibleData: Represents the data structure of a non-fungible.
NthRoot
NumericValidationBound
One: Defines a multiplicative identity element for Self.
Ord: Trait for types that form a total order.
PartialEq: Trait for comparisons using the equality operator.
PartialOrd: Trait for types that form a partial order.
Pow: Binary operator for raising a value to a power.
Resolvable: Resolvable is a marker trait, mainly to make resolution opt-in and to avoid polluting every type with a resolve method.
ResolvableOptionalSubstateKey
ResolvableStaticManifestPackageAddress: This trait resolves a static resource address for manifest instructions which (as of Cuttlefish) only support a fixed address.
ResolvableStaticManifestResourceAddress: This trait resolves a static resource address for manifest instructions which (as of Cuttlefish) only support a fixed address.
ResolvableSubstateKey
Resolve: This trait is intended to be used as an impl argument in helper methods, to accept a wider range of arguments.
ResolveFrom: The inverse trait of Resolve.
SaturatingAdd
SborCustomValue: Represents a custom SBOR value.
SborEnum: Marker trait for encoding as an Sbor Enum
SborEnumVariantFor: This trait is output for unique unskipped single children of enum variants, when #[sbor(impl_variant_traits)] is specified on an Enum or #[sbor(impl_variant_trait)] is specified on a single Enum variant.
SborTuple: Marker trait for encoding as an Sbor Tuple
SchemaTypeLink: Marker trait for a link between TypeKinds:
ScryptoCategorize
ScryptoCheckedBackwardsCompatibleSchema
ScryptoCheckedFixedSchema
ScryptoDecode
ScryptoDescribe
ScryptoEncode
ScryptoEvent
ScryptoSbor
ScryptoSborEnum
ScryptoSborEnumVariantFor
ScryptoSborTuple
Send: Types that can be transferred across thread boundaries.
Signed: Useful functions for signed numbers (i.e. numbers that can be negative).
SingleMetadataVal
Sized: Types with a constant size known at compile time.
Sqrt
Sync: Types for which it is safe to share references between threads.
SystemActorApi: Api which exposes methods in the context of the actor
SystemActorIndexApi: Api to manage an iterable index
SystemActorKeyValueEntryApi
SystemActorSortedIndexApi
SystemApi: Interface of the system, for blueprints and object modules.
SystemApiError
SystemBlueprintApi
SystemCostingApi
SystemExecutionTraceApi
SystemFieldApi: System api to read/write fields
SystemKeyValueEntryApi
SystemKeyValueStoreApi
SystemObjectApi: A high level interface to manipulate objects in the actor’s call frame
SystemTransactionRuntimeApi
ToMetadataEntry
ToOwned: A generalization of Clone to borrowed data.
ToPrimitive: A generic trait for converting a value to a number.
ToRoleEntry
ToString: A trait for converting a value to a String.
TryFrom: Simple and safe type conversions that may fail in a controlled way under some circumstances. It is the reciprocal of TryInto.
TryInto: An attempted conversion that consumes self, which may or may not be expensive.
UniqueVersioned: A trait for Versioned types which only have a single version.
Unpin: Types that do not require any pinning guarantees.
ValidatableCustomExtension
ValueVisitor
VariantNames: A trait for retrieving the names of each variant in Enum. This trait can be autoderived by strum_macros.
Versioned: A trait implemented by versioned types created via define_versioned and define_single_versioned.
VersionedSchemaVersion
Zero: Defines an additive identity element for Self.

Functions§

access_rule_type_data
aggregate_verify_bls12381_v1: Performs BLS12-381 G2 aggregated signature verification of multiple messages each signed with different key. Domain specifier tag: BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_POP_
always_visible_global_nodes
assert_type_backwards_compatibility: Designed for ensuring a type is only altered in ways which ensure backwards compatibility in SBOR serialization (i.e. that old payloads can be deserialized correctly by the latest type).
assert_type_collection_backwards_compatibility: Designed for ensuring a type collection is only altered in ways which ensure backwards compatibility in SBOR serialization (i.e. that old payloads of named types can be deserialized correctly by the latest schema).
attached_module_id_type_data
basic_decode: Decode an instance of T from a slice.
basic_decode_with_depth_limit
basic_decode_with_depth_limit_and_nice_error: Decodes a data structure from a byte array.
basic_decode_with_nice_error: Decodes a data structure from a byte array.
basic_encode: Encode a T into byte array.
basic_encode_with_depth_limit
basic_payload_traverser: Creates a payload traverser from the buffer
basic_requirement_type_data
bech32_encode_to_fmt: NOTE: The below code is copied with minor alterations from the bech32 crate. These alterations are to avoid using std for allocations, and fit with the sbor no-alloc options.
blake2b_256_hash
check_fungible_amount
check_non_fungible_amount
combine: Combines a u8 with a u8 slice.
compare_single_type_schemas: Designed for basic comparisons between two types, e.g. equality checking.
compare_type_collection_schemas: Designed for basic comparisons between two type collection schemas, e.g. equality checking.
component_address
component_address_type_data
composite_requirement_list_type_data
composite_requirement_type_data
copy_u8_array: Copies a slice to a fixed-sized array.
decimal_type_data
drop: Disposes of a value.
ed25519_public_key_hash_type_data
ed25519_public_key_type_data
fast_aggregate_verify_bls12381_v1: Performs BLS12-381 G2 aggregated signature verification one message signed with multiple keys. Domain specifier tag: BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_POP_ This method validates provided input keys when aggregating.
fast_aggregate_verify_bls12381_v1_anemone: Performs BLS12-381 G2 aggregated signature verification one message signed with multiple keys. Domain specifier tag: BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_POP_ This method does not validate provided input keys when aggregating, it is left here for backward compatibility. It is recommended to use fast_aggregate_verify_bls12381_v1() method instead.
from_manifest_value
generate_full_schema: You may wish to use the newer aggregator.generate_type_collection_schema() which, in tandom with add_named_root_type_and_descendents also captures named root types to give more structure to enable schema comparisons over time.
generate_full_schema_from_single_type
generate_single_type_schema
global_address_type_data
global_caller: A requirement for the global ancestor of the actor who made the latest global call to either be:
hash: Computes the hash digest of a message.
hash_map_new: Creates an empty map with capacity 0 and default Hasher
hash_map_with_capacity: Creates an empty map with given capacity and default Hasher
hash_public_key_bytes
hash_set_new: Creates an empty set with capacity 0 and default Hasher
hash_set_with_capacity: Creates an empty set with given capacity and default Hasher
index_map_new: This is safe for std and no-std use cases (unlike IndexMap::new which disappears when std is not in the toolchain - see this article for deep technical reasons)
index_map_with_capacity: This is safe for std and no-std use cases (unlike IndexMap::with_capacity which disappears when std is not in the toolchain - see this article for deep technical reasons)
index_set_new: This is safe for std and no-std use cases (unlike IndexSet::new which disappears when std is not in the toolchain - see this article for deep technical reasons)
index_set_with_capacity: This is safe for std and no-std use cases (unlike IndexSet::with_capacity which disappears when std is not in the toolchain - see this article for deep technical reasons)
instant_type_data
internal_address_type_data
keccak256_hash
local_address
localize_well_known
localize_well_known_type_data
manifest_decode
manifest_decode_with_depth_limit
manifest_decode_with_depth_limit_and_nice_error: Decodes a data structure from a byte array.
manifest_decode_with_nice_error: Decodes a data structure from a byte array.
manifest_encode
manifest_encode_with_depth_limit
module_id_type_data
non_fungible_global_id_type_data
non_fungible_local_id_type_data
origin_type_data
own_bucket_type_data
own_fungible_bucket_type_data
own_fungible_proof_type_data
own_fungible_vault_type_data
own_global_address_reservation_type_data
own_key_value_store_type_data
own_non_fungible_bucket_type_data
own_non_fungible_proof_type_data
own_non_fungible_vault_type_data
own_proof_type_data
own_type_data
own_vault_type_data
owner_role_type_data
package_address
package_address_type_data
package_of_direct_caller: A requirement for the immediate caller’s package to equal the given package.
precise_decimal_type_data
public_key_hash_type_data
public_key_type_data
reference_type_data
replace_self_package_address
require
require_all_of
require_amount
require_any_of
require_n_of
resolve_invoked_blueprint_id: This function resolves the BlueprintId of the invoked blueprint given the BlueprintId of the main module and the ModuleId being invoked.
resolve_local_type_id
resolve_main_module_blueprint_id: This function resolves the BlueprintId based on the entity type for native blueprints.
resolve_scrypto_well_known_type
resource_address
resource_address_type_data
resource_or_non_fungible_list_type_data
resource_or_non_fungible_type_data
role_key_type_data
royalty_amount_type_data
scrypto_decode: Decodes a data structure from a byte array.
scrypto_decode_with_depth_limit
scrypto_decode_with_depth_limit_and_nice_error: Decodes a data structure from a byte array.
scrypto_decode_with_nice_error: Decodes a data structure from a byte array.
scrypto_encode: Encodes a data structure into byte array.
scrypto_encode_with_depth_limit
secp256k1_public_key_hash_type_data
secp256k1_public_key_type_data
signature: A requirement for the transaction to be signed using a specific key.
system_execution: A requirement for the transaction to be a system transaction.
to_manifest_value
traverse_any: ============================================== (DEPRECATED) TRAVERSAL
url_type_data
utc_date_time_type_data
validate_childless_metadata
validate_container
validate_custom_type_validation
validate_enum_metadata
validate_field_names
validate_index
validate_partial_payload_against_schema
validate_payload_against_schema
validate_schema
validate_schema_enum_variant_name
validate_schema_field_name
validate_schema_type_name
validate_terminal_value
validate_terminal_value_batch
validate_tuple_metadata
validate_type_kind
validate_type_metadata_with_type_kind
verify_bls12381_v1: Performs BLS12-381 G2 signature verification. Domain specifier tag: BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_POP_
verify_ed25519

Type Aliases§

Attribute Macros§

blueprint: Declares a blueprint.

Derive Macros§

AsRefStr: Converts enum variants to &'static str.
AsStaticStr
BasicCategorize: Derive code that returns the value kind - specifically for Basic SBOR.
BasicDecode: Derive code that decodes this data structure from a byte array - specifically for Basic SBOR.
BasicDescribe: Derive code that describes the type - specifically for Basic SBOR.
BasicEncode: Derive code that encodes this data structure - specifically for Basic SBOR.
BasicSbor: A shortcut for BasicCategorize, BasicEncode, BasicDecode, and BasicDescribe derives.
BasicSborAssertion: A macro for outputting tests and marker traits to assert that a type has maintained its shape over time.
Categorize: Derive code that returns the value kind.
Clone: Derive macro generating an impl of the trait Clone.
Copy: Derive macro generating an impl of the trait Copy.
Debug: Derive macro generating an impl of the trait Debug.
Decode: Derive code that decodes this data structure from a byte array.
Default: Derive macro generating an impl of the trait Default.
Describe: Derive code that describes this type.
Display: Converts enum variants to strings.
Encode: Derive code that encodes this data structure
EnumCount: Add a constant usize equal to the number of variants.
EnumDiscriminants: Generate a new type with only the discriminant names.
EnumIter: Creates a new type that iterates of the variants of an enum.
EnumMessage: Add a verbose message to an enum variant.
EnumProperty: Add custom properties to enum variants.
EnumString: Converts strings to enum variants based on their name.
EnumVariantNames: Implements Strum::VariantNames which adds an associated constant VARIANTS which is an array of discriminant names.
Eq: Derive macro generating an impl of the trait Eq.
FromRepr: Add a function to enum that allows accessing variants by its discriminant
IntoStaticStr: Implements From<MyEnum> for &'static str on an enum.
ManifestCategorize: Derives code for categorizing a struct or enum with Manifest value model.
ManifestDecode: Derives code for decoding a struct or enum with Manifest value model.
ManifestEncode: Derives code for encoding a struct or enum with Manifest value model.
ManifestSbor: A shortcut for ManifestCategorize, ManifestEncode and ManifestDecode derives.
NonFungibleData: Derive code that describe a non-fungible data structure.
Ord: Derive macro generating an impl of the trait Ord. The behavior of this macro is described in detail here.
PartialEq: Derive macro generating an impl of the trait PartialEq. The behavior of this macro is described in detail here.
PartialOrd: Derive macro generating an impl of the trait PartialOrd. The behavior of this macro is described in detail here.
PermitSborAttributes: An empty derive which exists solely to allow the helper “sbor” attribute to be used without generating a compile error.
Sbor: A shortcut for Categorize, Encode, Decode, and Describe derives.
ScryptoCategorize: Derives code for categorizing a struct or enum with Scrypto value model.
ScryptoDecode: Derives code for decoding a struct or enum with Scrypto value model.
ScryptoDescribe: Derives code for describing a struct or enum with Scrypto schema.
ScryptoEncode: Derives code for encoding a struct or enum with Scrypto value model.
ScryptoEvent: Derive code for implementing the required logic to mark a type as being an event.
ScryptoSbor: A shortcut for ScryptoCategorize, ScryptoEncode, ScryptoDecode, and ScryptoDescribe derives.
ScryptoSborAssertion: A macro for outputting tests and marker traits to assert that a type has maintained its shape over time.
ToString: implements std::string::ToString on en enum

Module preludeCopy item path

Re-exports§

Modules§

Macros§

Structs§

Enums§

Constants§

Statics§

Traits§

Functions§

Type Aliases§

Attribute Macros§

Derive Macros§

Module prelude