Store

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

---

twine-js / @twine-protocol/twine-core / Store

Interface: Store

A store that can fetch and save twines

Extends

• Resolver

Methods

fetch()

fetch(cid): Awaitable<null | Twine<TwineValue>>

Fetch a twine from storage, returning null if it is not found

it is NOT expected that the twine signature is checked, that is for the Resolver to do.

Parameters

Parameter	Type	Description
cid	IntoCid	The CID of the twine to fetch

Returns

Awaitable<null | Twine<TwineValue>>

Defined in

packages/twine-core/src/store/types.ts:22

---

save()

save(twine): Awaitable<void>

Save a twine to storage

Parameters

Parameter	Type	Description
twine	Twine<TwineValue>	The twine to save

Returns

Awaitable<void>

Defined in

packages/twine-core/src/store/types.ts:28

---

saveMany()

saveMany(twines): Awaitable<void>

Save many twines to storage

Parameters

Parameter	Type	Description
twines	AnyIterable<Twine<TwineValue>>	The twines to save

Returns

Awaitable<void>

Defined in

packages/twine-core/src/store/types.ts:34

---

delete()

delete(cid): Awaitable<void>

Delete a twine from storage

Parameters

Parameter	Type	Description
cid	IntoCid	The CID of the twine to delete

Returns

Awaitable<void>

Defined in

packages/twine-core/src/store/types.ts:40

---

resolve()

resolve(query, options)

resolve(query, options?): Promise<ChainResolution>

Resolve a chain from a query

This is the main way to get a pulse or chain from somewhere and have it automatically verified.

If the input is already a successful resolution, it will be returned as is.

If the input is a chain or pulse, it will be resolved as a chain or pulse resolution.

Parameters

Parameter	Type	Description
query	IntoResolveChainQuery	The query to resolve
options?	ResolveOptions	Options for the resolution

Returns

Promise<ChainResolution>

A chain or pulse resolution

Examples

const { chain } = await resolver.resolve({ chain: 'bafybeib3...' })
if (chain) {
  console.log('chain', chain)
} else {
  console.log('no chain')
}

const { chain, pulse } = await resolver.resolve({
  chain: 'bafybeib3...',
  pulse: 'bafybeib3...'
})

if (pulse) {
  console.log('pulse', pulse)
} else {
  console.log('no pulse')
}

Inherited from

Resolver.resolve

Defined in

packages/twine-core/src/resolver/types.ts:233

resolve(query, options)

resolve(query, options?): Promise<PulseResolution>

Resolve a pulse (with its chain) from a query

Parameters

Parameter	Type
query	IntoResolvePulseQuery
options?	ResolveOptions

Returns

Promise<PulseResolution>

Inherited from

Resolver.resolve

Defined in

packages/twine-core/src/resolver/types.ts:237

---

resolveLatest()

resolveLatest(chain, options?): Promise<PulseResolution>

Resolve the latest pulse of a chain

Parameters

Parameter	Type	Description
chain	IntoCid	The chain CID or chain itself to resolve the latest pulse from
options?	ResolveOptions	Options for the resolution

Returns

Promise<PulseResolution>

A pulse resolution

Examples

const resolution = await resolver.resolveLatest('bafybeib3...')
if (resolution.pulse) {
  console.log('pulse', resolution.pulse)
}

const { chain } = await resolver.resolve({ chain: 'bafybeib3...' })
const resolution = await resolver.resolveLatest(chain)

Inherited from

Resolver.resolveLatest

Defined in

packages/twine-core/src/resolver/types.ts:260

---

resolveIndex()

resolveIndex(chain, index, options?): Promise<PulseResolution>

Resolve a pulse by index

Parameters

Parameter	Type	Description
chain	IntoCid	The chain CID or chain itself to resolve the pulse from
index	number	The index of the pulse to resolve
options?	ResolveOptions	Options for the resolution

Returns

Promise<PulseResolution>

A pulse resolution

Example

const resolution = await resolver.resolveIndex('bafybeib3...', 42)
if (resolution.pulse) {
  console.log('pulse', resolution.pulse)
}

Inherited from

Resolver.resolveIndex

Defined in

packages/twine-core/src/resolver/types.ts:278

---

has()

has(cid): Awaitable<boolean>

Check if a cid can be resolved

Parameters

Parameter	Type	Description
cid	IntoCid	The CID to check

Returns

Awaitable<boolean>

True if the CID can be resolved, false otherwise

Example

const exists = await resolver.has('bafybeib3...')
if (exists) {
  console.log('chain exists')
} else {
  console.log('chain does not exist')
}

Inherited from

Resolver.has

Defined in

packages/twine-core/src/resolver/types.ts:295

---

pulses()

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

Get the pulses of a chain

Parameters

Parameter	Type	Description
chain	IntoCid	The chain CID or chain itself to get the pulses from
start?	number | IntoCid	The index or CID of the pulse to start from
options?	ResolveOptions	Options for the resolution

Returns

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

An sync/async iterable of pulses

Example

// loop through pulses and print indices
for await (const pulse of resolver.pulses('bafybeib3...')) {
  console.log('pulse', pulse.value.content.index)
}

Inherited from

Resolver.pulses

Defined in

packages/twine-core/src/resolver/types.ts:313

---

chains()

chains(): AsyncGenerator<Chain, any, any> | Generator<Chain, any, any> | AnyIterable<Chain>

Get the chains that are known to the resolver

Returns

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

An sync/async iterable of chains

Example

const chains = await collect(resolver.chains())

Inherited from

Resolver.chains

Defined in

packages/twine-core/src/resolver/types.ts:324