Skip to content

Latest commit

 

History

History
125 lines (98 loc) · 4.24 KB

README.md

File metadata and controls

125 lines (98 loc) · 4.24 KB
Raw

Prerequisites

  • Node 18+
  • PNPM
  • Android SDK build tools
corepack enable
corepack prepare pnpm@`npm info pnpm --json | jq -r .version` --activate

Corepack requires a version to enable, so if you don't have jq installed, you can install it, or just manually get the current version of pnpm with npm info pnpm and use it like this:

corepack prepare pnpm@7.13.4 --activate

You must have the Android SDK build tools available for use by the dapp-store CLI. If you have Android Studio, these tools are available as part of that installation (for e.g., on MacOS, they can be found in ~/Library/Android/sdk/build-tools/). If you do not have Android Studio installed, or wish to use a standalone version of the Android SDK build tools, please follow the instructions here. The path to the SDK build tools can be provided either directly to subcommands that require it with the -b option, or indirectly via a .env file:

echo "ANDROID_TOOLS_DIR=\"<path_to_android_sdk_build_tools_dir>\"" > .env

Usage

In your application folder (e.g., example):

cd example
pnpm install --save-dev @solana-mobile/dapp-store-cli
npx dapp-store --help

or with yarn

cd example
yarn add @solana-mobile/dapp-store-cli
yarn run dapp-store --help

or with npm

cd example
npm install --save-dev @solana-mobile/dapp-store-cli
npx dapp-store --help

Overview

Publishers, applications, and releases on the Saga Dapp Store are all represented as NFTs, with some modifications.

"Publishers" are Metaplex Certified Collection (MCC) NFTs that have can have many "apps" associated with them.

"Apps" are also MCC NFTs that can have many "releases" associated with them.

"Releases" are immutable Metaplex NFTs that can only be issued once per-version. Any new releases must be re-issued as a new NFT.

A typical publishing flow might look like:

  1. Create a publisher (dapp-store create publisher ...)
  2. Create an app (dapp-store create app ...)
  3. Create a release (dapp-store create release ...)
  4. Submit an app for review (dapp-store publish submit ...)

Repeat steps 3. and 4. as needed!

Editor's Note

The dapp-store CLI handles rote tasks like uploading assets to immutable file storage and i18n. However, it is by no means the only way to create these NFTs—all information about the requirements are specified in this repository, and the packages have been designed to be portable to other client contexts besides the CLI.

CLI Updates

The CLI will automatically check for updated versions on npm and restrict operations if the version bump is significant enough. If your CI/CD deployments fail be sure to check if there is a required update.

Configuration

In config.yaml:

publisher:
  name: My new publisher name
  address: BrWNieTsfdkkwMaz2A616i1fkqSjxk2kHhTn1Y44pi48
  website: https://solanamobile.com
  email: hello@solanamobile.com
  media:
    - purpose: icon
      uri: ./media/publisher_icon.jpeg
app:
  name: My new app name
  address: 4xE4MDVHfFAXMKKzqrJ2v1HxcgYgdoV98nuvd8SRKhWP
  android_package: com.company.dapp
  urls:
    license_url: http://cdn.org/license.html
    copyright_url: http://cdn.org/copyright.html
    privacy_policy_url: http://cdn.org/privacy.html
    website: http://cdn.org
  media:
    - purpose: icon
      uri: ./media/app_icon.jpeg
release:
  address: HeXP8pLxxzWPo1j7FwsytrCBN9Q7HZ3MA8TVCVGj5eCA
  media:
    - purpose: screenshot
      uri: ./media/app_screenshot.png
  files:
    - purpose: install
      uri: ./files/app-debug.apk
  catalog:
    en-US:
      name: |
        A nice, helpful dApp name
      long_description: |
        Some wonderful release notes, in long-form
      new_in_version: |
        Something new in this version
      saga_features: |
        Some information about saga specific features
solana_mobile_dapp_publisher_portal:
  google_store_package: com.company.dapp.otherpkg
  testing_instructions: >
    Here are some steps informing Solana Mobile of how to test this dapp. You
    can specify multiple lines of instructions. For example, if a login is
    needed, you would add those details here.