index

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

---

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

@twine-protocol/twine-core

This is the core javascript (typescript) package for the Twine protocol. It will be used by all other packages.

You will likely be most interested in the Twine class, fromJSON, and fromBytes.

This is a very small subset of twine utilities. It contains utilities defining chains and pulses, storage and resolving interfaces, and signature verification.

To actually create twine data, you need the "@twine-protocol/twine-builder" package.

To retrieve or store twine data you'll need one of these packages:

• "@twine-protocol/twine-http-store" Store/retrieve data from an http api

• "@twine-protocol/twine-car-utils" Store/retrieve data in CAR files

• "@twine-protocol/twine-blockstore-store" Store/retrieve data in BlockStores

See

• Twine for the main class

• fromJSON for creating Twine objects from JSON

• fromBytes for creating Twine objects from bytes

Classes

Cache

Class	Description
CacheMap	A map that caches the most recently accessed items
TwineCache	A store that caches twines in memory

Other

Class	Description
CID	-

Resolving

Class	Description
ChainResolver	A helper to restrict the resolution to a specific chain

Storage

Class	Description
MemoryStore	A store that keeps twines in memory

Twine Data

Class	Description
Twine	Generic class for twine data

Interfaces

Other

Interface	Description
JWK	JSON Web Key (JWK). "RSA", "EC", "OKP", and "oct" key types are supported.

Resolving

Interface	Description
Resolver	Resolves a query into a chain or pulse
ResolveOptionsCombined	Options for combined resolution calls
ResolveLatestOptionsCombined	Options for combined resolution of latest pulse calls
CombinedResolver	A resolver that combines multiple resolvers

Signer

Interface	Description
Signer	Any class implementing this interface can be used as a signer for Twine

Storage

Interface	Description
Store	A store that can fetch and save twines

Type Aliases

Cache

Type alias	Description
CacheOptions	Cache options

Crawling

Type alias	Description
MaybeIterable	Something that could be a value or an iterator over that value type
Path	A path is a list of resolved pulse resolutions
CrawlPathContainer	An object that contains a path
LoaderOptions	Options for the loader
CrawlPending	An object containing a load function that represents a pending crawl result
CrawlResult	The result of a crawl that is a pulse resolution with a path
FulfilledCrawlResult	The result of a crawl that is a fulfilled pulse resolution with a path
CrawlGuide	Crawl Guide

Internal

Type alias	Description
ChainStorageMeta	Metadata used by the memory store to keep track of chains and pulses

Other

Type alias	Description
Awaitable	Something that can be awaited
AnyIterable	An async or sycn iterable
Signature	The signature type
Mixin	Mixins store the information about links between chains
AnyMap	Generic map
ChainContent	Chain metadata
PulseIndex	Pulse index (block height)
PulseContent	Pulse content
TwineContent	Chain or pulse content
ChainValue	Value field for chains
PulseValue	Value field for pulses
TwineValue	Value field for chain or pulse
IntoCid	Any type that can be coerced into a CID
IntoMixin	Any type that can be coerced into a mixin
Chain	A Twine that is a Chain
Pulse	A Twine that is a Pulse

Resolving

Type alias	Description
ResolveChainQuery	A query to resolve a chain
ResolvePulseQuery	A query to resolve a pulse
ResolveChainQueryStrict	A query to resolve a chain strictly using a CID object
ResolvePulseQueryStrict	A query to resolve a pulse strictly using CID objects
ResolveQueryStrict	A strict query to resolve a chain or pulse
FulfilledChainResolution	The product of a successful chain resolution
FulfilledPulseResolution	The product of a successful pulse resolution
UnfulfilledChainResolution	The product of a failed chain resolution
UnfulfilledPulseResolution	The product of a failed pulse resolution
FulfilledResolution	A successful chain or pulse resolution
UnfulfilledResolution	A failed chain or pulse resolution
ChainResolution	A successful or failed chain resolution
PulseResolution	A successful or failed pulse resolution
Resolution	A resolution of any kind
IntoResolveChainQuery	Something that can be coerced into a chain resolution query
IntoResolvePulseQuery	Something that can be coerced into a pulse resolution query
ResolveOptions	Options for all resolvers
FetchChainQuery	CID for a chain lookup
FetchPulseQuery	CIDs for a pulse lookup
ResolveCallers	An object containing methods to fetch twines
CombineResolversOptions	Options for combining resolvers
CombinedPulseResolution	A combined pulse resolution
CombinedChainResolution	A combined chain resolution

Variables

Cache

Variable	Description
CACHE_SINGLETON	A singleton cache store

Functions

Comparison

Function	Description
mixinDiff	Compare two mixin lists and return the differences

Conversion

Function	Description
collect	Collect an async iterable into an array
asMixin	Convert something mixin-like into a mixin
bytesToHex	Convert bytes into a hex string
hex2bytes	Convert a hex string into bytes
asQuery	Convert something query-like into a query
asCid	Convert something into a CID
coerceCid	Coerce something into a CID
fromJSON	Convert a DAG-JSON encoded twine into a twine instance
fromBytes	Converts a bytes array (ipld block) into a twine instance
linksAsQueries	Converts a pulse's links array into a list of queries.
coerceQuery	Coerce something into a query

Crawling

Function	Description
crawl	Crawl the tapestry
findPath	Find a path between two pulses

Internal

Function	Description
asyncThrottle	Throttle an async function call
memoized	memoize an async function call so that while it is pending, the same call is not made again

Resolving

Function	Description
resolveHelper	A helper function for implementing the Resolver.resolve method
memoized	memoize an async function call so that while it is pending, the same call is not made again
combineResolvers	Combine multiple resolvers into a single resolver

Skiplist

Function	Description
skipList	Get an iterator of indices that can be used to skip through the chain.
getLayerPos	Get the highest layer for which this (pulse) index is an anchor for. For example: in base 10, for the following indicies...

CrawlGuide

Crawling

Function	Description
across	Create a guide that moves horizontally across chains
within	Create a guide that visits all skiplist links as they are seen
along	Create a guide that moves along chains
spread	Create a guide that spreads out in all directions
randomWalk	Create a guide that does a random walk through the tapestry
towards	Create a guide that moves efficiently towards a target pulse

Errors

Class	Description
TwineError	General Twine Error class
InvalidTwineData	Signifies that the twine data does not follow specs
InvalidSignature	Signifies that the signature is invalid
IncompleteResolution	Thrown when crawling cannot resolve a pulse

Internal

Function	Description
getContentDigest	Get the hash digest of twine content
verifySignature	Verify the signature of a chain or pulse

Type Guards

Function	Description
isISODate	Is this string a valid ISO Date
isInteger	Is this an integer
isUnsignedInteger	Is this a positive integer
isIterable	Is this a sync iterable
isAsyncIterable	Is this an async iterable
isAnyIterable	Is this a sync or async iterable
isCid	Is this a CID object (not a string)
isMixins	Is this a mixin list
isLinks	Is this a links list
isPulseContent	Is this valid pulse content
isChainContent	Is this valid chain content
isPulseValue	Is this a pulse value
isChainValue	Is this a chain value
isTwineValue	Is this a twine value (pulse or chain)
isTwine	Is this a twine
isChain	Is this a chain
isPulse	Is this a pulse
isFulfilledPulseResolution	Is this a fulfilled pulse resolution
isFulfilledChainResolution	Is this a fulfilled chain resolution
isPulseQuery	Is this a pulse query