@textile/hub

hub package

A web-gRPC wrapper client for communicating with the web-gRPC enabled Textile ThreadDB & Buckets APIs.

Classes

Class	Description
Buckets	Buckets a client wrapper for interacting with the Textile Buckets API.
Client	Client is a web-gRPC wrapper client for communicating with a webgRPC-enabled Threads server. This client library can be used to interact with a local or remote Textile gRPC-service It is a wrapper around Textile Thread's 'DB' API, which is defined here: https://github.com/textileio/go-threads/blob/master/api/pb/threads.proto.
Filecoin	Filecoin is a client wrapper for interacting with the Textile Hub Filecoin API.
PrivateKey	Default implementation of the Private interface, with decryption support. In theory, RSA, ed25519, and secp256k1 key types (and more) should be supported, although currently only ed25519 has full sign and decrypt capabilities.
PublicKey	Default implementation of the Public interface, with encryption support. In theory, RSA, ed25519, and secp256k1 key types (and more) should be supported, although currently only ed25519 has full verify and encrypt capabilities.
Query	Query allows to build queries to be used to fetch data from a model.
ReadTransaction	ReadTransaction performs a read-only bulk transaction on the underlying store.
ThreadID	ThreadID represents a self-describing Thread identifier.It is formed by a Version, a Variant, and a random number of a given length.
ThreadKey	Key is a thread encryption key with two components.
Users	Users a client wrapper for interacting with the Textile Users API.This API has the ability to:- Register new users with a User Group key and obtain a new API Token- Get and List all Threads created for/by the user in your app.- Create an inbox for the user or send message to another user's inbox.- Check, read, and delete messages in a user's inbox.
WriteTransaction	WriteTransaction performs a mutating bulk transaction on the underlying store.

Enumerations

Enumeration	Description
Action
ArchiveStatus	Archive job status codes
JobStatus	Storage job status codes
MailboxEventType	The mailbox event type. CREATE, SAVE, or DELETE
PathAccessRole
Status	The status query filter of an inbox message.
Variant	Variant denotes Thread variant. Currently only two variants are supported.

Functions

Function	Description
bytesToArray(chunk, size)	bytesToArray converts a buffer into <4mb chunks for use with grpc API
createAPISig(secret, date)	createAPISig generates an authorization signature and message only.This function should NOT be used client-side, as it requires a key secret.
createUserAuth(key, secret, date, token)	Generate a UserAuth containing API key, signature, and message.The gRPC APIs will throw (or return an authorization error) if the message date has passed. This function should NOT be used client-side, as it requires a key secret. The result does not contain the secret and therefor CAN be used client side.
decrypt(ciphertext, privKey, type)	Decrypts the given data using a Curve25519 variant of the private key.Assumes ciphertext includes ephemeral public key and nonce used in original encryption (e.g., via encrypt() function).
encrypt(data, pubKey, type)	Encrypts the given data using a Curve25519 variant of the public key.The encryption uses an ephemeral private key, which is prepended to the ciphertext, along with a nonce of random bytes.
extractPublicKeyBytes(key)	Utility function to extract the raw bytes from a Public key.
listPathFlat(grpc, bucketKey, path, dirs, depth)	listPathFlat returns a string array of all paths in a bucket
listPathRecursive(grpc, bucketKey, path, depth, currentDepth)	listPathRecursive returns a nested object of all paths (and info) in a bucket
privateKeyBytesToString(bytes)	Encode the given privateKey's protobuf-encoded bytes to its base-32 encoded multibase representation.
privateKeyFromString(str)	Decode the given base-32 encoded multibase string into a Private key.
privateKeyToString(key)	Encode the given PrivateKey to its base-32 encoded multibase representation.
publicKeyBytesFromString(str)	Decode the given base-32 encoded multibase string into a Public key.
publicKeyBytesToString(bytes)	Encode the given PublicKey's protobuf-encoded bytes to its base-32 encoded multibase representation.
publicKeyToString(key)	Encode the given PublicKey to its base-32 encoded multibase representation.

Interfaces

Interface	Description
AddressInfo	Information about a wallet address.
Archive	Information about a bucket archive.
ArchiveConfig	ArchiveConfig is the desired state of a Cid in the Filecoin network.
ArchiveDealInfo	Information about a Filecoin deal for a bucket archive.
ArchiveOptions	An object to configure options for Archive.
ArchiveRenew	ArchiveRenew contains renew configuration for a ArchiveConfig.
Archives	Current and past archives for a bucket.
BuckMetadata
CidInfo	Information about the current jobs and storage state of a data cid.
CidSummary	Summary information about a cid in Powergate.
ColdConfig	Cold storage configuration.
ColdInfo	Current cold storage state.
CollectionConfig	CollectionConfig is the configuration options for creating and updating a Collection. It supports the following configuration options: - Name: The name of the collection, e.g, "Animals" (must be unique per DB). - Schema: A JSON Schema), which is used for instance validation. - Indexes: An optional list of index configurations, which define how instances are indexed. - WriteValidator: An optional JavaScript (ECMAScript 5.1) function that is used to validate instances on write. - ReadFilter: An optional JavaScript (ECMAScript 5.1) function that is used to filter instances on read.The writeValidator function receives three arguments: - writer: The multibase-encoded public key identity of the writer. - event: An object describing the update event (see core.Event). - instance: The current instance as a JavaScript object before the update event is applied.A falsy return value indicates a failed validation. Note that the function arguments must be named as documented here (writer, event, instance). These functions run in a secure sandbox where these argument names are specified.Having access to writer, event, and instance opens the door to a variety of app-specific logic. Textile Buckets file-level access roles are implemented in part with a write validator.The readFilter function receives three arguments: - reader: The multibase-encoded public key identity of the reader. - instance: The current instance as a JavaScript object.The function must return a JavaScript object. Most implementations will modify and return the current instance. Note that the function arguments must be named as documented here (reader, instance). These functions run in a secure sandbox where these argument names are specified. Like write validation, read filtering opens the door to a variety of app-specific logic. Textile Buckets file-level access roles are implemented in part with a read filter.
CopyAuthOptions	Set additional options when copying authentication.
CreateOptions
CreateResponse	Bucket create response
CriterionJSON	CriterionJSON represents a single Query criteria.
CustomerResponse	The response type from getUsage
CustomerUsage
DBInfo	DBInfo contains joining/sharing information for a Thread/DB.
DealError	Information about a deal error.
DealRecordsConfig	A configuration object to control the behavior of querying for deal records.
FilConfig	Filecoin storage configuration.
FilInfo	Current Filecoin storage state.
FilRenew	Filecoin storage renew configuration.
FilStorage	Current Filecoin storage state with a single miner.
Filter	Filter parameters for db subscription
GetOrCreateOptions	Options for getOrCreate
GetOrCreateResponse	Response from getOrCreate
GetThreadResponse
GetUsageResponse
HotConfig	Hot storage configuration.
HotInfo	Current hot storage state.
Identity	Identity represents an entity capable of signing a message. This is a simple "private key" interface that must be capable of returning the associated "public key" for verification. In many cases, the Identity will just be a private key, but callers can use any setup that suits their needs. The interface is currently modeled after libp2p-crypto keys. It is meant to be implemented by external libraries, though in practice, implementations are provided by the @textile/crypto library.If using in your own application, see the PrivateKey class.
InboxListOptions	Inbox query options
IpfsConfig	IPFS related storage configuration.
IpfsHotInfo	Current IPFS storage state.
Links	Response from bucket links query.
MailboxEvent	The event type returned from inbox and sentbox subscriptions
Path	A bucket list path response
PathItem	A bucket path item response
Period
Private	Private is an alias for the Identity interface.
Public	Public is any entity associated with a given Identity that is capable of verifying a signature produced by said identity. In most cases, a public key will be obtained as a property of an object implementing the Identity and/or Private key interface.
PushOptions	PushOptions provides additional options for controlling a push to a bucket path.
PushPathResult	The expected result format from pushing a path to a bucket
PushPathsResult	The expected result format from pushing multiple paths to a bucket
QueryJSON	QueryJSON represents a single store Query.
RemovePathOptions	RemovePathOptions provides additional options for path remove steps.
RemovePathResponse	Response from remote path.
RetrievalDealInfo	Information about a retrieval deal.
RetrievalDealRecord	A record of a single retrieval deal.
Root	Bucket root info
SentboxListOptions	Sentbox query options
SortJSON	SortJSON describes how and what field on which to sort a query.
StorageConfig	Configuration for storing data in Powergate.
StorageDealInfo	Information about a Filecoin storage deal.
StorageDealRecord	A record of a single storage deal.
StorageInfo	Current data storage state.
StorageJob	Information about a storage job.
Update
Usage
UsageOptions	GetUsage options
UserMessage	The message format returned from inbox or sentbox
ValueJSON	JSONValue is used by the gRPC server to handle JSON data types.
WithKeyInfoOptions	Set the options for authenticating with an API key
WithUserAuthOptions	Set the options for authenticating with a user auth

Variables

Variable	Description
AbortError
errors
keyFromString	keyFromString returns a key by decoding a base32-encoded string.
keyToString	String returns the base32-encoded string representation of raw key bytes.
MailConfig	Global settings for mailboxes
randomBytes
Where	Alias Criterion to Where for a slightly nicer API (see example below)

Type Aliases

Type Alias	Description
APISig	Create an API signature for use in authenticated systems. Generate with createAPISig().
CreateObject
GetThreadResponseObj
KeyInfo	KeyInfo is a type that contains the API Secret. It should never be shared in insecure environments.
LinksObject
MetadataObject
PathItemObject
PathObject
RootObject
UserAuth	UserAuth is a type describing the minimal requirements create a session from a user group key. Generate with createUserAuth().Optional token generated by Client.getToken or Client.getTokenChallenge.