@xyo-network/xl1-validation


XYO Layer One SDK Validation
Reference
@xyo-network/xl1-validation
Type Aliases
Variables
Functions
functions
BoundWitnessReferencesValidator
@xyo-network/xl1-validation
function BoundWitnessReferencesValidator<T>(allowedSchemas?): HydratedBoundWitnessValidationFunction<T>;
Type Parameters
T
T extends BoundWitness = BoundWitness
Parameters
allowedSchemas?
string[]
Returns
HydratedBoundWitnessValidationFunction<T>
CompletedStepRewardAddressValidatorFactory
@xyo-network/xl1-validation
function CompletedStepRewardAddressValidatorFactory(allowedSigners): SignerValidator;
Parameters
allowedSigners
Address[]
Returns
SignerValidator
DerivedReceiveAddressValidatorFactory
@xyo-network/xl1-validation
function DerivedReceiveAddressValidatorFactory(allowedSigners, allowedScope): SignerValidator;
Parameters
allowedSigners
Address[]
allowedScope
string
Returns
SignerValidator
TransactionTransfersValidatorFactory
@xyo-network/xl1-validation
function TransactionTransfersValidatorFactory(signerValidators): HydratedTransactionValidationFunction<TransactionBoundWitness, {
step?: {
};
}>;
Parameters
signerValidators
SignerValidator[] = ...
Returns
HydratedTransactionValidationFunction<TransactionBoundWitness, {
step?: {
};
}>
validateTransaction
@xyo-network/xl1-validation
function validateTransaction(
tx,
context?,
additionalValidators?): Promise<Error[]>;
Parameters
tx
SignedHydratedTransactionWithStorageMeta
context?
ValidateTransactionContext
additionalValidators?
HydratedTransactionValidationFunction[] = []
Returns
Promise<Error[]>
type-aliases
SignerMapping
@xyo-network/xl1-validation
type SignerMapping = Map<Address, Address[]>;
SignerValidator
@xyo-network/xl1-validation
type SignerValidator = (signer, signee, context?) => boolean;
Parameters
signer
Address
signee
Address
context?
address?
Address
scope?
string
step?
StepIdentity
Returns
boolean
ValidateTransactionContext
@xyo-network/xl1-validation
type ValidateTransactionContext = object;
Properties
chainId?
optional chainId: ChainId;
step?
optional step: StepIdentity;
variables
BoundWitnessSignaturesValidator
@xyo-network/xl1-validation
const BoundWitnessSignaturesValidator: BoundWitnessValidationFunction;
SelfSignerValidator
@xyo-network/xl1-validation
const SelfSignerValidator: SignerValidator;
TransactionDurationValidator
@xyo-network/xl1-validation
const TransactionDurationValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
TransactionElevationValidator
@xyo-network/xl1-validation
const TransactionElevationValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
TransactionFromValidator
@xyo-network/xl1-validation
const TransactionFromValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
TransactionGasValidator
@xyo-network/xl1-validation
const TransactionGasValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
TransactionJsonSchemaValidator
@xyo-network/xl1-validation
const TransactionJsonSchemaValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
TransactionProtocolValidator
@xyo-network/xl1-validation
const TransactionProtocolValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
Maintainers
License
See the LICENSE file for license details
Credits
Made with 🔥 and ❄️ by XYO