0072 XLS-72d: Browser Wallet Standard

[tequdev]

Abstract

This is a standard specification for developers to incorporate Wallet functionality into their own dApps. By having wallet support this specification, dApps developers can use the wallet functionality through a standardized API without the need to support individual wallets.

This specification is based on the following WalletStandard:
https://github.com/wallet-standard/wallet-standard

And, this only covers the Browser extension wallet.

namespace

xrpl:

Chains

xrpl:<NetworkID>

e.g) xrpl:0, xrpl:1, xrpl:2

Alias

• xrpl:mainnet -> xrpl:0
• xrpl:testnet -> xrpl:1
• xrpl:devnet -> xrpl:2
• xrpl:xahau-mainnet -> xrpl:21337
• xrpl:xahau-testnet -> xrpl:21338

features

Definitions of the original standard:

• standard:connect
• standard:disconnect
• standard:events

Definitions of this standard:

• xrpl:signTransaction
• xrpl:signAndSubmitTransaction

interface

xrpl:signTransaction

import type { Wallet, WalletAccount }from '@wallet-standard/core';

type XRPLSignTransactionVersion = '1.0.0';

type XRPLSignTransactionFeature = {
  'xrpl:signTransaction': {
    version: XRPLSignTransactionVersion;
    signTransaction: XRPLSignTransactionMethod;
  };
};

type XRPLSignTransactionMethod = (
  input: XRPLSignTransactionInput
) => Promise<SignTransactionOutput>;

interface XRPLSignTransactionInput {
  tx_json: Transaction
  account: WalletAccount;
  network: XRPLIdentifierString; // `xrpl:<NetworkID>`
  options?: SignTransactionOption;
}

interface SignTransactionOutput {
  signed_tx_blob: string;
}

interface SignTransactionOption {
  autofill?: boolean;
  multisig?: boolean;
}

xrpl:signAndSubmitTransaction

import type { Wallet, WalletAccount }from '@wallet-standard/core';

type XRPLSignAndSubmitTransactionVersion = '1.0.0';

type XRPLSignAndSubmitTransactionFeature = {
  'xrpl:signAndSubmitTransaction': {
    version: XRPLSignAndSubmitTransactionVersion;
    signAndSubmitTransaction: XRPLSignAndSubmitTransactionMethod;
  };
};

type XRPLSignAndSubmitTransactionMethod = (
  input: XRPLSignAndSubmitTransactionInput
) => Promise<SignAndSubmitTransactionOutput>;

interface XRPLSignAndSubmitTransactionInput {
  tx_json: Transaction;
  account: WalletAccount;
  network: XRPLIdentifierString;
  options?: SignAndSubmitTransactionOption;
}

interface SignAndSubmitTransactionOutput {
  tx_hash: string;
  tx_json: TransactionWithMetadata;
}

interface SignAndSubmitTransactionOption {
  autofill?: boolean;
  multisig?: boolean;
}

Example for Wallet

import type { Wallet, WalletAccount }from '@wallet-standard/core';

class MyWallet implements Wallet {

  get features(){
    return {
      'standard:connect': {
        version: '1.0.0',
        connect: this.#connect()
      },
      'xrpl:signTransaction': {
        version: '1.0.0',
        signTransaction: this.#signTransaction
      },
      'xrpl:signAndSubmitTransaction': {
        version: '1.0.0',
        signAndSubmitTransaction: this.#signAndSubmitTransaction
      }
    }
  }
  
  get accounts(){
    // exposing accounts
    // e.g.) Empty if not connected, available accounts if connected
  }
  
  #on(){
    // event implementation
  }
  
  #connect(){
    // connect implementation
  }
  
  #signTransaction(...input) {
    // sign transaction
  }
  
  #signAndSubmitTransaction(...input) {
    // sign and submit transaction
  }
}

import { registerWallet } from '@wallet-standard/core';

registerWallet(new MyWallet());

[tequdev]

Updated xrpl:signTransaction and xrpl:signAndSubmitTransaction arguments to more commonly used types instead of UInt8Array.