Solana Mobile dApp Publishing

https://docs.solanamobile.com/dapp-publishing/
Admin
Solana Mobile dApp Publishing provides tools and guides for developers to publish decentralized...
Tokens:22,277
Snippets:247
Trust Score:9.7
Update:8 months ago
Show doc for...
Tokens:
Raw
### Initialize Solana Dapp Store CLI Project

Source: https://docs.solanamobile.com/dapp-publishing/setup

This sequence of commands sets up a new Solana dapp publishing project. It involves creating a directory, initializing a PNPM project, installing the dapp-store CLI, and initializing the CLI for use.

```bash
mkdir publishing
cd publishing

pnpm init
pnpm install --save-dev @solana-mobile/dapp-store-cli
npx dapp-store init
npx dapp-store --help
```

--------------------------------

### Install and Activate PNPM with Corepack

Source: https://docs.solanamobile.com/dapp-publishing/setup

This snippet demonstrates how to enable and prepare PNPM using Corepack, ensuring the correct version is activated for CLI tooling. It includes a fallback for systems without 'jq'.

```bash
corepack enable
corepack prepare pnpm@`npm info pnpm --json | jq -r .version` --activate
```

```bash
corepack prepare pnpm@7.13.4 --activate
```

--------------------------------

### Install Android SDK Command-line Tools and Build Tools

Source: https://docs.solanamobile.com/dapp-publishing/building-expo-apk

These commands are used to install or update necessary Android SDK components. The first command installs the command-line tools, while the second installs a specific version of the build tools, which is crucial for packaging Android applications. Replace `build-tools-version` with the desired version number.

```bash
sdkmanager "build-tools;build-tools-version"
```

```bash
sdkmanager "build-tools;34.0.0"
```

--------------------------------

### Update Solana Dapp Store CLI

Source: https://docs.solanamobile.com/dapp-publishing/setup

Updates the Solana dapp-store CLI to the latest version available on npm. This is essential for ensuring compatibility and accessing the newest features or bug fixes, especially if CI/CD deployments are failing.

```bash
pnpm install --save-dev @solana-mobile/dapp-store-cli@latest
```

--------------------------------

### Install Signed APK on Device or Emulator

Source: https://docs.solanamobile.com/dapp-publishing/publishing-a-pwa

Installs the signed release APK onto a connected Android emulator or testing device. This allows you to test the app's functionality before submitting it to the dApp Store.

```bash
bubblewrap install app-release-signed.apk
```

--------------------------------

### Install Bubblewrap CLI using npm

Source: https://docs.solanamobile.com/dapp-publishing/publishing-a-pwa

Installs the Bubblewrap Command Line Interface (CLI) globally using npm. This tool is required to simplify the process of converting a PWA into an Android app via Trusted Web Activity (TWA). Requires Node.js version 14.15.0 or higher.

```bash
npm i -g @bubblewrap/cli

```

--------------------------------

### Link to dApp Store Listing from Kotlin (Android)

Source: https://docs.solanamobile.com/dapp-publishing/link-to-dapp-listing-page

Shows how to create an Android `Intent` in Kotlin to navigate to the dApp Store listing page. It parses the URI and checks if an activity can handle the intent before starting it.

```kotlin
// Create an Android intent to navigate to the listing page  
val intent = Intent(Intent.ACTION_VIEW).apply {  
    data = Uri.parse("solanadappstore://details?id=com.solanamobile.mintyfresh")  
    // Make sure there's an activity that can handle this intent  
    resolveActivity(packageManager)?.let {  
        startActivity(this)  
    }  
}  
```

--------------------------------

### Configure Android SDK Build Tools Directory

Source: https://docs.solanamobile.com/dapp-publishing/setup

Sets the ANDROID_TOOLS_DIR environment variable in a .env file, pointing to the specific version of the Android SDK build tools required by the dapp-store CLI. This is crucial for CLI operations that depend on these tools.

```bash
echo "ANDROID_TOOLS_DIR=\"<path_to_android_sdk_version_build_tools_dir>\"" > .env
```

--------------------------------

### Install Android SDK Build Tools (Mac)

Source: https://docs.solanamobile.com/dapp-publishing/building-expo-apk

This command provides an alternative method for installing Android SDK build tools on macOS, using a full path to the `sdkmanager`. It's useful when the standard `sdkmanager` command is not directly accessible in the PATH. Replace `34.0.0` with the specific build tools version required.

```bash
~/Library/Android/sdk/cmdline-tools/latest/bin/sdkmanager "build-tools;34.0.0"
```

--------------------------------

### Initialize TWA Project with Bubblewrap CLI

Source: https://docs.solanamobile.com/dapp-publishing/publishing-a-pwa

Initializes a new Trusted Web Activity (TWA) project using the Bubblewrap CLI. This command takes the URL of your PWA's web manifest and uses it to pre-fill metadata for the TWA's manifest. It may prompt for additional tooling installations like the Android SDK.

```bash
bubblewrap init --manifest https://your-pwa-url.com/manifest.json

```

--------------------------------

### Build Signed Release APK with Bubblewrap CLI

Source: https://docs.solanamobile.com/dapp-publishing/publishing-a-pwa

Builds an initialized Android project and outputs a signed release APK, which is the file submitted for publishing on the dApp Store. Allows installation of additional tooling if required.

```bash
bubblewrap build
```

--------------------------------

### Configure Dual-Store Signing in Android Gradle

Source: https://docs.solanamobile.com/dapp-publishing/publishing-from-google-play

Configures dual-store signing in the `app/build.gradle` file using product flavors for both Google Play and the dApp Store. This setup allows for distinct signing configurations for each distribution channel. The release build type assigns the appropriate signing config to each flavor.

```gradle
android {
    signingConfigs {
        // Existing Google Play signing config
        googlePlay {
            storeFile file("keystores/googleplay.keystore")
            storePassword "your_googleplay_keystore_password"
            keyAlias "googleplay"
            keyPassword "your_googleplay_key_password"
        }

        // dApp Store signing config
        dappStore {
            storeFile file("keystores/dappstore.keystore")
            storePassword "your_dappstore_keystore_password"
            keyAlias "dappstore"
            keyPassword "your_dappstore_key_password"
        }
    }

    flavorDimensions = ['store']

    productFlavors {
        googlePlay {
            dimension 'store'
        }

        dappStore {
            dimension 'store'
        }
    }

    buildTypes {
        release {
            // Assign signing configs to each flavor
            productFlavors.googlePlay.signingConfig signingConfigs.googlePlay
            productFlavors.dappStore.signingConfig signingConfigs.dappStore
        }
    }
}
```

--------------------------------

### Sign APK using Android apksigner

Source: https://docs.solanamobile.com/dapp-publishing/building-expo-apk

This command signs an unsigned APK file using the generated keystore. It specifies the keystore file, the key alias, the output path for the signed APK, and the input unsigned APK file. Ensure the paths and alias match your project setup.

```bash
~/Library/Android/sdk/build-tools/35.0.0/apksigner sign \
    --ks ./dapp-store-signing-keys/release-key.keystore \
    --ks-key-alias myapp \
    --out ./dapp-store-build/myapp-v0.0.1-signed.apk \
    ./dapp-store-build/myapp-v0.0.1-unsigned.apk
```

--------------------------------

### Web Manifest Template for PWA

Source: https://docs.solanamobile.com/dapp-publishing/publishing-a-pwa

A basic template for a PWA's web manifest file. This JSON file defines essential app properties like name, icons, and the starting URL, which are necessary for publishing on the dApp Store.

```json
{
    "name": "APP_NAME",
    "short_name": "APP_NAME",
    "scope": "/",
    "start_url": "/",
    "icons": [
        {
            "src": "/android-chrome-192x192.png",
            "sizes": "192x192",
            "type": "image/png"
        },
        {
            "src": "/android-chrome-512x512.png",
            "sizes": "512x512",
            "type": "image/png"
        }
    ],
    "theme_color": "#ffffff",
    "background_color": "#ffffff",
    "display": "standalone"
}

```

--------------------------------

### Submit dApp for Review using dapp-store CLI

Source: https://docs.solanamobile.com/dapp-publishing/submit

This command submits your dApp, including the App NFT and Release NFT, to the Solana dApp Publisher Portal for inclusion in the dApp Store catalog. It requires your keypair path, the mainnet beta RPC URL, and confirmation flags for authorization and policy compliance. Ensure your network connection is stable.

```bash
npx dapp-store publish submit -k <path_to_your_keypair> -u <mainnet_beta_rpc_url> --requestor-is-authorized --complies-with-solana-dapp-store-policies
```

--------------------------------

### Mint a Release NFT using dapp-store CLI

Source: https://docs.solanamobile.com/dapp-publishing/submit

This command is used to mint a Release NFT, which contains metadata for a specific dApp release version. It requires the path to your keypair and Android SDK build tools. An optional RPC URL for the mainnet beta can also be provided. This step should be repeated for each new dApp version.

```bash
npx dapp-store create release -k <path_to_your_keypair> -b <path_to_your_android_sdk_build_tools> [-u <mainnet_beta_rpc_url>]
```

--------------------------------

### Localize dApp Store Details (YAML)

Source: https://docs.solanamobile.com/dapp-publishing/prepare

This YAML configuration demonstrates how to localize dApp store details for different locales. It shows the structure for defining app name, descriptions, and feature lists in French (France) alongside the default English (US) locale. This allows dApp stores to present localized information to users based on their device's language settings.

```yaml
release:  
    catalog:  
        en-US:  
          name: Name of app in English  
          ...
        fr-FR:  
            name: >-  
              Name of app in French (France)  
            short_description: >-  
              Short app description in French (France)  
            long_description: |
              Long app description in French (France)  
            new_in_version: >-  
              New version features in French (France)  
            saga_features: >-  
              Saga features in French (France)  
```

--------------------------------

### Build Signed APK for dApp Store

Source: https://docs.solanamobile.com/dapp-publishing/publishing-from-google-play

Builds the signed APK specifically for the dApp Store release using Gradle. This command generates the `app-dappStore-release.apk` file, which is ready for submission to the dApp Store. Alternatively, this can be done via Android Studio by selecting the 'dappStoreRelease' build variant.

```bash
./gradlew assembleDappStoreRelease
```

--------------------------------

### Link to dApp Store Listing from React Native

Source: https://docs.solanamobile.com/dapp-publishing/link-to-dapp-listing-page

Demonstrates how to use the React Native `Linking` library to open the dApp Store listing page. It checks if the URL can be opened before attempting to open it, providing error handling.

```javascript
import { Linking } from "react-native";  

// Use the React Native `Linking` library to open the URL  
const linkToListing = () => {  
  const url = "solanadappstore://details?id=com.solanamobile.mintyfresh";  
  Linking.canOpenURL(url)  
    .then((supported) => {  
      if (supported) {  
        Linking.openURL(url);  
      } else {  
        console.error("Unable to link to dApp Store");  
      }  
    })  
    .catch((err) => console.error("An error occurred", err));  
};  
```

--------------------------------

### Generate Keystore for Signing APK

Source: https://docs.solanamobile.com/dapp-publishing/building-expo-apk

This command generates a Java Keystore file (`release-key.keystore`) used for signing Android application packages. It specifies key algorithm (RSA), key size (2048 bits), and validity period (50000 days). The alias `myapp` should be replaced with a unique identifier for your application.

```bash
keytool -genkey -v -keystore release-key.keystore -alias myapp -keyalg RSA -keysize 2048 -validity 50000
```

--------------------------------

### Build APK using EAS CLI

Source: https://docs.solanamobile.com/dapp-publishing/building-expo-apk

This command initiates the EAS build process for an Android application using the 'dapp-store' profile defined in `eas.json`. The `--profile dapp-store` flag ensures that the build is configured to output an APK as specified.

```bash
npx eas build -p android --profile dapp-store
```

--------------------------------

### Generate New Signing Key for dApp Store

Source: https://docs.solanamobile.com/dapp-publishing/publishing-from-google-play

Generates a new, unique signing key exclusively for the dApp Store. This is a critical step as the same signing key cannot be used for both Google Play and the dApp Store. Ensure the keystore file and passwords are stored securely.

```bash
keytool -genkey -v -keystore dappstore.keystore \
  -alias dappstore \
  -keyalg RSA \
  -keysize 2048 \
  -validity 10000
```
Tokens:
Raw