@misofm/platform 0.0.0 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +686 -3
- package/dist/auth.d.ts +73 -0
- package/dist/auth.d.ts.map +1 -0
- package/dist/auth.js +193 -0
- package/dist/auth.js.map +1 -0
- package/dist/catalog.d.ts +48 -0
- package/dist/catalog.d.ts.map +1 -0
- package/dist/catalog.js +92 -0
- package/dist/catalog.js.map +1 -0
- package/dist/client.d.ts +462 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +788 -0
- package/dist/client.js.map +1 -0
- package/dist/contracts.d.ts +34 -0
- package/dist/contracts.d.ts.map +1 -0
- package/dist/contracts.js +49 -0
- package/dist/contracts.js.map +1 -0
- package/dist/cover.d.ts +69 -0
- package/dist/cover.d.ts.map +1 -0
- package/dist/cover.js +132 -0
- package/dist/cover.js.map +1 -0
- package/dist/credits.d.ts +200 -0
- package/dist/credits.d.ts.map +1 -0
- package/dist/credits.js +465 -0
- package/dist/credits.js.map +1 -0
- package/dist/deployments.d.ts +224 -0
- package/dist/deployments.d.ts.map +1 -0
- package/dist/deployments.js +177 -0
- package/dist/deployments.js.map +1 -0
- package/dist/execute.d.ts +30 -0
- package/dist/execute.d.ts.map +1 -0
- package/dist/execute.js +31 -0
- package/dist/execute.js.map +1 -0
- package/dist/index.d.ts +21 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +52 -0
- package/dist/index.js.map +1 -0
- package/dist/internal.d.ts +13 -0
- package/dist/internal.d.ts.map +1 -0
- package/dist/internal.js +41 -0
- package/dist/internal.js.map +1 -0
- package/dist/mix.d.ts +144 -0
- package/dist/mix.d.ts.map +1 -0
- package/dist/mix.js +656 -0
- package/dist/mix.js.map +1 -0
- package/dist/pressing.d.ts +137 -0
- package/dist/pressing.d.ts.map +1 -0
- package/dist/pressing.js +390 -0
- package/dist/pressing.js.map +1 -0
- package/dist/publication.d.ts +216 -0
- package/dist/publication.d.ts.map +1 -0
- package/dist/publication.js +872 -0
- package/dist/publication.js.map +1 -0
- package/dist/queries.d.ts +2 -0
- package/dist/queries.d.ts.map +1 -0
- package/dist/queries.js +8 -0
- package/dist/queries.js.map +1 -0
- package/dist/read/artist.d.ts +18 -0
- package/dist/read/artist.d.ts.map +1 -0
- package/dist/read/artist.js +86 -0
- package/dist/read/artist.js.map +1 -0
- package/dist/read/catalog.d.ts +93 -0
- package/dist/read/catalog.d.ts.map +1 -0
- package/dist/read/catalog.js +441 -0
- package/dist/read/catalog.js.map +1 -0
- package/dist/read/client.d.ts +37 -0
- package/dist/read/client.d.ts.map +1 -0
- package/dist/read/client.js +50 -0
- package/dist/read/client.js.map +1 -0
- package/dist/read/config.d.ts +68 -0
- package/dist/read/config.d.ts.map +1 -0
- package/dist/read/config.js +63 -0
- package/dist/read/config.js.map +1 -0
- package/dist/read/genres.d.ts +7 -0
- package/dist/read/genres.d.ts.map +1 -0
- package/dist/read/genres.js +38 -0
- package/dist/read/genres.js.map +1 -0
- package/dist/read/index.d.ts +14 -0
- package/dist/read/index.d.ts.map +1 -0
- package/dist/read/index.js +23 -0
- package/dist/read/index.js.map +1 -0
- package/dist/read/internal/scalars.d.ts +23 -0
- package/dist/read/internal/scalars.d.ts.map +1 -0
- package/dist/read/internal/scalars.js +57 -0
- package/dist/read/internal/scalars.js.map +1 -0
- package/dist/read/internal/walrus.d.ts +6 -0
- package/dist/read/internal/walrus.d.ts.map +1 -0
- package/dist/read/internal/walrus.js +29 -0
- package/dist/read/internal/walrus.js.map +1 -0
- package/dist/read/receipts.d.ts +41 -0
- package/dist/read/receipts.d.ts.map +1 -0
- package/dist/read/receipts.js +398 -0
- package/dist/read/receipts.js.map +1 -0
- package/dist/read/types.d.ts +328 -0
- package/dist/read/types.d.ts.map +1 -0
- package/dist/read/types.js +21 -0
- package/dist/read/types.js.map +1 -0
- package/dist/read/wallet.d.ts +74 -0
- package/dist/read/wallet.d.ts.map +1 -0
- package/dist/read/wallet.js +578 -0
- package/dist/read/wallet.js.map +1 -0
- package/dist/read/works.d.ts +29 -0
- package/dist/read/works.d.ts.map +1 -0
- package/dist/read/works.js +191 -0
- package/dist/read/works.js.map +1 -0
- package/dist/recording-extensions.d.ts +62 -0
- package/dist/recording-extensions.d.ts.map +1 -0
- package/dist/recording-extensions.js +159 -0
- package/dist/recording-extensions.js.map +1 -0
- package/dist/release-extensions.d.ts +93 -0
- package/dist/release-extensions.d.ts.map +1 -0
- package/dist/release-extensions.js +190 -0
- package/dist/release-extensions.js.map +1 -0
- package/dist/release-graph.d.ts +65 -0
- package/dist/release-graph.d.ts.map +1 -0
- package/dist/release-graph.js +136 -0
- package/dist/release-graph.js.map +1 -0
- package/dist/share-template.d.ts +3 -0
- package/dist/share-template.d.ts.map +1 -0
- package/dist/share-template.js +46 -0
- package/dist/share-template.js.map +1 -0
- package/dist/share.d.ts +67 -0
- package/dist/share.d.ts.map +1 -0
- package/dist/share.js +157 -0
- package/dist/share.js.map +1 -0
- package/dist/transactions.d.ts +216 -0
- package/dist/transactions.d.ts.map +1 -0
- package/dist/transactions.js +314 -0
- package/dist/transactions.js.map +1 -0
- package/dist/vault.d.ts +364 -0
- package/dist/vault.d.ts.map +1 -0
- package/dist/vault.js +507 -0
- package/dist/vault.js.map +1 -0
- package/package.json +145 -5
- package/src/auth.ts +275 -0
- package/src/catalog.ts +189 -0
- package/src/client.ts +1320 -0
- package/src/contracts.ts +54 -0
- package/src/cover.ts +240 -0
- package/src/credits.ts +906 -0
- package/src/deployments.ts +357 -0
- package/src/execute.ts +52 -0
- package/src/index.ts +69 -0
- package/src/internal.ts +46 -0
- package/src/mix.ts +910 -0
- package/src/pressing.ts +705 -0
- package/src/publication.ts +1214 -0
- package/src/queries.ts +9 -0
- package/src/read/artist.ts +118 -0
- package/src/read/catalog.ts +668 -0
- package/src/read/client.ts +87 -0
- package/src/read/config.ts +138 -0
- package/src/read/genres.ts +37 -0
- package/src/read/index.ts +85 -0
- package/src/read/internal/scalars.ts +59 -0
- package/src/read/internal/walrus.ts +42 -0
- package/src/read/receipts.ts +476 -0
- package/src/read/types.ts +415 -0
- package/src/read/wallet.ts +687 -0
- package/src/read/works.ts +297 -0
- package/src/recording-extensions.ts +256 -0
- package/src/release-extensions.ts +311 -0
- package/src/release-graph.ts +219 -0
- package/src/share-template.ts +55 -0
- package/src/share.ts +261 -0
- package/src/transactions.ts +542 -0
- package/src/vault.ts +1009 -0
|
@@ -0,0 +1,311 @@
|
|
|
1
|
+
// Copyright (c) Miso Labs, Inc.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
|
|
4
|
+
// First-party metadata attached to a protocol Release. The JSON/CLI release
|
|
5
|
+
// intent aggregates these concerns, but every value is written by its own
|
|
6
|
+
// independently deployed extension package.
|
|
7
|
+
|
|
8
|
+
import type { ClientWithCoreApi } from "@mysten/sui/client";
|
|
9
|
+
import { bcs } from "@mysten/sui/bcs";
|
|
10
|
+
import { deriveDynamicFieldID, deriveObjectID } from "@mysten/sui/utils";
|
|
11
|
+
import type {
|
|
12
|
+
Transaction,
|
|
13
|
+
TransactionArgument,
|
|
14
|
+
TransactionObjectArgument,
|
|
15
|
+
} from "@mysten/sui/transactions";
|
|
16
|
+
import type { TxThunk } from "./transactions.ts";
|
|
17
|
+
import * as genre from "@misofm/protocol/contracts/genre/genre";
|
|
18
|
+
import * as releaseDescription from "@misofm/protocol/contracts/release_description/release_description";
|
|
19
|
+
import * as releaseDspLink from "@misofm/protocol/contracts/release_dsp_link/release_dsp_link";
|
|
20
|
+
import * as releaseGenre from "@misofm/protocol/contracts/release_genre/release_genre";
|
|
21
|
+
import * as releaseKind from "@misofm/protocol/contracts/release_kind/release_kind";
|
|
22
|
+
import { asU64, directAdminCap, invokeWithAdminCap, type AdminCapAuthority, type ObjectInput, type U64Input } from "./vault.ts";
|
|
23
|
+
|
|
24
|
+
function object(tx: Transaction, value: ObjectInput): TransactionObjectArgument {
|
|
25
|
+
return typeof value === "string" ? tx.object(value) : value;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
type ReleaseAuthorityInput =
|
|
29
|
+
| { readonly authority: AdminCapAuthority; readonly releaseAdminCapId?: never }
|
|
30
|
+
| { readonly authority?: never; readonly releaseAdminCapId: string };
|
|
31
|
+
interface ReleaseExtensionTargetBase {
|
|
32
|
+
releaseId: ObjectInput;
|
|
33
|
+
}
|
|
34
|
+
export type ReleaseExtensionTarget = ReleaseExtensionTargetBase & ReleaseAuthorityInput;
|
|
35
|
+
function authority(p: ReleaseExtensionTarget): AdminCapAuthority {
|
|
36
|
+
if (p.authority !== undefined) return p.authority;
|
|
37
|
+
if (p.releaseAdminCapId !== undefined) return directAdminCap(p.releaseAdminCapId);
|
|
38
|
+
throw new Error("release authority is required");
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export type SetReleaseKindParams = ReleaseExtensionTarget & {
|
|
42
|
+
kind: string;
|
|
43
|
+
releaseKindPackageId: string;
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
/** Attach the release's self-declared kind (for example "EP" or "Mixtape"). */
|
|
47
|
+
export function setReleaseKind(p: SetReleaseKindParams): TxThunk {
|
|
48
|
+
const bytes = new TextEncoder().encode(p.kind).length;
|
|
49
|
+
if (bytes === 0) throw new Error("setReleaseKind: kind must not be empty");
|
|
50
|
+
if (bytes > 32) {
|
|
51
|
+
throw new Error(
|
|
52
|
+
`setReleaseKind: kind must be at most 32 UTF-8 bytes (got ${bytes})`,
|
|
53
|
+
);
|
|
54
|
+
}
|
|
55
|
+
return (tx) => {
|
|
56
|
+
invokeWithAdminCap(tx, authority(p), {
|
|
57
|
+
target: `${p.releaseKindPackageId}::release_kind::set_kind`,
|
|
58
|
+
arguments: [object(tx, p.releaseId), tx.pure.string(p.kind)],
|
|
59
|
+
adminCapIndex: 1,
|
|
60
|
+
});
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
const ReleaseKindField = bcs.struct("Field", {
|
|
65
|
+
id: bcs.Address,
|
|
66
|
+
name: releaseKind.ExtensionKey,
|
|
67
|
+
value: bcs.string(),
|
|
68
|
+
});
|
|
69
|
+
const RELEASE_KIND_KEY_BYTES = releaseKind.ExtensionKey.serialize([
|
|
70
|
+
false,
|
|
71
|
+
]).toBytes();
|
|
72
|
+
|
|
73
|
+
/** Deterministic dynamic-field id for a Release's optional self-declared kind. */
|
|
74
|
+
export function releaseKindFieldId(
|
|
75
|
+
releaseId: string,
|
|
76
|
+
releaseKindPackageId: string,
|
|
77
|
+
): string {
|
|
78
|
+
return deriveDynamicFieldID(
|
|
79
|
+
releaseId,
|
|
80
|
+
`${releaseKindPackageId}::release_kind::ExtensionKey`,
|
|
81
|
+
RELEASE_KIND_KEY_BYTES,
|
|
82
|
+
);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/** Parse the dynamic field storing `Option<String>` as its present string. */
|
|
86
|
+
export function parseReleaseKindContent(content: Uint8Array): string {
|
|
87
|
+
return ReleaseKindField.parse(content).value;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/** Read a Release's self-declared kind, or `null` when the extension is absent. */
|
|
91
|
+
export async function getReleaseKind(
|
|
92
|
+
client: ClientWithCoreApi,
|
|
93
|
+
releaseId: string,
|
|
94
|
+
releaseKindPackageId: string,
|
|
95
|
+
): Promise<string | null> {
|
|
96
|
+
const { objects } = await client.core.getObjects({
|
|
97
|
+
objectIds: [releaseKindFieldId(releaseId, releaseKindPackageId)],
|
|
98
|
+
include: { content: true },
|
|
99
|
+
});
|
|
100
|
+
const object = objects[0];
|
|
101
|
+
if (!object || object instanceof Error || !object.content) return null;
|
|
102
|
+
return parseReleaseKindContent(object.content);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
export type SetReleaseDescriptionParams = ReleaseExtensionTarget & {
|
|
106
|
+
description: string;
|
|
107
|
+
releaseDescriptionPackageId: string;
|
|
108
|
+
};
|
|
109
|
+
|
|
110
|
+
/** Attach the release's editorial description. */
|
|
111
|
+
export function setReleaseDescription(p: SetReleaseDescriptionParams): TxThunk {
|
|
112
|
+
const bytes = new TextEncoder().encode(p.description).length;
|
|
113
|
+
if (bytes === 0) {
|
|
114
|
+
throw new Error("setReleaseDescription: description must not be empty");
|
|
115
|
+
}
|
|
116
|
+
if (bytes > 8192) {
|
|
117
|
+
throw new Error(
|
|
118
|
+
`setReleaseDescription: description must be at most 8192 UTF-8 bytes (got ${bytes})`,
|
|
119
|
+
);
|
|
120
|
+
}
|
|
121
|
+
return (tx) => {
|
|
122
|
+
invokeWithAdminCap(tx, authority(p), {
|
|
123
|
+
target: `${p.releaseDescriptionPackageId}::release_description::set_description`,
|
|
124
|
+
arguments: [object(tx, p.releaseId), tx.pure.string(p.description)],
|
|
125
|
+
adminCapIndex: 1,
|
|
126
|
+
});
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
const GENRE_NAME_RE = /^[A-Z]+(?:_[A-Z]+)*$/;
|
|
131
|
+
|
|
132
|
+
/** Validate the canonical on-chain genre vocabulary spelling. */
|
|
133
|
+
export function assertCanonicalGenreName(name: string): void {
|
|
134
|
+
const bytes = new TextEncoder().encode(name).length;
|
|
135
|
+
if (bytes === 0 || bytes > 64 || !GENRE_NAME_RE.test(name)) {
|
|
136
|
+
throw new Error(
|
|
137
|
+
`Genre name must be 1-64 bytes of uppercase A-Z and underscores; got ${JSON.stringify(name)}`,
|
|
138
|
+
);
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
/** Derive the immutable Genre object address for a canonical vocabulary name.
|
|
143
|
+
* `genrePackageId` must be the genre package's defining (original publish)
|
|
144
|
+
* address — the on-chain derivation hashes type names with defining IDs. */
|
|
145
|
+
export function deriveGenreAddress(
|
|
146
|
+
genreRegistryId: string,
|
|
147
|
+
genrePackageId: string,
|
|
148
|
+
canonicalName: string,
|
|
149
|
+
): string {
|
|
150
|
+
assertCanonicalGenreName(canonicalName);
|
|
151
|
+
return deriveObjectID(
|
|
152
|
+
genreRegistryId,
|
|
153
|
+
`${genrePackageId}::genre::GenreKey`,
|
|
154
|
+
genre.GenreKey.serialize([canonicalName]).toBytes(),
|
|
155
|
+
);
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export interface TrackGenreAssignment {
|
|
159
|
+
trackIndex: U64Input;
|
|
160
|
+
genreId: string;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
export type SetReleaseGenresParams = ReleaseExtensionTarget & {
|
|
164
|
+
primaryGenreId: string;
|
|
165
|
+
secondaryGenreIds?: readonly string[];
|
|
166
|
+
trackPrimaryGenres?: readonly TrackGenreAssignment[];
|
|
167
|
+
releaseGenrePackageId: string;
|
|
168
|
+
};
|
|
169
|
+
|
|
170
|
+
/** Attach primary/secondary release genres and optional per-track overrides. */
|
|
171
|
+
export function setReleaseGenres(p: SetReleaseGenresParams): TxThunk {
|
|
172
|
+
return (tx) => {
|
|
173
|
+
invokeWithAdminCap(tx, authority(p), {
|
|
174
|
+
target: `${p.releaseGenrePackageId}::release_genre::set_primary_genre`,
|
|
175
|
+
arguments: [object(tx, p.releaseId), tx.object(p.primaryGenreId)],
|
|
176
|
+
adminCapIndex: 1,
|
|
177
|
+
});
|
|
178
|
+
for (const genreId of p.secondaryGenreIds ?? []) {
|
|
179
|
+
invokeWithAdminCap(tx, authority(p), {
|
|
180
|
+
target: `${p.releaseGenrePackageId}::release_genre::add_secondary_genre`,
|
|
181
|
+
arguments: [object(tx, p.releaseId), tx.object(genreId)],
|
|
182
|
+
adminCapIndex: 1,
|
|
183
|
+
});
|
|
184
|
+
}
|
|
185
|
+
for (const assignment of p.trackPrimaryGenres ?? []) {
|
|
186
|
+
invokeWithAdminCap(tx, authority(p), {
|
|
187
|
+
target: `${p.releaseGenrePackageId}::release_genre::set_track_primary_genre`,
|
|
188
|
+
arguments: [
|
|
189
|
+
object(tx, p.releaseId),
|
|
190
|
+
tx.pure.u64(asU64("trackIndex", assignment.trackIndex)),
|
|
191
|
+
tx.object(assignment.genreId),
|
|
192
|
+
],
|
|
193
|
+
adminCapIndex: 1,
|
|
194
|
+
});
|
|
195
|
+
}
|
|
196
|
+
};
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
export type DspLink =
|
|
200
|
+
| { platform: "Spotify"; id: string }
|
|
201
|
+
| {
|
|
202
|
+
platform: "AppleMusic";
|
|
203
|
+
storefront: string;
|
|
204
|
+
albumId: string;
|
|
205
|
+
trackId?: string;
|
|
206
|
+
}
|
|
207
|
+
| { platform: "AmazonMusic"; albumId: string; trackId?: string }
|
|
208
|
+
| { platform: "Bandcamp"; subdomain: string; slug: string }
|
|
209
|
+
| { platform: "Deezer"; id: string }
|
|
210
|
+
| { platform: "SoundCloud"; user: string; slug: string }
|
|
211
|
+
| { platform: "Tidal"; id: string }
|
|
212
|
+
| { platform: "YouTubeMusic"; id: string };
|
|
213
|
+
|
|
214
|
+
function buildDspLink(
|
|
215
|
+
tx: Transaction,
|
|
216
|
+
packageId: string,
|
|
217
|
+
link: DspLink,
|
|
218
|
+
): TransactionArgument {
|
|
219
|
+
switch (link.platform) {
|
|
220
|
+
case "Spotify":
|
|
221
|
+
return tx.add(
|
|
222
|
+
releaseDspLink.newSpotify({ package: packageId, arguments: [link.id] }),
|
|
223
|
+
);
|
|
224
|
+
case "AppleMusic":
|
|
225
|
+
return tx.add(
|
|
226
|
+
link.trackId === undefined
|
|
227
|
+
? releaseDspLink.newAppleMusicAlbum({
|
|
228
|
+
package: packageId,
|
|
229
|
+
arguments: [link.storefront, link.albumId],
|
|
230
|
+
})
|
|
231
|
+
: releaseDspLink.newAppleMusicTrack({
|
|
232
|
+
package: packageId,
|
|
233
|
+
arguments: [link.storefront, link.albumId, link.trackId],
|
|
234
|
+
}),
|
|
235
|
+
);
|
|
236
|
+
case "AmazonMusic":
|
|
237
|
+
return tx.add(
|
|
238
|
+
link.trackId === undefined
|
|
239
|
+
? releaseDspLink.newAmazonMusicAlbum({
|
|
240
|
+
package: packageId,
|
|
241
|
+
arguments: [link.albumId],
|
|
242
|
+
})
|
|
243
|
+
: releaseDspLink.newAmazonMusicTrack({
|
|
244
|
+
package: packageId,
|
|
245
|
+
arguments: [link.albumId, link.trackId],
|
|
246
|
+
}),
|
|
247
|
+
);
|
|
248
|
+
case "Bandcamp":
|
|
249
|
+
return tx.add(
|
|
250
|
+
releaseDspLink.newBandcamp({
|
|
251
|
+
package: packageId,
|
|
252
|
+
arguments: [link.subdomain, link.slug],
|
|
253
|
+
}),
|
|
254
|
+
);
|
|
255
|
+
case "Deezer":
|
|
256
|
+
return tx.add(
|
|
257
|
+
releaseDspLink.newDeezer({ package: packageId, arguments: [link.id] }),
|
|
258
|
+
);
|
|
259
|
+
case "SoundCloud":
|
|
260
|
+
return tx.add(
|
|
261
|
+
releaseDspLink.newSoundcloud({
|
|
262
|
+
package: packageId,
|
|
263
|
+
arguments: [link.user, link.slug],
|
|
264
|
+
}),
|
|
265
|
+
);
|
|
266
|
+
case "Tidal":
|
|
267
|
+
return tx.add(
|
|
268
|
+
releaseDspLink.newTidal({ package: packageId, arguments: [link.id] }),
|
|
269
|
+
);
|
|
270
|
+
case "YouTubeMusic":
|
|
271
|
+
return tx.add(
|
|
272
|
+
releaseDspLink.newYoutubeMusic({
|
|
273
|
+
package: packageId,
|
|
274
|
+
arguments: [link.id],
|
|
275
|
+
}),
|
|
276
|
+
);
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
export interface TrackDspLink {
|
|
281
|
+
trackIndex: U64Input;
|
|
282
|
+
link: DspLink;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
export type SetReleaseDspLinksParams = ReleaseExtensionTarget & {
|
|
286
|
+
releaseLinks?: readonly DspLink[];
|
|
287
|
+
trackLinks?: readonly TrackDspLink[];
|
|
288
|
+
releaseDspLinkPackageId: string;
|
|
289
|
+
};
|
|
290
|
+
|
|
291
|
+
/** Attach release-level and per-track DSP links. */
|
|
292
|
+
export function setReleaseDspLinks(p: SetReleaseDspLinksParams): TxThunk {
|
|
293
|
+
return (tx) => {
|
|
294
|
+
for (const link of p.releaseLinks ?? []) {
|
|
295
|
+
const value = buildDspLink(tx, p.releaseDspLinkPackageId, link);
|
|
296
|
+
invokeWithAdminCap(tx, authority(p), {
|
|
297
|
+
target: `${p.releaseDspLinkPackageId}::release_dsp_link::set_release_link`,
|
|
298
|
+
arguments: [object(tx, p.releaseId), value],
|
|
299
|
+
adminCapIndex: 1,
|
|
300
|
+
});
|
|
301
|
+
}
|
|
302
|
+
for (const item of p.trackLinks ?? []) {
|
|
303
|
+
const value = buildDspLink(tx, p.releaseDspLinkPackageId, item.link);
|
|
304
|
+
invokeWithAdminCap(tx, authority(p), {
|
|
305
|
+
target: `${p.releaseDspLinkPackageId}::release_dsp_link::set_track_link`,
|
|
306
|
+
arguments: [object(tx, p.releaseId), tx.pure.u64(asU64("trackIndex", item.trackIndex)), value],
|
|
307
|
+
adminCapIndex: 1,
|
|
308
|
+
});
|
|
309
|
+
}
|
|
310
|
+
};
|
|
311
|
+
}
|
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
// Copyright (c) Miso Labs, Inc.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
|
|
4
|
+
// Single-PTB publisher for a whole release graph: creates every composition and
|
|
5
|
+
// recording, derives the release id ON-CHAIN
|
|
6
|
+
// (so recordings need not be shared first), builds the tracks/release,
|
|
7
|
+
// then shares everything and transfers the admin caps — all in ONE transaction.
|
|
8
|
+
//
|
|
9
|
+
// Share currencies must already be published + initialized (their Currency objects
|
|
10
|
+
// shared on-chain); their ids/types are passed in. Ordering is load-bearing:
|
|
11
|
+
// 1. composition::new → recording::new(&comp) (borrow-before-share)
|
|
12
|
+
// 2. release::derive_target_release_id(<recording::id results>) →
|
|
13
|
+
// track::new(cap, &rec, derivedId, split) → release::new(registry, …)
|
|
14
|
+
// 3. publish (share) comps + recs + release, disperse supply, transfer caps
|
|
15
|
+
// Steps 1–2 borrow the works; step 3 consumes them into share_object.
|
|
16
|
+
//
|
|
17
|
+
// Release tracks come in two shapes (see TrackNode): recordings created in THIS
|
|
18
|
+
// PTB, and existing recordings authorized by their admin cap.
|
|
19
|
+
//
|
|
20
|
+
// This is the whole-graph orchestration half of the opinionated publish flow —
|
|
21
|
+
// it composes `@misofm/protocol`'s bare `composition`/`recording`/`track`/
|
|
22
|
+
// `release` core call bindings with its
|
|
23
|
+
// own `disperseShares`/`finalizeRelease` helpers into one PTB. Royalty pools are
|
|
24
|
+
// installed later through an admin-cap Vault plugin; the retired raw-cap helper
|
|
25
|
+
// is intentionally not used here.
|
|
26
|
+
|
|
27
|
+
import { Transaction, type TransactionObjectArgument } from "@mysten/sui/transactions";
|
|
28
|
+
import { contracts } from "@misofm/protocol";
|
|
29
|
+
import { custodyOf, disperseShares, finalizeRelease, recordingAuthorityOf, requiredCommandResult, type AdminCustodyInput, type RecordingAuthorityInput, type ShareRecipient } from "./transactions.ts";
|
|
30
|
+
import { disposeNewAdminCap, invokeWithAdminCap } from "./vault.ts";
|
|
31
|
+
|
|
32
|
+
const { composition, recording, track } = contracts;
|
|
33
|
+
|
|
34
|
+
interface CompositionNodeBase {
|
|
35
|
+
shareType: string;
|
|
36
|
+
shareCurrencyId: string;
|
|
37
|
+
shareTreasuryCapId: string;
|
|
38
|
+
title: string;
|
|
39
|
+
royaltyRateBps: number;
|
|
40
|
+
shareRecipients: ShareRecipient[];
|
|
41
|
+
}
|
|
42
|
+
export type CompositionNode = CompositionNodeBase & AdminCustodyInput;
|
|
43
|
+
|
|
44
|
+
interface RecordingNodeBase {
|
|
45
|
+
shareType: string;
|
|
46
|
+
shareCurrencyId: string;
|
|
47
|
+
shareTreasuryCapId: string;
|
|
48
|
+
/** The parent composition's share type. */
|
|
49
|
+
compositionShareType: string;
|
|
50
|
+
shareRecipients: ShareRecipient[];
|
|
51
|
+
}
|
|
52
|
+
type RecordingParent =
|
|
53
|
+
| { readonly parentCompositionIndex: number; readonly parentCompositionId?: never }
|
|
54
|
+
| { readonly parentCompositionIndex?: never; readonly parentCompositionId: string };
|
|
55
|
+
export type RecordingNode = RecordingNodeBase & RecordingParent & AdminCustodyInput;
|
|
56
|
+
|
|
57
|
+
/** A track whose recording is created in THIS PTB. */
|
|
58
|
+
export interface FreshTrackNode {
|
|
59
|
+
/** Index into `recordings[]`. */
|
|
60
|
+
recordingIndex: number;
|
|
61
|
+
splitBps: number;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* A track over an EXISTING recording, authorized by its admin cap held by the
|
|
66
|
+
* sender. This can coexist with recordings created in this PTB.
|
|
67
|
+
*/
|
|
68
|
+
interface CapTrackNodeBase {
|
|
69
|
+
recordingId: string;
|
|
70
|
+
recordingShareType: string;
|
|
71
|
+
compositionShareType: string;
|
|
72
|
+
splitBps: number;
|
|
73
|
+
}
|
|
74
|
+
export type CapTrackNode = CapTrackNodeBase & RecordingAuthorityInput;
|
|
75
|
+
|
|
76
|
+
export type TrackNode = FreshTrackNode | CapTrackNode;
|
|
77
|
+
|
|
78
|
+
const isFresh = (t: TrackNode): t is FreshTrackNode => "recordingIndex" in t;
|
|
79
|
+
|
|
80
|
+
function requiredAt<T>(items: readonly T[], index: number, description: string): T {
|
|
81
|
+
const item = items[index];
|
|
82
|
+
if (item === undefined) throw new Error(`${description} index ${index} is out of range`);
|
|
83
|
+
return item;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
interface ReleaseNodeBase {
|
|
87
|
+
title: string;
|
|
88
|
+
/** u256 nonce as a decimal string (deterministic release id). */
|
|
89
|
+
nonce: string;
|
|
90
|
+
releaseRegistryId: string;
|
|
91
|
+
/** The ordered tracklist. Display grouping (discs/sides) is extension data. */
|
|
92
|
+
tracks: TrackNode[];
|
|
93
|
+
}
|
|
94
|
+
export type ReleaseNode = ReleaseNodeBase & AdminCustodyInput;
|
|
95
|
+
|
|
96
|
+
export interface PublishReleaseGraphParams {
|
|
97
|
+
compositions: CompositionNode[];
|
|
98
|
+
recordings: RecordingNode[];
|
|
99
|
+
release?: ReleaseNode;
|
|
100
|
+
misoPackageId: string;
|
|
101
|
+
minatoPackageId: string;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
interface Parts {
|
|
105
|
+
work: TransactionObjectArgument;
|
|
106
|
+
adminCap: TransactionObjectArgument;
|
|
107
|
+
balance: TransactionObjectArgument;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/** Builds the entire graph in a single transaction (see file header for ordering). */
|
|
111
|
+
export function publishReleaseGraph(params: PublishReleaseGraphParams): (tx: Transaction) => void {
|
|
112
|
+
const { misoPackageId: pkg, minatoPackageId } = params;
|
|
113
|
+
return (tx) => {
|
|
114
|
+
// ── 1) Create every composition, then every recording (borrow-before-share) ──
|
|
115
|
+
const comps: Parts[] = params.compositions.map((c) => {
|
|
116
|
+
const r = tx.add(
|
|
117
|
+
composition._new({
|
|
118
|
+
package: pkg,
|
|
119
|
+
typeArguments: [c.shareType],
|
|
120
|
+
arguments: [tx.pure.string(c.title), tx.pure.u16(c.royaltyRateBps), tx.object(c.shareCurrencyId), tx.object(c.shareTreasuryCapId)],
|
|
121
|
+
}),
|
|
122
|
+
);
|
|
123
|
+
const parts: Parts = {
|
|
124
|
+
work: requiredCommandResult(r, 0, "composition::_new"),
|
|
125
|
+
adminCap: requiredCommandResult(r, 1, "composition::_new"),
|
|
126
|
+
balance: requiredCommandResult(r, 2, "composition::_new"),
|
|
127
|
+
};
|
|
128
|
+
return parts;
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
const recTypeArgs = (i: number): [string, string] => {
|
|
132
|
+
const n = requiredAt(params.recordings, i, "recording");
|
|
133
|
+
return [n.shareType, n.compositionShareType];
|
|
134
|
+
};
|
|
135
|
+
|
|
136
|
+
const recs: Parts[] = params.recordings.map((rec, i) => {
|
|
137
|
+
const parent = rec.parentCompositionIndex !== undefined
|
|
138
|
+
? requiredAt(comps, rec.parentCompositionIndex, "parent composition").work
|
|
139
|
+
: tx.object(rec.parentCompositionId);
|
|
140
|
+
const typeArgs = recTypeArgs(i);
|
|
141
|
+
const r = tx.add(
|
|
142
|
+
recording._new({ package: pkg, typeArguments: typeArgs, arguments: [parent, tx.object(rec.shareCurrencyId), tx.object(rec.shareTreasuryCapId)] }),
|
|
143
|
+
);
|
|
144
|
+
const parts: Parts = {
|
|
145
|
+
work: requiredCommandResult(r, 0, "recording::_new"),
|
|
146
|
+
adminCap: requiredCommandResult(r, 1, "recording::_new"),
|
|
147
|
+
balance: requiredCommandResult(r, 2, "recording::_new"),
|
|
148
|
+
};
|
|
149
|
+
return parts;
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
// ── 2) Release: derive the id on-chain, then tracks → release ──────────
|
|
153
|
+
if (params.release) {
|
|
154
|
+
const rel = params.release;
|
|
155
|
+
const ordered = rel.tracks;
|
|
156
|
+
const idVec = tx.makeMoveVec({
|
|
157
|
+
type: "0x2::object::ID",
|
|
158
|
+
elements: ordered.map((t) =>
|
|
159
|
+
isFresh(t)
|
|
160
|
+
? tx.moveCall({
|
|
161
|
+
target: "0x2::object::id",
|
|
162
|
+
typeArguments: [
|
|
163
|
+
`${pkg}::recording::Recording<${recTypeArgs(t.recordingIndex).join(",")}>`,
|
|
164
|
+
],
|
|
165
|
+
arguments: [requiredAt(recs, t.recordingIndex, "fresh recording").work],
|
|
166
|
+
})
|
|
167
|
+
: tx.pure.id(t.recordingId),
|
|
168
|
+
),
|
|
169
|
+
});
|
|
170
|
+
const splitVec = tx.makeMoveVec({ type: "u64", elements: ordered.map((t) => tx.pure.u64(t.splitBps)) });
|
|
171
|
+
// This returns an ID value (not an object); pass the result straight to
|
|
172
|
+
// `track::new` so every track consents to this exact release target.
|
|
173
|
+
const releaseId = tx.moveCall({
|
|
174
|
+
target: `${pkg}::release::derive_target_release_id`,
|
|
175
|
+
arguments: [tx.object(rel.releaseRegistryId), idVec, splitVec, tx.pure.u256(BigInt(rel.nonce))],
|
|
176
|
+
});
|
|
177
|
+
|
|
178
|
+
const trackArgs = ordered.map((t) => {
|
|
179
|
+
if (isFresh(t)) {
|
|
180
|
+
const typeArgs = recTypeArgs(t.recordingIndex);
|
|
181
|
+
const parts = requiredAt(recs, t.recordingIndex, "fresh recording");
|
|
182
|
+
return tx.add(track._new({ package: pkg, typeArguments: typeArgs, arguments: [parts.adminCap, parts.work, releaseId, tx.pure.u16(t.splitBps)] }));
|
|
183
|
+
}
|
|
184
|
+
const typeArgs: [string, string] = [t.recordingShareType, t.compositionShareType];
|
|
185
|
+
const rec = tx.object(t.recordingId);
|
|
186
|
+
return invokeWithAdminCap(tx, recordingAuthorityOf(t), {
|
|
187
|
+
target: `${pkg}::track::new`,
|
|
188
|
+
typeArguments: typeArgs,
|
|
189
|
+
arguments: [rec, releaseId, tx.pure.u16(t.splitBps)],
|
|
190
|
+
adminCapIndex: 0,
|
|
191
|
+
});
|
|
192
|
+
});
|
|
193
|
+
const trackVec = tx.makeMoveVec({ type: `${pkg}::track::Track`, elements: trackArgs });
|
|
194
|
+
const created = tx.moveCall({
|
|
195
|
+
target: `${pkg}::release::new`,
|
|
196
|
+
arguments: [tx.object(rel.releaseRegistryId), tx.pure.string(rel.title), trackVec, tx.pure.u256(BigInt(rel.nonce))],
|
|
197
|
+
});
|
|
198
|
+
const releaseParts = {
|
|
199
|
+
release: requiredCommandResult(created, 0, "release::new"),
|
|
200
|
+
adminCap: requiredCommandResult(created, 1, "release::new"),
|
|
201
|
+
};
|
|
202
|
+
finalizeRelease(tx, { ...releaseParts, adminCustody: custodyOf(rel), misoPackageId: pkg });
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
// ── 3) Share every work, disperse its supply, transfer admin caps ──
|
|
206
|
+
params.compositions.forEach((c, i) => {
|
|
207
|
+
const parts = requiredAt(comps, i, "composition");
|
|
208
|
+
disperseShares(tx, minatoPackageId, c.shareType, parts.balance, c.shareRecipients);
|
|
209
|
+
tx.add(composition.publish({ package: pkg, typeArguments: [c.shareType], arguments: [parts.work, parts.adminCap] }));
|
|
210
|
+
disposeNewAdminCap(tx, parts.adminCap, custodyOf(c));
|
|
211
|
+
});
|
|
212
|
+
params.recordings.forEach((rec, i) => {
|
|
213
|
+
const parts = requiredAt(recs, i, "recording");
|
|
214
|
+
tx.add(recording.publish({ package: pkg, typeArguments: recTypeArgs(i), arguments: [parts.work, parts.adminCap] }));
|
|
215
|
+
disperseShares(tx, minatoPackageId, rec.shareType, parts.balance, rec.shareRecipients);
|
|
216
|
+
disposeNewAdminCap(tx, parts.adminCap, custodyOf(rec));
|
|
217
|
+
});
|
|
218
|
+
};
|
|
219
|
+
}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
// Copyright (c) Miso Labs, Inc.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
|
|
4
|
+
// Embedded share-currency bytecode template: the compiled `share` Move package
|
|
5
|
+
// (deps 0x1/0x2, network-agnostic). `patchInitializer` stamps the INITIALIZER
|
|
6
|
+
// address into a fresh copy before publish. Kept as a typed const rather than a
|
|
7
|
+
// JSON asset so the SDK is self-contained — no file read, no path resolution, and
|
|
8
|
+
// it bundles cleanly. Regenerate from the compiled package if the share module
|
|
9
|
+
// changes.
|
|
10
|
+
|
|
11
|
+
import type { PackageBytecode } from "./transactions.ts";
|
|
12
|
+
|
|
13
|
+
export const SHARE_TEMPLATE: PackageBytecode = {
|
|
14
|
+
"modules": [
|
|
15
|
+
"oRzrCwYAAAAKAQAOAg4gAy4gBE4EBVJHB5kB1QEI7gJgBs4DNwqFBAYMiwQ4ABEBEgIHAggCCQIPAhMAAggAAQMHAAMEDAEAAQQACAAEAQABAAEFBgQABgUCAAANAAEAARQFBgACCwUEAAQKCgIBAAQOCAkBCAYQAwQABAcDBwUIAQgBCAEHCAMHCAYBCwIBCAAAAQYIBgEFAQoCAQgBAQgABwcIAwIIAQgBCAEIAQcIBgILBAEJAAsCAQkAAgsEAQkABwgGDENvaW5SZWdpc3RyeRNDdXJyZW5jeUluaXRpYWxpemVyBVNoYXJlBlN0cmluZwtUcmVhc3VyeUNhcAlUeENvbnRleHQDVUlEB2FkZHJlc3MEY29pbg1jb2luX3JlZ2lzdHJ5IGZpbmFsaXplX2FuZF9kZWxldGVfbWV0YWRhdGFfY2FwCmZyb21fYnl0ZXMCaWQKaW5pdGlhbGl6ZQxuZXdfY3VycmVuY3kGb2JqZWN0BnNlbmRlcgVzaGFyZQZzdHJpbmcKdHhfY29udGV4dAR1dGY4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACCgIhIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAwgAAAAAAAAAAAoCBgVTSEFSRQACAQwIBQABAAABHAoELhEFBwARAiEECAUOCwQBCwMBBwEnCwMxBgcCEQELAAsBCwIKBDgADAULBDgBCwUCAA=="
|
|
16
|
+
],
|
|
17
|
+
"dependencies": [
|
|
18
|
+
"0x0000000000000000000000000000000000000000000000000000000000000001",
|
|
19
|
+
"0x0000000000000000000000000000000000000000000000000000000000000002"
|
|
20
|
+
],
|
|
21
|
+
"digest": [
|
|
22
|
+
191,
|
|
23
|
+
44,
|
|
24
|
+
36,
|
|
25
|
+
112,
|
|
26
|
+
72,
|
|
27
|
+
10,
|
|
28
|
+
163,
|
|
29
|
+
173,
|
|
30
|
+
88,
|
|
31
|
+
79,
|
|
32
|
+
123,
|
|
33
|
+
99,
|
|
34
|
+
33,
|
|
35
|
+
92,
|
|
36
|
+
255,
|
|
37
|
+
215,
|
|
38
|
+
122,
|
|
39
|
+
199,
|
|
40
|
+
22,
|
|
41
|
+
101,
|
|
42
|
+
247,
|
|
43
|
+
141,
|
|
44
|
+
222,
|
|
45
|
+
237,
|
|
46
|
+
187,
|
|
47
|
+
42,
|
|
48
|
+
28,
|
|
49
|
+
13,
|
|
50
|
+
201,
|
|
51
|
+
193,
|
|
52
|
+
173,
|
|
53
|
+
204
|
|
54
|
+
]
|
|
55
|
+
};
|