Hub

Methods

(inner) collectRoyaltyForReleaseViaHub(client, releasePublicKey, hubPublicKey) → {Object}

Collects royalties on a releaase via Hub Dashboard.

Parameters:

Name	Type	Description
`client`	Object	The Nina Client.
`releasePublicKey`	String	The public key of the Release.
`hubPublicKey`	String	The public key of the Hub.

Source: resources/hubs.js, line 770

Returns:

Hub Release, recipient, paymentMint.

Type:: Object

Example

const royalty = await NinaClient.Hub.collectRoyaltyForReleaseViaHub(ninaClient, releasePublicKey, hubPublicKey);

(inner) fetch(publicKeyOrHandle, withAccountDataopt)

Fetches a Hub along with its Releases, Collaborators, and Posts.

Parameters:

Name	Type	Attributes	Default	Description
`publicKeyOrHandle`	String			The public key or handle of the Hub account.
`withAccountData`	Boolean	<optional>	false	Include full on-chain Hub, HubRelease, HubPost, HubContent, HubCollaborator, Release, and Post accounts.

Source: resources/hubs.js, line 31

Example

const hub = await NinaClient.Hub.fetch('ninas-picks');

(inner) fetchAll(paginationopt, withAccountDataopt)

Fetches all hubs.

Parameters:

Name	Type	Attributes	Default	Description
`pagination`	Object	<optional>	{limit: 20, offset: 0, sort: 'desc'}	Pagination options.
`withAccountData`	Boolean	<optional>	false	Include full on-chain Hub accounts.

Source: resources/hubs.js, line 11

Example

const hubs = await NinaClient.Hub.fetchAll();

(inner) fetchCollaborator(publicKeyOrHandle, withAccountDataopt)

Fetches a Collaborator by Publickey.

Parameters:

Name	Type	Attributes	Default	Description
`publicKeyOrHandle`	String			The public key or handle of the Hub account.
`withAccountData`	Boolean	<optional>	false	Include full on-chain HubCollaborator accounts.

Source: resources/hubs.js, line 54

Example

const collaborators = await NinaClient.Hub.fetchCollaborators('ninas-picks');

(inner) fetchCollaborators(publicKeyOrHandle, withAccountDataopt, paginationopt)

Fetches the Collaborators of a Hub.

Parameters:

Name	Type	Attributes	Default	Description
`publicKeyOrHandle`	String			The public key or handle of the Hub account.
`withAccountData`	Boolean	<optional>	false	Include full on-chain HubCollaborator accounts.
`pagination`	Object	<optional>	{limit, offset, sort}	Pagination options.

Source: resources/hubs.js, line 42

Example

const collaborators = await NinaClient.Hub.fetchCollaborators('ninas-picks');

(inner) fetchHubPost(publicKeyOrHandle, hubPostPublicKey, withAccountDataopt)

Fetches a hubPost

Parameters:

Name	Type	Attributes	Default	Description
`publicKeyOrHandle`	String			The public key or handle of the Hub.
`hubPostPublicKey`	String			The public key of the HubPost.
`withAccountData`	Boolean	<optional>	false	Include full on-chain HubPost, HubContent, and Post accounts.

Source: resources/hubs.js, line 106

Example

const hubPost = await NinaClient.Hub.fetchHubPost('ninas-picks', 'H2aoAZfxbQX6s77yj31Duy7DiJnJcN3Gg1HkA2VuvNUZ');

(inner) fetchHubRelease(publicKeyOrHandle, hubReleasePublicKey, withAccountDataopt)

Fetches a Release for a Hub.

Parameters:

Name	Type	Attributes	Default	Description
`publicKeyOrHandle`	String			The public key or handle of the Hub.
`hubReleasePublicKey`	String			The public key of the HubRelease.
`withAccountData`	Boolean	<optional>	false	Include full on-chain HubPost, HubContent, and Post accounts.

Source: resources/hubs.js, line 90

Example

const hubRelease = await NinaClient.Hub.fetchHubRelease('ninas-picks', 'H2aoAZfxbQX6s77yj31Duy7DiJnJcN3Gg1HkA2VuvNUZ);

(inner) fetchPosts(publicKeyOrHandle, withAccountDataopt, paginationopt)

Fetches Posts for a hub.

Parameters:

Name	Type	Attributes	Default	Description
`publicKeyOrHandle`	String			The public key or handle of the Hub account.
`withAccountData`	Boolean	<optional>	false	Include full on-chain HubPost, HubContent, and Post accounts.
`pagination`	Object	<optional>	{limit, offset, sort}	Pagination options.

Source: resources/hubs.js, line 78

Example

const posts = await NinaClient.Hub.fetchPosts('ninas-picks');

(inner) fetchReleases(publicKeyOrHandle, withAccountDataopt, paginationopt)

Fetches Releases for a Hub.

Parameters:

Name	Type	Attributes	Default	Description
`publicKeyOrHandle`	String			The public key or handle of the Hub account.
`withAccountData`	Boolean	<optional>	false	Include full on-chain HubRelease, HubContent, and Release accounts.
`pagination`	Object	<optional>	{limit, offset, sort}	Pagination options.

Source: resources/hubs.js, line 66

Example

const releases = await NinaClient.Hub.fetchReleases('ninas-picks');

(inner) fetchSubscriptions(publicKeyOrHandle, paginationopt)

Fetches the subscriptions for a Hub.

Parameters:

Name	Type	Attributes	Default	Description
`publicKeyOrHandle`	String			The public key or handle of the Hub account.
`pagination`	Object	<optional>	{limit, offset, sort}	Pagination options.

Source: resources/hubs.js, line 118

Example

const subscriptions = await NinaClient.Hub.fetchSubscriptions("ninas-picks");

(inner) hubAddCollaborator(client, hubPublicKey, collaboratorPubkey, canAddContent, canAddCollaborator, allowance) → {Object}

Adds a collaborator to a Hub.

Parameters:

Name	Type	Description
`client`	Object	The NinaClient.
`hubPublicKey`	String	The public key of the Hub account.
`collaboratorPubkey`	String	The public key of the collaborator account.
`canAddContent`	Boolean	Boolean indicating if the collaborator can add content to the Hub.
`canAddCollaborator`	Boolean	Boolean indicating if the collaborator can add collaborators to the Hub.
`allowance`	Integer	integer indicating the amount of Hub actions the collaborator can execute (-1 for unlimited).

Source: resources/hubs.js, line 255

Returns:

Collaborator

Type:: Object

(inner) hubAddRelease(client, hubPublicKey, releasePublicKey, fromHubopt) → {Object}

Adds a Release to a Hub.

Parameters:

Name	Type	Attributes	Description
`client`	Object		The NinaClient.
`hubPublicKey`	String
`releasePublicKey`	String
`fromHub`	String	<optional>

Source: resources/hubs.js, line 505

Returns:

The Hub Release Data

Type:: Object

(inner) hubContentToggleVisibility(client, hubPublicKey, contentAccountPublicKey, type) → {Object}

Toggles the visibility of a piece of content on a Hub.

Parameters:

Name	Type	Description
`client`	Object	The NinaClient.
`hubPublicKey`	String	Pulic key of the content's Hub.
`contentAccountPublicKey`	String	Pubkey of the content account.
`type`	String	Should be either 'Release' or 'Post'.

Source: resources/hubs.js, line 444

Returns:

The HubChildPublicKey.

Type:: Object

Example

const hub = await NinaClient.Hub.hubContentToggleVisibility(ninaClient, hubPublicKey, contentAccountPublicKey, 'Release');

(inner) hubInit(client, hubParams) → {Object}

Initializes a Hub account with Hub Credit.

Parameters:

Name	Type	Description
`client`	Object	The NinaClient.
`hubParams`	Object	The Hub parameters. // NOTE: exand

Source: resources/hubs.js, line 130

Returns:

The created Hub account.

Type:: Object

Example

const hub = await NinaClient.Hub.hubInit({})

(inner) hubRemoveCollaborator(client, hubPublicKey, collaboratorPubkey) → {Object}

Removes a collaborator from a Hub.

Parameters:

Name	Type	Description
`client`	Object	The NinaClient.
`hubPublicKey`	String
`collaboratorPubkey`	String

Source: resources/hubs.js, line 393

Returns:

Collaborator

Type:: Object

(inner) hubUpdateCollaboratorPermission(client, hubPublicKey, collaboratorPubkey, canAddContent, canAddCollaborator, allowance) → {Object}

Updates the permissions of a collaborator on a Hub.

Parameters:

Name	Type	Description
`client`	Object	The NinaClient.
`hubPublicKey`	String	The public key of the Hub account.
`collaboratorPubkey`	String	The public key of the collaborator account.
`canAddContent`	Boolean	Boolean indicating if the collaborator can add content to the Hub.
`canAddCollaborator`	Boolean	Boolean indicating if the collaborator can add collaborators to the Hub.
`allowance`	Integer	integer indicating the amount of Hub actions the collaborator can execute (-1 for unlimited).

Source: resources/hubs.js, line 325

Returns:

Collaborator

Type:: Object

Example

const hub = await NinaClient.Hub.hubUpdateCollaboratorPermission(hubPublicKey, collaboratorPubkey, true, true, 10, wallet, connection);

(inner) hubUpdateConfig(client, hubPublicKey, uri, publishFee, referralFee) → {Object}

Updates the configuration of a Hub.

Parameters:

Name	Type	Description
`client`	Object	The NinaClient.
`hubPublicKey`	String	The public key of the Hub account.
`uri`	String	The URI of the Hubs updated metadata.
`publishFee`	Number
`referralFee`	Number

Source: resources/hubs.js, line 216

Returns:

The updated Hub account.

Type:: Object

Example

const hub = await NinaClient.Hub.hubUpdateConfig(hubPublicKey, 'https://nina.com', 0.1, 0.1, wallet, connection);

(inner) hubWithdraw(client, hubPublicKey) → {Object}

Withdraws Hub fees in Hub dashboard.

Parameters:

Name	Type	Description
`client`	Object	The Nina Client.
`hubPublicKey`	String

Source: resources/hubs.js, line 837

Returns:

the Hub Public Key.

Type:: Object

Example

const txid = await NinaClient.Hub.hubWithdraw(ninaClient, hubPublicKey);

(inner) postInitViaHub(hubPublicKey, slug, uri, referenceReleaseopt, fromHubopt) → {Object}

Creates a Post on a Hub.

Parameters:

Name	Type	Attributes	Description
`hubPublicKey`	String		The public key of the Hub.
`slug`	String		The slug of the Post.
`uri`	String		The URI of the Post.
`referenceRelease`	String	<optional>	The public key of the reference Release.
`fromHub`	String	<optional>	The public key of the reference Hub.

Source: resources/hubs.js, line 586

Returns:

The Post and Referenced Release Public Key.

Type:: Object

Example

const post = await NinaClient.Hub.postInitViaHub(ninaClient, hubPublicKey, slug, uri);

(inner) postUpdateViaHub(hubPublicKey, slug, uri, referenceReleaseopt, fromHubopt) → {Object}

Creates a Post on a Hub.

Parameters:

Name	Type	Attributes	Description
`hubPublicKey`	String		The public key of the Hub.
`slug`	String		The slug of the Post.
`uri`	String		The URI of the Post.
`referenceRelease`	String	<optional>	The public key of the reference Release.
`fromHub`	String	<optional>	The public key of the reference Hub.

Source: resources/hubs.js, line 707

Returns:

The Post.

Type:: Object

Example

const post = await NinaClient.Hub.postInitViaHub(ninaClient, hubPublicKey, slug, uri);