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

