ChainResolver

@twine-protocol/twine-core v0.1.0 • Docs

---

twine-js / @twine-protocol/twine-core / ChainResolver

Class: ChainResolver

A helper to restrict the resolution to a specific chain

Extends

• Twine<ChainValue>

Constructors

new ChainResolver()

new ChainResolver(resolver, chain): ChainResolver

Create a new ChainResolver

Parameters

Parameter	Type	Description
resolver	Resolver	The resolver to use
chain	Chain	The chain to use

Returns

ChainResolver

A ChainResolver

Overrides

Twine.constructor

Defined in

packages/twine-core/src/resolver/chain-resolver.ts:36

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
isTwineInstance	public	boolean	true	is a twine instance (true)	Twine.isTwineInstance	packages/twine-core/src/twine.ts:24
isChain	public	boolean	undefined	is this a chain	Twine.isChain	packages/twine-core/src/twine.ts:26
chainCid	public	CID<unknown, number, number, Version>	undefined	chain CID (either this CID or the pulse's chain CID)	Twine.chainCid	packages/twine-core/src/twine.ts:28
cid	readonly	CID<ChainValue, number, number, Version>	undefined	-	Twine.cid	node_modules/multiformats/dist/src/block.d.ts:10
bytes	readonly	ByteView<ChainValue>	undefined	-	Twine.bytes	node_modules/multiformats/dist/src/block.d.ts:11
value	readonly	ChainValue	undefined	-	Twine.value	node_modules/multiformats/dist/src/block.d.ts:12
asBlock	readonly	ChainResolver	undefined	-	Twine.asBlock	node_modules/multiformats/dist/src/block.d.ts:13

Accessors

isPulse

Get Signature

get isPulse(): boolean

Is this a pulse

Returns

boolean

Inherited from

Twine.isPulse

Defined in

packages/twine-core/src/twine.ts:82

Methods

create()

static create(resolver, chainCid): Promise<ChainResolver>

Create a new ChainResolver

Parameters

Parameter	Type	Description
resolver	Resolver	The resolver to use
chainCid	IntoCid	The chain or chain CID to use

Returns

Promise<ChainResolver>

A ChainResolver

Defined in

packages/twine-core/src/resolver/chain-resolver.ts:20

---

isTwine()

static isTwine(thing): thing is Chain | Pulse

Check if a value is a twine

Parameters

Parameter	Type
thing	any

Returns

thing is Chain | Pulse

Inherited from

Twine.isTwine

Defined in

packages/twine-core/src/twine.ts:31

---

pulse()

pulse(ref): Promise<null | Pulse>

Resolve a pulse in the chain

Parameters

Parameter	Type	Description
ref	number | IntoCid	The pulse or pulse CID to resolve

Returns

Promise<null | Pulse>

The resolved pulse

Defined in

packages/twine-core/src/resolver/chain-resolver.ts:47

---

pulses()

pulses(start?): AsyncGenerator<Pulse, any, any> | Generator<Pulse, any, any> | AnyIterable<Pulse>

Async iterator for the pulses in the chain

Parameters

Parameter	Type	Description
start?	number | IntoCid	The index or CID of the pulse to start from

Returns

AsyncGenerator<Pulse, any, any> | Generator<Pulse, any, any> | AnyIterable<Pulse>

Defined in

packages/twine-core/src/resolver/chain-resolver.ts:62

---

latest()

latest(): Promise<null | Pulse>

Latest pulse in the chain

Returns

Promise<null | Pulse>

Defined in

packages/twine-core/src/resolver/chain-resolver.ts:69

---

toJSON()

toJSON(): any

Get the twine data as a DAG-JSON object

Returns

any

Inherited from

Twine.toJSON

Defined in

packages/twine-core/src/twine.ts:89

---

getContentDigest()

getContentDigest(): Promise<MultihashDigest<number>>

Get the twine content field hash digest

Returns

Promise<MultihashDigest<number>>

Inherited from

Twine.getContentDigest

Defined in

packages/twine-core/src/twine.ts:101

---

verifySignature()

verifySignature(chain?): Promise<boolean>

Verify the signature of this twine instance

If this is a chain, no chain instance is required. If this is a pulse, a chain instance must be provided.

Parameters

Parameter	Type	Description
chain?	Chain<AnyMap>	Chain instance to use for verification

Returns

Promise<boolean>

Inherited from

Twine.verifySignature

Defined in

packages/twine-core/src/twine.ts:113

---

links()

links(): Iterable<[string, CID<unknown, number, number, Version>], any, any>

Returns

Iterable<[string, CID<unknown, number, number, Version>], any, any>

Inherited from

Twine.links

Defined in

node_modules/multiformats/dist/src/block.d.ts:19

---

tree()

tree(): Iterable<string, any, any>

Returns

Iterable<string, any, any>

Inherited from

Twine.tree

Defined in

node_modules/multiformats/dist/src/block.d.ts:20

---

get()

get(path?): BlockCursorView<unknown>

Parameters

Parameter	Type
path?	string

Returns

BlockCursorView<unknown>

Inherited from

Twine.get

Defined in

node_modules/multiformats/dist/src/block.d.ts:21