@xyo-network/xl1-wrappers

XYO Layer One SDK Wrappers

Reference

@xyo-network/xl1-wrappers

Classes

• BaseWrapper
• FeesWrapper
• SignatureWrapper
• ChainWrapper
• HydratedTransactionWrapper

Interfaces

• BaseWrapperConfig

Functions

• createSignatureWrappers

classes

BaseWrapper

@xyo-network/xl1-wrappers

Extended by

• ChainWrapper

Type Parameters

T

T

C

C extends BaseWrapperConfig<T> = BaseWrapperConfig<T>

Constructors

Constructor

protected new BaseWrapper<T, C>(value, config): BaseWrapper<T, C>;

Parameters

value

T

config

Partial<C> = {}

Returns

BaseWrapper<T, C>

Properties

config

protected readonly config: Partial<C>;

value

protected readonly value: T;

Accessors

provider

Get Signature

get provider(): XyoConnection | undefined;

Returns

XyoConnection | undefined

Methods

create()

static create<T, C>(value, config): Promise<BaseWrapper<T, BaseWrapperConfig<T>>>;

Type Parameters

T

T

C

C extends BaseWrapperConfig<T> = BaseWrapperConfig<T>

Parameters

value

T

config

Partial<C> = {}

Returns

Promise<BaseWrapper<T, BaseWrapperConfig<T>>>

validateConfig()

static validateConfig(_config): PromisableArray<Error>;

Parameters

_config

unknown

Returns

PromisableArray<Error>

validateValue()

static validateValue(_value): PromisableArray<Error>;

Parameters

_value

unknown

Returns

PromisableArray<Error>

validate()

validate(): PromisableArray<Error>;

Returns

PromisableArray<Error>

ChainWrapper

@xyo-network/xl1-wrappers

Extends

• BaseWrapper<Address, BaseWrapperConfig<Address>>

Constructors

Constructor

protected new ChainWrapper(value, config): ChainWrapper;

Parameters

value

Address

config

Partial<C> = {}

Returns

ChainWrapper

Inherited from

BaseWrapper.constructor

Properties

config

protected readonly config: Partial<C>;

Inherited from

BaseWrapper.config

value

protected readonly value: Address;

Inherited from

BaseWrapper.value

Accessors

provider

Get Signature

get provider(): XyoConnection | undefined;

Returns

XyoConnection | undefined

Inherited from

BaseWrapper.provider

id

Get Signature

get id(): Address;

Returns

Address

Methods

create()

static create<T, C>(value, config): Promise<BaseWrapper<T, BaseWrapperConfig<T>>>;

Type Parameters

T

T

C

C extends BaseWrapperConfig<T> = BaseWrapperConfig<T>

Parameters

value

T

config

Partial<C> = {}

Returns

Promise<BaseWrapper<T, BaseWrapperConfig<T>>>

Inherited from

BaseWrapper.create

validateConfig()

static validateConfig(_config): PromisableArray<Error>;

Parameters

_config

unknown

Returns

PromisableArray<Error>

Inherited from

BaseWrapper.validateConfig

validateValue()

static validateValue(_value): PromisableArray<Error>;

Parameters

_value

unknown

Returns

PromisableArray<Error>

Inherited from

BaseWrapper.validateValue

validate()

validate(): PromisableArray<Error>;

Returns

PromisableArray<Error>

Inherited from

BaseWrapper.validate

FeesWrapper

@xyo-network/xl1-wrappers

Implements

• TransactionFeesInstance

Constructors

Constructor

new FeesWrapper(__namedParameters): FeesWrapper;

Parameters

__namedParameters

TransactionFeesHex | TransactionFeesBigInt

Returns

FeesWrapper

Properties

base

base: AttoXL1;

Implementation of

TransactionFeesInstance.base

gasLimit

gasLimit: AttoXL1;

Implementation of

TransactionFeesInstance.gasLimit

gasPrice

gasPrice: AttoXL1;

Implementation of

TransactionFeesInstance.gasPrice

priority

priority: AttoXL1;

Implementation of

TransactionFeesInstance.priority

Methods

validate()

static validate(__namedParameters): Promisable<Error[]>;

Parameters

__namedParameters

TransactionFeesHex | TransactionFeesBigInt

Returns

Promisable<Error[]>

validate()

validate(): Promise<Error[]>;

Returns

Promise<Error[]>

Implementation of

TransactionFeesInstance.validate

HydratedTransactionWrapper

@xyo-network/xl1-wrappers

Type Parameters

T

T extends HydratedTransactionWithStorageMeta

Implements

• HydratedTransactionInstance<[T[0], T[1][number][]]>

Constructors

Constructor

protected new HydratedTransactionWrapper<T>(data): HydratedTransactionWrapper<T>;

Parameters

data

T

Returns

HydratedTransactionWrapper<T>

Properties

data

data: T;

Implementation of

HydratedTransactionInstance.data

fees

fees: TransactionFeesInstance;

Implementation of

HydratedTransactionInstance.fees

payloadsCache

protected payloadsCache: WithStorageMeta<Payload>[] = [];

Accessors

boundWitness

Get Signature

get boundWitness(): T[0];

Returns

T[0]

Implementation of

HydratedTransactionInstance.boundWitness

elevatedPayloadCount

Get Signature

get elevatedPayloadCount(): number;

Returns

number

Implementation of

HydratedTransactionInstance.elevatedPayloadCount

elevatedPayloads

Get Signature

get elevatedPayloads(): WithStorageMeta<AllowedBlockPayload>[];

Returns

WithStorageMeta<AllowedBlockPayload>[]

Implementation of

HydratedTransactionInstance.elevatedPayloads

externalPayloads

Get Signature

get externalPayloads(): Record<Hash, Schema | Payload>;

Returns

Record<Hash, Schema | Payload>

Implementation of

HydratedTransactionInstance.externalPayloads

from

Get Signature

get from(): Address;

Returns

Address

payloadCount

Get Signature

get payloadCount(): number;

Returns

number

Implementation of

HydratedTransactionInstance.payloadCount

payloads

Get Signature

get payloads(): WithHashMeta<WithStorageMeta<T[1][number]>>[];

Returns

WithHashMeta<WithStorageMeta<T[1][number]>>[]

Implementation of

HydratedTransactionInstance.payloads

privateExternalPayloads

Get Signature

get privateExternalPayloads(): Record<Hash, Schema>;

Returns

Record<Hash, Schema>

Implementation of

HydratedTransactionInstance.privateExternalPayloads

publicExternalPayloads

Get Signature

get publicExternalPayloads(): Payload[];

Returns

Payload[]

Implementation of

HydratedTransactionInstance.publicExternalPayloads

signatureCount

Get Signature

get signatureCount(): number;

Returns

number

Implementation of

HydratedTransactionInstance.signatureCount

signatures

Get Signature

get signatures(): SignatureInstance[];

Returns

SignatureInstance[]

Implementation of

HydratedTransactionInstance.signatures

Methods

parse()

static parse<T>(transaction, validate): Promise<HydratedTransactionInstance<[T[0], T[1][number][]], AllowedBlockPayload>>;

Type Parameters

T

T extends HydratedTransactionWithStorageMeta

Parameters

transaction

T

validate

boolean = false

Returns

Promise<HydratedTransactionInstance<[T[0], T[1][number][]], AllowedBlockPayload>>

elevatedPayload()

elevatedPayload(index): WithHashMeta<AllowedBlockPayload & T[1][number]> | undefined;

Parameters

index

number

Returns

WithHashMeta<AllowedBlockPayload & T[1][number]> | undefined

Implementation of

HydratedTransactionInstance.elevatedPayload

gasRequired()

gasRequired(): bigint;

Returns

bigint

payload()

payload(index): WithStorageMeta<Payload> | undefined;

Parameters

index

number

Returns

WithStorageMeta<Payload> | undefined

Implementation of

HydratedTransactionInstance.payload

reward()

reward(): bigint;

Returns

bigint

Implementation of

HydratedTransactionInstance.reward

signature()

signature(index): SignatureInstance | undefined;

Parameters

index

number

Returns

SignatureInstance | undefined

Implementation of

HydratedTransactionInstance.signature

validate()

validate(): Promise<Error[]>;

Returns

Promise<Error[]>

Implementation of

HydratedTransactionInstance.validate

parse()

protected parse(validate): Promise<HydratedTransactionInstance<[WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]], AllowedBlockPayload>>;

Parameters

validate

boolean = false

Returns

Promise<HydratedTransactionInstance<[WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]], AllowedBlockPayload>>

SignatureWrapper

@xyo-network/xl1-wrappers

Implements

• SignatureInstance

Constructors

Constructor

new SignatureWrapper(
   signature, 
   address, 
   hash): SignatureWrapper;

Parameters

signature

Hex

address

Address

hash

Hash

Returns

SignatureWrapper

Properties

address

address: Address;

Implementation of

SignatureInstance.address

hash

hash: Hash;

Implementation of

SignatureInstance.hash

signature

signature: Hex;

Implementation of

SignatureInstance.signature

Methods

validate()

static validate(
   hash, 
   address, 
signature): Promise<Error[]>;

Parameters

hash

Hash

address

Address

signature

Hex

Returns

Promise<Error[]>

validate()

validate(): Promise<Error[]>;

Returns

Promise<Error[]>

Implementation of

SignatureInstance.validate

functions

createSignatureWrappers

@xyo-network/xl1-wrappers

function createSignatureWrappers(bw): Promise<SignatureInstance[]>;

Parameters

bw

BoundWitness

Returns

Promise<SignatureInstance[]>

interfaces

BaseWrapperConfig

@xyo-network/xl1-wrappers

Type Parameters

T

T

Properties

provider

provider: XyoConnection;

value

value: T;

Maintainers

• Arie Trouw (arietrouw.com)
• Matt Jones
• Joel Carter
• Jordan Trouw

License

See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYO