Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Sol Cerberus

Update Sol Cerberus app (JS SDK)

Table of contents

  1. solCerberus.updateApp()
    1. With Javascript:
    2. With React:

The Sol Cerberus apps can be updated with the solCerberus.updateApp() method provided by the JS SDK, it supports the following params:

solCerberus.updateApp()

  • name A name to identify your app (up to 16 characters).
  • recovery (optional): Use a secondary wallet’s public key as a backup in case the original wallet is stolen or lost.
  • options (optional): Additional parameters to customize behavior:
    • authority (optional) PubKey: Updates the authority wallet of the Sol Cerberus app.
    • cached (optional) Boolean: Wether the Roles and Permissions should be cached on client side.
    • getIx (optional) Boolean: When True returns the instruction instead of executing the command on Solana’s RPC.
    • confirmOptions (optional) Object containing the RPC confirm options:
      • skipPreflight (optional) boolean; Disables transaction verification step.
      • commitment (optional) “processed”, “confirmed” or “finalized”: Desired commitment level.
      • preflightCommitment (optional) Commitment: Preflight commitment level.
      • maxRetries (optional) number: Maximum number of times for the RPC node to retry.
      • minContextSlot (optional) number: The minimum slot that the request can be evaluated at.

With Javascript:

Minimum example on how to update an app using plain Javascript:

import { Keypair, PublicKey, Connection, clusterApiUrl} from "@solana/web3.js";
import { solCerberus, getProvider } from "sol-cerberus-js";
import * as anchor from "@project-serum/anchor";

/** Create a connection. **/
const connection = new Connection(clusterApiUrl("mainnet-beta"), "confirmed");
/**  NOTE: Replace the following Uint8Array by your own wallet private key **/
const wallet = Keypair.fromSecretKey(Uint8Array.from([174, 47, ...]));
 
const solCerberus = new SolCerberus(connection, wallet, {appId: new PublicKey("PASTE_YOUR_SOL_CERBERUS_APP_ID_HERE")});
// Update existing Sol Cerberus app on-chain:
await solCerberus.updateApp("myNewName", null) // Async func

With React:

Small example on how to update an existing app with React:

import React, { startTransition, useEffect, useState } from "react";
import { useConnection, useWallet } from "@solana/wallet-adapter-react";
import { SolCerberus } from "sol-cerberus-js";
import { PublicKey } from "@solana/web3.js";

export default function MyReactComponent({ router }) {
  const [solCerberus, setSolCerberus] = useState<SolCerberus | null>(null);
  const { connection } = useConnection();
  const { publicKey, wallet } = useWallet();
  const [newName, setNewName] = useState("");
  const [success, setSuccess] = useState(false);

  const clearStates = () => {
    if (solCerberus) {
      solCerberus.disconnect(); // Remove Websockets listeners
      startTransition(() => setSolCerberus(null));
    }
  };

  const getAppData = async (name = null) => {
    const appData = await solCerberus.getAppData();
    startTransition(() => {
      setNewName(name ?? appData.name);
    });
  };

  const handleUpdateApp = async () => {
    await solCerberus.updateApp(newName);
    getAppData(newName);
    startTransition(() => setSuccess(true));
  };

  // STEP 1: Init Sol Cerberus
  useEffect(() => {
    // Clear all data when user's wallet has been disconnected
    if (!publicKey) {
      return clearStates();
    }
    if (solCerberus) return;
    startTransition(() =>
      setSolCerberus(
        new SolCerberus(connection, wallet, {
          appId: new PublicKey("PASTE_YOUR_SOL_CERBERUS_APP_ID_HERE"),
        })
      )
    );
    return () => clearStates();
  }, [publicKey]);

  // STEP 2: Fetch app data
  useEffect(() => {
    if (solCerberus) getAppData();
  }, [solCerberus]);

  // Removes the success message 7s after the app is updated
  useEffect(() => {
    const timer = setTimeout(() => setSuccess(false), 7000);
    return () => clearTimeout(timer);
  }, [success]);

  return (
    <div>
      {!!solCerberus && (
        <div>
          <input
            type="text"
            value={newName}
            onChange={(e) => setNewName(e.target.value)}
            maxLength={16}
          />
          <button onClick={handleUpdateApp}>Update app name</button>
          {success && <div>The app has been updated!</div>}
        </div>
      )}
    </div>
  );
}

Create Sol Cerberus app

Delete Sol Cerberus app