README.md

Sovereign SDK MetaMask Snap

The Sovereign SDK MetaMask Snap enables transaction signing for users.

This Snap is configured to use the designated coin type 1551, allocated for the SDK-Sovereign SDK. In accordance with Metamask's Snap permissions design, the coin type is hardcoded. If you require a different coin type, you can fork this repository and modify the authorized path in the Snap manifest.

Methods

getPublicKey

Returns the public key of the wallet as hexadecimal string.

Params

• path: The BIP-32 derivation path of the wallet (string[]).
• curve: The curve of the public key (secp256k1 or ed25519).

Example

const response = await request({
  method: 'getPublicKey',
  params: {
    path: ['m', "44'", "1551'"],
    curve: 'ed25519',
  },
});
if (
  !response ===
  '0x00c9aaf347832dc3b1dbb7aab4f41e5e04c64446b819c0761571c27b9f90eacb27'
) {
  throw new Error('Invalid public key');
}

signTransaction

Returns the signature of the message as hexadecimal string.

Will emit a confirmation dialog for the user.

Params

• path: The BIP-32 derivation path of the wallet (string['m', "44'", "1551'", ...]).
• curve: The curve of the public key (secp256k1 or ed25519).
• schema: A borsh schema for the transaction.
• transaction: A transaction to be serialized using the provided schema. The signature will be performed over the serialized transaction.

Example

import { Schema } from 'borsh';

const callMessageSchema: Schema = {
  enum: [
    {
      struct: {
        Invoke: {
          struct: {
            method: 'string',
            payload: { array: { type: 'u8' } },
          },
        },
      },
    },
    {
      struct: {
        Transfer: {
          struct: {
            from: { array: { type: 'u8', len: 32 } },
            to: { array: { type: 'u8', len: 32 } },
            amount: 'u64',
          },
        },
      },
    },
  ],
};

const response = request({
  method: 'signTransaction',
  params: {
    path: ['m', "44'", "1551'"],
    curve: 'ed25519',
    schema: callMessageSchema,
    transaction: {
      Transfer: {
        from: Array(32).fill(2),
        to: Array(32).fill(3),
        amount: 1582,
      },
    },
  },
});

if (
  !response ===
  '0xfd2e4b23a3e3f498664af355b341e833324276270a13f9647dd1f043248f92fccaa037d4cfc9d23f13a295f7d505ee13afb2b10cea548890678f9002947cbb0a'
) {
  throw new Error('Invalid signature');
}

Testing

To test the snap, run yarn test in this directory. This will use @metamask/snaps-jest to run the tests in src/index.test.ts.

If a change to the snap code was performed, you will need to run yarn build before the tests.