WalletSolanaProviderScript.js

// Copyright 2022 The Brave Authors. All rights reserved.
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

window.__firefox__.execute(function($, $Object, $Function, $Array) {
  if (window.isSecureContext) {
    // Failed to Inject SolanaWeb3
    if (typeof $<walletSolanaNameSpace> === 'undefined') {
      return;
    }
    
    // Access solanaWeb3 from the hidden namespace
    let solanaWeb3 = $($($<walletSolanaNameSpace>).solanaWeb3);
    if (!solanaWeb3) {
      return;
    }
    
    // From this point on, do not access the namespace!
    // If the code throws an exception, the namespace will not be in the stacktrace.
    // SolanaWeb3 is the only variable declared above that should be accessed from this point forward.
    
    // ---- Wallet Code ---- //
    
    // List of classes that should not be Frozen completely.
    const freezeExceptions = $Array.of("BN");
    
    let post = $(function(method, payload, completion) {
      let postMessage = $(function(message) {
        return $.postNativeMessage('$<message_handler>', message);
      });

      return new Promise($((resolve, reject) => {
        postMessage({
          "securityToken": SECURITY_TOKEN,
          "method": method,
          "args": JSON.stringify(payload, (key, value) => {
            /* JSON.stringify will convert Uint8Array to a dictionary, if we convert to an array we get a list. */
            return value instanceof Uint8Array ? Array.from(value) : value;
          })
        })
        .then(
            (result) => {
              if (completion == undefined) {
                resolve($.extensiveFreeze(result, freezeExceptions));
              } else {
                completion($.extensiveFreeze(result, freezeExceptions), resolve);
              }
            },
            (errorJSON) => {
              /* remove `Error: ` prefix. errorJSON=`Error: {code: 1, errorMessage: "Internal error"}` */
              const errorJSONString = new String(errorJSON);
              const errorJSONStringSliced = errorJSONString.slice(errorJSONString.indexOf('{'));
              try {
                reject(JSON.parse(errorJSONStringSliced))
              } catch(e) {
                reject(errorJSON)
              }
            }
          )
      }))
    })
    /*
     solanaWeb3.Transaction | solanaWeb3.VersionedTransaction
     ->
     [UInt8]
     */
    let serializedMessageFromTx = $(function(transaction) {
      // VersionedTransaction (v0) : Transaction (legacy)
      let serializeMessageBuffer = transaction.message ? transaction.message.serialize() : transaction.serializeMessage();
      return [...serializeMessageBuffer]; // Buffer to Array
    })
    /*
     solanaWeb3.Transaction | solanaWeb3.VersionedTransaction
     ->
     [{publicKey: <base58 encoded string>, signature: [UInt8]}]
     */
    let signaturesPubKeyPairsFromTx = $(function(transaction) {
      if (transaction.message) { // VersionedTransaction (v0)
        const signatures = transaction.signatures;
        const versionedMessage = transaction.message;
        const staticAccountKeys = versionedMessage.staticAccountKeys;

        const signaturePubkeyObjects = [];
        for (let i = 0; i < signatures.length; i++) {
          const signature = signatures[i];
          const publicKey = staticAccountKeys[i];

          const obj = $Object.create(null, undefined);
          obj.publicKey = publicKey.toBase58();
          obj.signature = signature;
          signaturePubkeyObjects[i] = $.extensiveFreeze(obj, freezeExceptions);
        }

        return signaturePubkeyObjects;
      } else { // Transaction (legacy)
        let convertSignaturePubkeyTuple = $(function(signaturePubkeyTuple) {
          const obj = $Object.create(null, undefined);
          obj.publicKey = signaturePubkeyTuple.publicKey.toBase58();
          const signatureBuffer = signaturePubkeyTuple.signature
          if (signatureBuffer) {
            obj.signature = [...signatureBuffer]; // Buffer to Array
          } else {
            obj.signature = [];
          }
          return $.extensiveFreeze(obj, freezeExceptions);
        })
        const txSignatures = $Array.of(...transaction.signatures);
        return txSignatures.map(convertSignaturePubkeyTuple);
      }
    })
    /*
     solanaWeb3.Transaction | solanaWeb3.VersionedTransaction
     ->
     {
      serializedMessage: [UInt8],
      signatures: [{publicKey: <base58 encoded string>, signature: [UInt8]}]
     }
    */
    let convertTransaction = $(function(transaction) {
      const serializedMessage = serializedMessageFromTx(transaction);
      const signatures = signaturesPubKeyPairsFromTx(transaction);
      const object = $Object.create(null, undefined);
      object.serializedMessage = serializedMessage;
      object.signatures = signatures;
      return object;
    })
    let createTransaction = $(function(serializedTxDict) {
      const version = serializedTxDict["version"];
      const serializedTx = serializedTxDict["serializedTx"];
      
      if (version == 0) { // Transaction (legacy)
        return $.extensiveFreeze(solanaWeb3.Transaction.from(new Uint8Array(serializedTx)), freezeExceptions)
      } else if (version == 1) { // VersionedTransaction (v0)
        return $.extensiveFreeze(solanaWeb3.VersionedTransaction.deserialize(new Uint8Array(serializedTx)), freezeExceptions)
      }
    })
    const provider = {
      value: {
        /* Properties */
        isPhantom: true,
        isBraveWallet: true,
        isConnected: false,
        publicKey: null,
        /* Methods */
        connect: $(function(payload) { /* -> {publicKey: solanaWeb3.PublicKey} */
          function completion(publicKey, resolve) {
            /* convert `<base58 encoded string>` -> `{publicKey: solanaWeb3.PublicKey}` */
            const result = $Object.create(null, undefined);
            result.publicKey = new solanaWeb3.PublicKey(publicKey);
            resolve($.extensiveFreeze(result, freezeExceptions));
          }
          return post('connect', payload, completion)
        }),
        disconnect: $(function(payload) { /* -> Promise<{}> */
          return post('disconnect', payload)
        }),
        signAndSendTransaction: $(function(...payload) { /* -> Promise<{publicKey: <base58 encoded string>, signature: <base58 encoded string>}> */
          const object = convertTransaction(payload[0]);
          object.sendOptions = payload[1];
          $.extensiveFreeze(object, freezeExceptions);
          return post('signAndSendTransaction', object)
        }),
        signMessage: $(function(...payload) { /* -> Promise<{publicKey: solanaWeb3.PublicKey, signature: [UInt8]}> */
          function completion(result, resolve) {
            /* convert `{publicKey: <base58 encoded string>, signature: [UInt8]}}` ->
             `{publicKey: solanaWeb3.PublicKey, signature: [UInt8]}` */
            const parsed = JSON.parse(result);
            const publicKey = parsed["publicKey"]; /* base58 encoded pubkey */
            const signature = parsed["signature"]; /* array of uint8 */
            const obj = $Object.create(null, undefined);
            obj.publicKey = new solanaWeb3.PublicKey(publicKey);
            obj.signature = new Uint8Array(signature);
            resolve($.extensiveFreeze(obj, freezeExceptions));
          }
          return post('signMessage', payload, completion)
        }),
        request: $(function(args) /* -> Promise<unknown> */  {
          if (args["method"] == 'connect') {
            function completion(publicKey, resolve) {
              /* convert `<base58 encoded string>` -> `{publicKey: solanaWeb3.PublicKey}` */
              const result = $Object.create(null, undefined);
              result.publicKey = $(new solanaWeb3.PublicKey(publicKey));
              resolve($.extensiveFreeze(result, freezeExceptions));
            }
            return post('request', args, completion)
          }
          return post('request', args)
        }),
        /* Deprecated */
        signTransaction: $(function(transaction) { /* -> Promise<solanaWeb3.Transaction> */
          const object = convertTransaction(transaction);
          $.extensiveFreeze(object, freezeExceptions);
          
          function completion(serializedTx, resolve) {
            /* Convert `[UInt8]` -> `solanaWeb3.Transaction` */
            const result = createTransaction(serializedTx);
            resolve($.extensiveFreeze(result, freezeExceptions));
          }
          return post('signTransaction', object, completion)
        }),
        /* Deprecated */
        signAllTransactions: $(function(transactions) { /* -> Promise<[solanaWeb3.Transaction]> */
          const objects = $Array.of(...transactions).map(convertTransaction);
          $.extensiveFreeze(objects, freezeExceptions);
          
          function completion(serializedTxs, resolve) {
            /* Convert `[[UInt8]]` -> `[solanaWeb3.Transaction]` */
            const result = $Array.of(...serializedTxs).map(createTransaction);
            resolve($.extensiveFreeze(result, freezeExceptions));
          }
          return post('signAllTransactions', objects, completion)
        }),
      }
    }
    $Object.defineProperty(window, 'solana', provider);
    $Object.defineProperty(window, 'braveSolana', provider);
  }
});