@xyo-network/chain-wrappers

XYO Layer One SDK Wrappers

Reference

@xyo-network/chain-wrappers

Classes

• HydratedBlockWrapper
• IndexedHydratedBlockRangeStore
• BaseWrapper
• FeesWrapper
• SignatureWrapper
• ChainWrapper
• HydratedTransactionWrapper

Interfaces

• HydratedBlockStoreInstance
• IndexedHydratedBlockStoreInstance
• HydratedBlockRangeStoreParams
• IndexedHydratedBlockRangeStoreInstance
• BaseWrapperConfig

Type Aliases

• HydratedBlockStoreParams

Variables

• createSignatureWrappers

classes

BaseWrapper

@xyo-network/chain-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/chain-wrappers

Extends

• BaseWrapper<Address, BaseWrapperConfig<Address>>

Constructors

Constructor

protected new ChainWrapper(value, config?): ChainWrapper;

Parameters

value

Address

config?

Partial<BaseWrapperConfig<Address>>

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/chain-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

HydratedBlockWrapper

@xyo-network/chain-wrappers

Type Parameters

T

T extends HydratedBlock

Implements

• HydratedBlockInstance<[WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]]>

Constructors

Constructor

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

Parameters

data

[WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]]

Returns

HydratedBlockWrapper<T>

Properties

data

data: [WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]];

Implementation of

HydratedBlockInstance.data

allPayloadsCache

protected allPayloadsCache: WithHashMeta<WithHashMeta<T[1][number]>>[] = [];

transactionsCache

protected transactionsCache: HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>[] = [];

Accessors

block

Get Signature

get block(): number & object & object;

Returns

number & object & object

boundWitness

Get Signature

get boundWitness(): WithHashMeta<T[0]>;

Returns

WithHashMeta<T[0]>

Implementation of

HydratedBlockInstance.boundWitness

chain

Get Signature

get chain(): Hex;

Returns

Hex

parseErrors

Get Signature

get parseErrors(): Error[];

Returns

Error[]

payloadCount

Get Signature

get payloadCount(): number;

Returns

number

Implementation of

HydratedBlockInstance.payloadCount

payloads

Get Signature

get payloads(): T[1][number][];

Returns

T[1][number][]

Implementation of

HydratedBlockInstance.payloads

reward

Get Signature

get reward(): bigint;

Returns

bigint

Implementation of

HydratedBlockInstance.reward

signatureCount

Get Signature

get signatureCount(): number;

Returns

number

Implementation of

HydratedBlockInstance.signatureCount

signatures

Get Signature

get signatures(): SignatureInstance[];

Returns

SignatureInstance[]

Implementation of

HydratedBlockInstance.signatures

stepHashes

Get Signature

get stepHashes(): Hash[];

Returns

Hash[]

transactionCount

Get Signature

get transactionCount(): number;

Returns

number

Implementation of

HydratedBlockInstance.transactionCount

transactions

Get Signature

get transactions(): HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>[];

Returns

HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>[]

Implementation of

HydratedBlockInstance.transactions

Methods

parse()

static parse<T>(block, validate): Promise<HydratedBlockInstance<HydratedBlock>>;

Type Parameters

T

T extends HydratedBlock

Parameters

block

T

validate

boolean = false

Returns

Promise<HydratedBlockInstance<HydratedBlock>>

payload()

payload(index): WithHashMeta<T[1][number]> | undefined;

Parameters

index

number

Returns

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

Implementation of

HydratedBlockInstance.payload

signature()

signature(index): SignatureInstance | undefined;

Parameters

index

number

Returns

SignatureInstance | undefined

Implementation of

HydratedBlockInstance.signature

transaction()

transaction(index): 
  | HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>
  | undefined;

Parameters

index

number

Returns

| HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload> | undefined

Implementation of

HydratedBlockInstance.transaction

validate()

validate(): Promise<Error[]>;

Returns

Promise<Error[]>

Implementation of

HydratedBlockInstance.validate

validateState()

validateState(services): Promise<Error[]>;

Parameters

services

accountBalance

AccountBalanceService

Returns

Promise<Error[]>

parse()

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

Parameters

validate

boolean = false

Returns

Promise<HydratedBlockInstance<[WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]]>>

HydratedTransactionWrapper

@xyo-network/chain-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

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

Returns

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

IndexedHydratedBlockRangeStore

@xyo-network/chain-wrappers

Extends

• BaseEmitter<HydratedBlockRangeStoreParams>

Implements

• IndexedHydratedBlockRangeStoreInstance

Constructors

Constructor

protected new IndexedHydratedBlockRangeStore(
   params, 
   firstNumber, 
   lastNumber): IndexedHydratedBlockRangeStore;

Parameters

params

HydratedBlockRangeStoreParams

firstNumber

number

lastNumber

number

Returns

IndexedHydratedBlockRangeStore

Overrides

BaseEmitter<HydratedBlockRangeStoreParams>.constructor

Accessors

count

Get Signature

get count(): number;

Returns

number

Implementation of

IndexedHydratedBlockRangeStoreInstance.count

numberRange

Get Signature

get numberRange(): [number, number];

Returns

[number, number]

Implementation of

IndexedHydratedBlockRangeStoreInstance.numberRange

range

Get Signature

get range(): [Hash, Hash];

Returns

[Hash, Hash]

Implementation of

IndexedHydratedBlockRangeStoreInstance.range

Methods

create()

static create(params): Promise<IndexedHydratedBlockRangeStore>;

Parameters

params

HydratedBlockRangeStoreParams

Returns

Promise<IndexedHydratedBlockRangeStore>

first()

first(): Promise<HydratedBlock>;

Returns

Promise<HydratedBlock>

Implementation of

IndexedHydratedBlockRangeStoreInstance.first

fromHash()

fromHash(hash): Promise<HydratedBlock | undefined>;

Parameters

hash

Hash

Returns

Promise<HydratedBlock | undefined>

Implementation of

IndexedHydratedBlockRangeStoreInstance.fromHash

fromNumber()

fromNumber(number): Promisable<HydratedBlock | undefined>;

Parameters

number

number

Returns

Promisable<HydratedBlock | undefined>

Implementation of

IndexedHydratedBlockRangeStoreInstance.fromNumber

last()

last(): Promise<HydratedBlock>;

Returns

Promise<HydratedBlock>

Implementation of

IndexedHydratedBlockRangeStoreInstance.last

next()

Call Signature

next(from): Promise<HydratedBlock | undefined>;

Parameters

from

HydratedBlock

Returns

Promise<HydratedBlock | undefined>

Implementation of

IndexedHydratedBlockRangeStoreInstance.next

Call Signature

next(from, count): Promise<HydratedBlock[]>;

Parameters

from

HydratedBlock

count

number

Returns

Promise<HydratedBlock[]>

Implementation of

IndexedHydratedBlockRangeStoreInstance.next

prev()

Call Signature

prev(from): Promise<HydratedBlock | undefined>;

Parameters

from

HydratedBlock

Returns

Promise<HydratedBlock | undefined>

Implementation of

IndexedHydratedBlockRangeStoreInstance.prev

Call Signature

prev(from, count): Promise<HydratedBlock[]>;

Parameters

from

HydratedBlock

count

number

Returns

Promise<HydratedBlock[]>

Implementation of

IndexedHydratedBlockRangeStoreInstance.prev

SignatureWrapper

@xyo-network/chain-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

interfaces

BaseWrapperConfig

@xyo-network/chain-wrappers

Type Parameters

T

T

Properties

provider

provider: XyoConnection;

value

value: T;

HydratedBlockRangeStoreParams

@xyo-network/chain-wrappers

Extends

• HydratedBlockStoreParams<{ first: Hash; last: Hash; snapshotArchivist: ArchivistInstance; }>

Properties

sourceArchivist

sourceArchivist: ArchivistInstance;

Inherited from

HydratedBlockStoreParams.sourceArchivist

first

first: Hash;

Inherited from

HydratedBlockStoreParams.first

last

last: Hash;

Inherited from

HydratedBlockStoreParams.last

snapshotArchivist

snapshotArchivist: ArchivistInstance;

Inherited from

HydratedBlockStoreParams.snapshotArchivist

HydratedBlockStoreInstance

@xyo-network/chain-wrappers

Extended by

• IndexedHydratedBlockStoreInstance

Methods

fromHash()

fromHash(hash): Promisable<HydratedBlock | undefined>;

Parameters

hash

Hash

Returns

Promisable<HydratedBlock | undefined>

IndexedHydratedBlockRangeStoreInstance

@xyo-network/chain-wrappers

Extends

• BlockWindowInstance.IndexedHydratedBlockStoreInstance

Properties

count

count: number;

Inherited from

BlockWindowInstance.count

numberRange

numberRange: [number, number];

Inherited from

BlockWindowInstance.numberRange

range

range: [Hash, Hash];

Inherited from

BlockWindowInstance.range

Methods

fromHash()

fromHash(hash): Promisable<HydratedBlock | undefined>;

Parameters

hash

Hash

Returns

Promisable<HydratedBlock | undefined>

Inherited from

IndexedHydratedBlockStoreInstance.fromHash

fromNumber()

fromNumber(number): Promisable<HydratedBlock | undefined>;

Parameters

number

number

Returns

Promisable<HydratedBlock | undefined>

Inherited from

IndexedHydratedBlockStoreInstance.fromNumber

first()

first(): Promisable<HydratedBlock>;

Returns

Promisable<HydratedBlock>

last()

last(): Promisable<HydratedBlock>;

Returns

Promisable<HydratedBlock>

next()

Call Signature

next(from): Promisable<HydratedBlock | undefined>;

Parameters

from

HydratedBlock

Returns

Promisable<HydratedBlock | undefined>

Call Signature

next(from, count): Promisable<HydratedBlock[]>;

Parameters

from

HydratedBlock

count

number

Returns

Promisable<HydratedBlock[]>

prev()

Call Signature

prev(from): Promisable<HydratedBlock | undefined>;

Parameters

from

HydratedBlock

Returns

Promisable<HydratedBlock | undefined>

Call Signature

prev(from, count): Promisable<HydratedBlock[]>;

Parameters

from

HydratedBlock

count

number

Returns

Promisable<HydratedBlock[]>

IndexedHydratedBlockStoreInstance

@xyo-network/chain-wrappers

Extends

• HydratedBlockStoreInstance

Extended by

• IndexedHydratedBlockRangeStoreInstance

Methods

fromHash()

fromHash(hash): Promisable<HydratedBlock | undefined>;

Parameters

hash

Hash

Returns

Promisable<HydratedBlock | undefined>

Inherited from

HydratedBlockStoreInstance.fromHash

fromNumber()

fromNumber(number): Promisable<HydratedBlock | undefined>;

Parameters

number

number

Returns

Promisable<HydratedBlock | undefined>

type-aliases

HydratedBlockStoreParams

@xyo-network/chain-wrappers

type HydratedBlockStoreParams<TAdditionalParams> = BaseParams<object & TAdditionalParams>;

Type Parameters

TAdditionalParams

TAdditionalParams extends EmptyObject = EmptyObject

variables

createSignatureWrappers

@xyo-network/chain-wrappers

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

Parameters

bw

BoundWitness

Returns

Promise<SignatureInstance[]>

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