Release

Methods

(inner) addRoyaltyRecipient(client, release, updateData, releasePublicKey) → {String}

Parameters:

Name	Type	Description
`client`	Object	the NinaClient
`release`	String	the release
`updateData`	Object	the data to update the release with
`releasePublicKey`	String	the Public Key of the release

Source: resources/releases.js, line 803

Returns:

The Public Key of the recipient

Type:: String

Example

addRoyaltyRecipient(client, recipient, updateData, releasePublicKey)

(inner) closeRelease(client, releasePublicKey) → {Object}

Parameters:

Name	Type	Description
`client`	Object	the NinaClient
`releasePublicKey`	String	Public Key of the release.

Source: resources/releases.js, line 702

Returns:

The closed Release.

Type:: Object

Example

await closeRelease(ninaClient, 'releasePublicKey');

(inner) collectRoyaltyForRelease(client, recipient, releasePublicKey, state) → {Object}

Parameters:

Name	Type	Description
`client`	Object	the NinaClient
`recipient`	String	Public Key of the recipient.
`releasePublicKey`	String	Public Key of the release.
`state`	Object	the NinaClient state.

Source: resources/releases.js, line 737

Returns:

the Release.

Type:: Object

Example

collectRoyaltyForRelease(client, recipient, releasePublicKey, state)

(inner) fetch(publicKey, withAccountDataopt)

Parameters:

Name	Type	Attributes	Default	Description
`publicKey`	String			The public key of the release.
`withAccountData`	Boolean	<optional>	false	Fetch full on-chain Release account.

Source: resources/releases.js, line 41

Example

const release = await NinaClient.Release.fetch("4dS4v5dGrUwEZmjCFu56qgyAmRfaPmns9PveWAw61rEQ");

(inner) fetchAll Fetches all releases.(paginationopt, withAccountDataopt)

Parameters:

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

Source: resources/releases.js, line 21

Example

const releases = await NinaClient.Release.fetchAll();

(inner) fetchCollectors(publicKey, withCollectionopt, paginationopt)

Parameters:

Name	Type	Attributes	Default	Description
`publicKey`	String			The public key of the release.
`withCollection`	Boolean	<optional>	false	Fetch collectors collections.
`pagination`	Object	<optional>	{limit, offset, sort}	Pagination options.

Source: resources/releases.js, line 51

Example

const collectors = await NinaClient.Release.fetchCollectors("4dS4v5dGrUwEZmjCFu56qgyAmRfaPmns9PveWAw61rEQ");

(inner) fetchExchanges(publicKey, withAccountDataopt, paginationopt)

Parameters:

Name	Type	Attributes	Default	Description
`publicKey`	String			The public key of the release.
`withAccountData`	Boolean	<optional>	false	Fetch full on-chain Exchange accounts.
`pagination`	Object	<optional>	{limit, offset, sort}	Pagination options.

Source: resources/releases.js, line 73

Example

const exchanges = await NinaClient.Release.fetchExchanges("4dS4v5dGrUwEZmjCFu56qgyAmRfaPmns9PveWAw61rEQ");

(inner) fetchHubs(publicKey, withAccountDataopt, paginationopt)

Parameters:

Name	Type	Attributes	Default	Description
`publicKey`	String			The public key of the release.
`withAccountData`	Boolean	<optional>	false	Fetch full on-chain Hub and HubRelease accounts.
`pagination`	Object	<optional>	{limit, offset, sort}	Pagination options.

Source: resources/releases.js, line 62

Example

const hubs = await NinaClient.Release.fetchHubs("4dS4v5dGrUwEZmjCFu56qgyAmRfaPmns9PveWAw61rEQ");

(inner) fetchRevenueShareRecipients(publicKey, withAccountDataopt, paginationopt)

Parameters:

Name	Type	Attributes	Default	Description
`publicKey`	String			The public key of the release.
`withAccountData`	Boolean	<optional>	false	Fetch full on-chain Release accounts.
`pagination`	Object	<optional>	{limit, offset, sort}	Pagination options.

Source: resources/releases.js, line 84

Example

const revenueShareRecipients = await NinaClient.Release.fetchRevenueShareRecipients("4dS4v5dGrUwEZmjCFu56qgyAmRfaPmns9PveWAw61rEQ");

(inner) initializeReleaseAndMint - Initializes a release and mints the first edition(client, hubPubkey) → {Object}

Parameters:

Name	Type	Description
`client`	Object	the Nina Client
`hubPubkey`	*	the hub pubkey

Source: resources/releases.js, line 507

Returns:

the release, release bump, and release mint

Type:: Object

Example

await initializeReleaseAndMint(client, hubPubkey);

(inner) purchaseViaHub(client, releasePublicKey, hubPublicKey) → {String}

Parameters:

Name	Type	Description
`client`	Object	NinaClient instance.
`releasePublicKey`	String	Public Key of the release.
`hubPublicKey`	String	Public Key of the hub.

Source: resources/releases.js, line 95

Returns:

the transaction ID.

Type:: String

Example

const transactionId = await NinaClient.Release.purchaseViaHub(client, "4dS4v5dGrUwEZmjCFu56qgyAmRfaPmns9PveWAw61rEQ", "4dS4v5dGrUwEZmjCFu56qgyAmRfaPmns9PveWAw61rEQ");

(inner) releaseInit(client, retailPrice, amount, resalePercentage, metadataUri, artist, title, catalogNumber, metadataUri, isUsdc, release, releaseBump, releaseMint, isOpen) → {Object}

Parameters:

Name	Type	Description
`client`	Object	the NinaClient
`retailPrice`	Number	Retail price of the release.
`amount`	Number	Amount of the release.
`resalePercentage`	Number	Resale percentage of the release.
`metadataUri`	String	Metadata URI of the release.
`artist`	String	Artist of the release.
`title`	String	Title of the release.
`catalogNumber`	String	Catalog number of the release.
`metadataUri`	String	Metadata URI of the release.
`isUsdc`	Boolean	Is the release priced in USDC or not.
`release`	String	Release of the release.
`releaseBump`	String	Release bump of the release.
`releaseMint`	String	Release mint of the release.
`isOpen`	Boolean	Is the release open or not.

Source: resources/releases.js, line 547

Returns:

The created Release.

Type:: Object

(inner) releaseInitViaHub(client, hubPublicKey, retailPrice, amount, resalePercentage, isUsdc, metadataUri, artist, title, catalogNumber, release, releaseBump, releaseMint, isOpen) → {Object}

Parameters:

Name	Type	Description
`client`	Object	the NinaClient
`hubPublicKey`	String	Public Key of the hub.
`retailPrice`	Number	Retail price of the release.
`amount`	Number	Amount of the release.
`resalePercentage`	Number	Resale percentage of the release.
`isUsdc`	Boolean	Is the payment in USDC or SOL.
`metadataUri`	String	Metadata URI of the release.
`artist`	String	Artist of the release.
`title`	String	Title of the release.
`catalogNumber`	String	Catalog number of the release.
`release`	String	Release of the release.
`releaseBump`	String	Release bump of the release.
`releaseMint`	String	Release mint of the release.
`isOpen`	Boolean	Is the release open or not.

Source: resources/releases.js, line 329

Returns:

The release.

Type:: Object

(inner) releasePurchase(client, releasePublicKey, hubPublicKey) → {String}

Parameters:

Name	Type	Description
`client`	Object	NinaClient instance.
`releasePublicKey`	String	Public Key of the release.
`hubPublicKey`	String	Public Key of the hub.

Source: resources/releases.js, line 239

Returns:

Transaction Id.

Type:: String