app_store: wip new api

This commit is contained in:
bitful-pannul 2024-08-06 21:06:43 +03:00
parent fd8c97624e
commit 190b41580e

View File

@ -1,20 +1,44 @@
interface main {
interface download {
//
// app store API as presented by main:app_store:sys-v0
// download API as presented by download:app_store:sys-v0
//
use standard.{package-id};
record onchain-metadata {
name: option<string>,
description: option<string>,
image: option<string>,
external-url: option<string>,
animation-url: option<string>,
properties: onchain-properties,
record download-request {
package-id: package-id,
download-from: string,
desired-version-hash: option<string>,
}
record onchain-properties {
// I wonder if these should be long-running instead.
// updates from FT worker or lack of them might come back as updates first, which is fine.
// the approve/deny is useful but not guaranteed, could be an intra process thing, separate request.
variant download-response {
started,
bad-response,
denied(reason),
already-exists,
already-downloading,
}
}
interface chain {
//
// on-chain API as presented by chain:app_store:sys-v0
//
use standard.{package-id};
record on-chain-app {
metadata-uri: string,
metadata-hash: string,
// this might be a thing internally, but could also just be fetched on demand
// would negate them becoming outdated
metadata: option<metadata-file>,
}
record metadata-file {
package-name: string,
publisher: string,
current-version: string,
@ -26,98 +50,59 @@ interface main {
dependencies: option<list<string>>,
}
variant request {
remote(remote-request),
local(local-request),
record get-app {
app: package-id,
}
variant response {
remote(remote-response),
local(local-response),
record get-app-response {
app: on-chain-app,
}
variant remote-request {
download(remote-download-request),
}
// add variant
// and these:
// start-mirroring(package-id),
// stop-mirroring(package-id),
// start-auto-update(package-id),
// stop-auto-update(package-id),
record remote-download-request {
package-id: package-id,
desired-version-hash: option<string>,
}
}
variant remote-response {
download-approved,
download-denied(reason),
}
variant reason {
no-package,
not-mirroring,
hash-mismatch(hash-mismatch),
file-not-found,
worker-spawn-failed
}
record hash-mismatch {
requested: string,
have: string,
}
interface main {
//
// app store API as presented by :app_store:sys-v0
//
variant local-request {
new-package(new-package-request),
download(download-request),
install(package-id),
install(package-id), // bytes in blob?
uninstall(package-id),
start-mirroring(package-id),
stop-mirroring(package-id),
start-auto-update(package-id),
stop-auto-update(package-id),
rebuild-index,
apis,
get-api(package-id),
}
record new-package-request {
package-id: package-id,
metadata: onchain-metadata,
mirror: bool,
}
use standard.{package-id};
record download-request {
package-id: package-id,
download-from: string,
mirror: bool,
auto-update: bool,
desired-version-hash: option<string>,
}
// find a place for these, error type for each world.
// variant reason {
// no-package,
// not-mirroring,
// hash-mismatch(hash-mismatch),
// file-not-found,
// worker-spawn-failed
// }
// record hash-mismatch {
// requested: string,
// have: string,
// }
variant local-response {
new-package-response(new-package-response),
download-response(download-response),
install-response(install-response),
uninstall-response(uninstall-response),
mirror-response(mirror-response),
auto-update-response(auto-update-response),
rebuild-index-response(rebuild-index-response),
apis-response(apis-response),
get-api-response(get-api-response),
}
enum new-package-response {
success,
no-blob,
install-failed,
already-exists,
}
variant download-response {
started,
bad-response,
denied(reason),
already-exists,
already-downloading,
}
enum install-response {
success,
failure, // TODO
@ -128,21 +113,7 @@ interface main {
failure, // TODO
}
enum mirror-response {
success,
failure, // TODO
}
enum auto-update-response {
success,
failure, // TODO
}
enum rebuild-index-response {
success,
failure, // TODO
}
// TODO: not sure where exactly these should be
record apis-response {
apis: list<package-id>,
}
@ -156,5 +127,7 @@ interface main {
world app-store-sys-v0 {
import main;
import download;
import chain;
include process-v0;
}