MoonSigner

Summary

The @moonup/ethers package is a utility package that provides a MoonSigner class for signing messages, transactions, and typed data using the MoonSDK from the @moonup/moon-sdk package. This signer implements the Signer and TypedDataSigner interfaces from the ethers library.

Usage Examples

Here's a basic example of how to use the MoonSigner class:

import { MoonSDK } from '@moonup/moon-sdk';
import { MoonSigner } from '@moonup/ethers';
import { ethers } from 'ethers';

const SDK = new MoonSDK({ /* your configuration */ });
const address = '0xYourEthereumAddress';
const chainId = 1; // mainnet

const signer = new MoonSigner({ SDK, address, chainId });

// Now you can use the signer with ethers
const message = 'Hello, world!';
const signature = await signer.signMessage(message);
console.log(`Signature: ${signature}`);

API Reference

MoonSigner

A signer for signing messages, transactions, and typed data using the MoonSDK.

Constructor

• config (Object)

  • SDK (MoonSDK): An instance of the MoonSDK.

  • address (string): The Ethereum address of the account.

  • chainId (number): The ID of the Ethereum chain.

• provider (Provider): An optional provider.

Methods

• _signTypedData(domain: TypedDataDomain, types: Record<string, TypedDataField[]>, value: Record<string, any>): Signs a typed data object. This method is not implemented and throws an error.

  // This method is not implemented and throws an error

• updateConfig(config: MoonSignerConfig): Updates the configuration options.

  signer.updateConfig({ chainId: 4, address: '0xNewEthereumAddress' });

• connect(provider: Provider): Connects the signer to a provider.

  const provider = new ethers.providers.JsonRpcProvider('https://rpc.example.com');
  const connectedSigner = signer.connect(provider);

• signTypedData(domain: TypedDataDomain, types: Record<string, TypedDataField[]>, value: Record<string, string>): Signs a typed data object.

  const domain = {
    name: 'MyDApp',
    version: '1',
    chainId: 1,
    verifyingContract: '0xYourContractAddress',
  };
  const types = {
    Person: [
      { name: 'name', type: 'string' },
      { name: 'age', type: 'uint256' },
    ],
  };
  const value = {
    name: 'John Doe',
    age: 30,
  };
  const signature = await signer.signTypedData(domain, types, value);
  console.log(`Signature: ${signature}`);

• getAddress(): Returns the Ethereum address of the account.

  const address = await signer.getAddress();
  console.log(`Address: ${address}`);

• signMessage(message: BytesLike): Signs a message.

  const message = 'Hello, world!';
  const signature = await signer.signMessage(message);
  console.log(`Signature: ${signature}`);

• broadcastTransaction(signedTransaction: string): Broadcasts a signed transaction.

  const signedTransaction = '0xYourSignedTransaction';
  const transactionHash = await signer.broadcastTransaction(signedTransaction);
  console.log(`Transaction hash: ${transactionHash}`);

• sendTransaction(transaction: TransactionRequest): Signs and broadcasts a transaction.

  const transaction = {
    to: '0xRecipientAddress',
    value: ethers.utils.parseEther('1.0'),
  };
  const txResponse = await signer.sendTransaction(transaction);
  console.log(`Transaction hash: ${txResponse.hash}`);

• transactionRequestToInputBody(tx: TransactionRequest): Converts a TransactionRequest object to an InputBody object.

  const transaction = {
    to: '0xRecipientAddress',
    value: ethers.utils.parseEther('1.0'),
  };
  const inputBody = signer.transactionRequestToInputBody(transaction);
  console.log(`Input body: ${JSON.stringify(inputBody)}`);

• moonTransactionResponseToTransactions(tx: MoonTransaction): Converts a MoonTransaction object to an array of TransactionData objects.

  const moonTransaction = {
    transactions: [
      {
        hash: '0xYourTransactionHash',
        // ...
      },
    ],
  };
  const transactions = signer.moonTransactionResponseToTransactions(moonTransaction);
  console.log(`Transactions: ${JSON.stringify(transactions)}`);

• signTransaction(transaction: TransactionRequest): Signs a transaction.

  const transaction = {
    to: '0xRecipientAddress',
    value: ethers.utils.parseEther('1.0'),
  };
  const signedTransaction = await signer.signTransaction(transaction);
  console.log(`Signed transaction: ${signedTransaction}`);

• getTypedDataDomain(name: string, version: string, chainId: number, verifyingContract: string): Returns a TypedDataDomain object.

  const domain = await signer.getTypedDataDomain('MyDApp', '1', 1, '0xYourContractAddress');
  console.log(`Typed data domain: ${JSON.stringify(domain)}`);

• getTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, message: Record<string, string>): Returns a Typed object.

  const domain = {
    name: 'MyDApp',
    version: '1',
    chainId: 1,
    verifyingContract: '0xYourContractAddress',
  };
  const types = {
    Person: [
      { name: 'name', type: 'string' },
      { name: 'age', type: 'uint256' },
    ],
  };
  const value = {
    name: 'John Doe',
    age: 30,
  };
  const typedData = await signer.getTypedData(domain, types, value);
  console.log(`Typed data: ${JSON.stringify(typedData)}`);

Example

const signer = new MoonSigner({ SDK, address, chainId });