Crate pallet_housing_fund
source ·Expand description
Housing fund pallet
The housing fund pallet provides methods to manage the fund used to buy houses
Overview
The housing fund pallet enable third parties to transfer or withdraw funds to a common pot for house purchase
Interface
Dispatchable Functions
- ‘contribute_to_fund’ - an account with the investor role can transfer funds to the pot
- ‘withdraw_fund’ - an account with the investor role can withdraw funds from the pot if the amount is available
Re-exports
pub use pallet_nft as NFT;pub use pallet_roles as ROLES;pub use weights::WeightInfo;pub use pallet::*;pub use super::*;Modules
Stuff to do with the runtime’s storage.
Autogenerated weights for pallet_housing_fund
Macros
Evaluate
$x:expr and if not true return Err($y:expr).Structs
Hash storage keys with blake2 128
Hash storage keys with
concat(blake2_128(key), key)Hash storage keys with blake2 256
A bounded vector.
Const getter for a basic type.
A wrapper around a
StorageMap and a StorageValue<Value=u32> to keep track of how many items
are in a map, without needing to iterate all the values.Implement Get by returning Default for any type that implements Default.
Store the key directly.
Inherent data to include in a block.
A type used exclusively by storage maps as their key type.
Implement QueryKindTrait with query being
Option<Value>A pallet identifier. These are per pallet and should be stored in a registry somewhere.
Zero-sized type used to mark things that “act like” they own a
T.Implement QueryKindTrait with query being
Result<Value, PalletError>A type that allow to store values for
(key1, key2) couple. Similar to StorageMap but allow
to iterate and remove value associated to first key.A type that allow to store value for given key. Allowing to insert/remove/iterate on values.
A type that allow to store values for an arbitrary number of keys in the form of
(Key<Hasher1, key1>, Key<Hasher2, key2>, ..., Key<HasherN, keyN>).A type that allow to store a value.
The storage version of a pallet.
Hash storage keys with
concat(twox64(key), key)Hash storage keys with twox 128
Hash storage keys with twox 256
Information concerning a valid transaction.
Implement QueryKindTrait with query being
ValueA contiguous growable array type, written as
Vec<T>, short for ‘vector’.Reasons for moving funds out of an account.
Enums
A generalized group of dispatch types.
Reason why a dispatch call failed.
Simple boolean for whether an account needs to be kept in existence.
An invalid transaction validity.
Explicit enum to denote if a transaction pays fee or not.
The source of the transaction.
Errors that can occur while checking the validity of a transaction.
An unknown transaction validity.
Constants
The number of bytes of the module-specific
error field defined in [ModuleError].
In FRAME, this is the maximum encoded size of a pallet error type.Traits
This type can be converted into and possibly from an AccountId (which itself is generic).
Abstraction over a fungible assets system.
Trait that allows zero-copy read of value-references from slices in LE format.
Trait that allows zero-copy write of value-references to slices in LE format.
Some sort of check on the origin is performed by this object.
A trait to define the build function of a genesis config, T and I are placeholder for pallet
trait and pallet instance.
A trait for querying a single value from a type.
Provides information about the storage version of a pallet.
The pallet hooks trait. Implementing this lets you express some logic to execute.
Trait to be used when types are exactly same.
Items implementing
MaxEncodedLen have a statically known maximum encoded size.A type that implements Serialize, DeserializeOwned and Debug when in std environment.
A type that can be used in runtime structures.
Provides information about the pallet itself and its setup in the runtime.
A type that can be used as a parameter in a dispatchable function.
A pallet that provides or verifies an inherent extrinsic will implement this trait.
A currency where funds can be reserved from the user.
A trait to give information about storage.
Implementors return their meta type information.
A trait for querying a single value from a type defined in the trait.
Something that can validate unsigned extrinsics for the transaction pool.
Defines an additive identity element for
Self.Functions
Ensure that the origin
o represents an unsigned extrinsic. Returns Ok or an Err otherwise.Ensure that the origin
o represents the root. Returns Ok or an Err otherwise.Ensure that the origin
o represents a signed extrinsic (i.e. transaction).
Returns Ok with the account that signed the extrinsic or an Err otherwise.Ensure that the origin
o represents either a signed extrinsic (i.e. transaction) or the root.
Returns Ok with the account that signed the extrinsic, None if it was root, or an Err
otherwise.Type Definitions
Type alias for the
BlockNumber associated type of system config.Unaugmented version of
DispatchResultWithPostInfo that can be returned from
dispatchable functions and is automatically converted to the augmented type. Should be
used whenever the PostDispatchInfo does not need to be overwritten. As this should
be the common case it is the implicit return type when none is specified.The return type of a
Dispatchable in frame. When returned explicitly from
a dispatchable function it allows overriding the default PostDispatchInfo
returned from a dispatch.An identifier for an inherent.
Type alias for the
Origin associated type of system config.Minimum number of blocks a transaction will remain valid for.
TransactionLongevity::max_value() means “forever”.Priority for a transaction. Additive. Higher is better.
Tag for a transaction. No two transactions with the same tag should be placed on-chain.
Information on a transaction’s validity and, if valid, on how it relates to other transactions.
Attribute Macros
Execute the annotated function in a new storage transaction.
Derive Macros
Derive
Clone but do not bound any generic. Docs are at frame_support::CloneNoBound.Derive
Debug but do not bound any generics. Docs are at frame_support::DebugNoBound.Derive
parity_scale_codec::Decode and for struct and enum.Derive
parity_scale_codec::Encode and parity_scale_codec::EncodeLike for struct and enum.derive Eq but do no bound any generic. Docs are at
frame_support::EqNoBound.Derive
parity_scale_codec::MaxEncodedLen for struct and enum.Derive
PartialEq but do not bound any generic. Docs are at
frame_support::PartialEqNoBound.Derive
Debug, if std is enabled it uses frame_support::DebugNoBound, if std is not
enabled it just returns "<stripped>".
This behaviour is useful to prevent bloating the runtime WASM blob from unneeded code.