sw-fe-sdk v0.0.6-beta.1714925975

SDK For Smarter Wallet Frond End

MPC key management and build ERC4337 transaction

Features

• Generate MPC keys
• Save MPC keys
• Build ERC4337 native token trascation
• Build ERC4337 ERC20 token trascation
• Build ERC4337 native token trascation with token pay master
• Build ERC4337 ERC20 token trascation with token pay master

Installation

To install the package, run the following command:

For production environment:

# latest
npm install sw-fe-sdk

For test environment:

# beta
npm install sw-fe-sdk@beta

Usage

Before using the package, make sure to import the required modules and configure the necessary variables:

import { MPCManageAccount } from 'sw-fe-sdk';
import { JSONBigInt } from 'sw-fe-sdk';

Configuration

Set up the RPC URL and other constants:

const rpcUrl = "https://mumbai-rpc.web3idea.xyz"; // Replace with your RPC URL
// ... other constants
const mpcAccount = new MPCManageAccount(blockchainRpcUrl, mpcBackendApiUrl, mpcWasmUrl, authorization, createWalletApiUrl);

Create MPC Account

Create MPC keys when register wallet, follow these steps:

await mpcAccount.initAccount("");

// Generate MPC keys
const mpckeys = await mpcAccount.generateKeys()
console.log("mpckeys:", JSONBigInt.stringify(mpckeys));
// Save to local...
// Save to decenterlized server...
// Save to Smarter wallet server...

Initialize MPC Account

To initialize and use an MPC account, follow these steps:

1. Initialize the account with the given key string

// mpcKeyStr is a string, one of mpckeys. e.g.: '{"Id":1,"ShareI":219499044982805701588892377127447501004150432209403709303384334655408914819632,"PublicKey":{"Curve":"secp256k1","X":97292621653416266750380703637875538596866301353776849812982916816163853412988,"Y":32440693875191451391160231867342089322288044048122424317742935922111154446039},"ChainCode":"013d57fb4dea99754bc3773dedf201f9c555684eab127a529d335663c0063425c9","SharePubKeyMap":{"1":{"Curve":"secp256k1","X":29161051009961544429569809800230777877472024870500305033506395207674118416373,"Y":44796153314212729221467409179106608297103339961871905099986927630538307838333},"2":{"Curve":"secp256k1","X":40713022408703343240041761412242766867715143730321538117446016757996923246685,"Y":54311185172390094674585055235636263490742909410647712991051877387418786801570},"3":{"Curve":"secp256k1","X":36535362237429459090412737650018500331292975515911824642793483191706305761009,"Y":97503616435531946333830622361346685900869373933095170990256609518446036018220}}}'
await mpcAccount.initAccount(mpcKeyStr);

2. Calculate owner address

const ownerAddress = await mpcAccount.getOwnerAddress();
console.log("Owner Address:", ownerAddress);

3. Calculate contract wallet address

const walletFactoryAddres = 'walletFactoryAddres';
const walletAddress = await ContractWalletUtils.calcContractWalletAddress(blockchainRpcUrl, await mpcAccount.getOwnerAddress(), walletFactoryAddres, 0);

4. Deploy your wallet

const chainId = 1; // chain config ID, not network id
await mpcAccount.deployContractWalletIfNotExist(chainId, walletAddress);

5. Modify blockchain RPC url

mpcAccount.setBlockchainRpc(newRpcUrl);

Transactions

Transfer Native Token

With token pay master

To build a transaction for transferring native tokens with token pay master:

const op = await mpcAccount.buildTxTransferNativeToken(
  walletAddress,
  entryPointAddress,
  await ethersWallet.getGasPrice(), 
  BigNumber.from(100_0000), 
  "0xRecipientAddress", // Replace with the recipient's address
  ethers.utils.parseEther("Amount"), // Replace with the amount to send
  tokenPaymasterAddress,
  payGasFeeTokenAddress
);
console.log("Transfer native token tx op:", JSONBigInt.stringify(op));

Transfer Native Token

Without token pay master

To build a transaction for transferring native tokens without token pay master:

const op = await mpcAccount.buildTxTransferNativeToken(
  walletAddress,
  entryPointAddress,
  await ethersWallet.getGasPrice(), 
  BigNumber.from(100_0000),
  "0xRecipientAddress", // Replace with the recipient's address
  ethers.utils.parseEther("Amount") // Replace with the amount to send
);
console.log("Transfer native token tx op:", JSONBigInt.stringify(op));

Transfer ERC20 Token

With token pay master

To build a transaction for transferring ERC20 tokens with token pay master:

const op = await mpcAccount.buildTxTransferERC20Token(
  walletAddress,
  entryPointAddress,
  await ethersWallet.getGasPrice(), 
  BigNumber.from(100_0000),
  "0xRecipientAddress", // Replace with the recipient's address
  ethers.utils.parseEther("Amount"), // Replace with the amount to send
  "0xTokenAddress", // Replace with the ERC20 token address
  tokenPaymasterAddress,
  payGasFeeTokenAddress
);
console.log("Transfer ERC20 token tx op:", JSONBigInt.stringify(op));

Transfer ERC20 Token

Without token pay master

To build a transaction for transferring ERC20 tokens without token pay master:

const op = await mpcAccount.buildTxTransferERC20Token(
  walletAddress,
  entryPointAddress,
  await ethersWallet.getGasPrice(),
  BigNumber.from(100_0000),
  "0xRecipientAddress", // Replace with the recipient's address
  ethers.utils.parseEther("Amount"), // Replace with the amount to send
  "0xTokenAddress" // Replace with the ERC20 token address
);
console.log("Transfer ERC20 token tx op:", JSONBigInt.stringify(op));

The full test code is here.

Swap

Uniswap

To build a swap transaction.

Swap SWT to Matic:

// swap token address
const swtTokenAddress = "0x409646509BE42Aea79Eab370eFC2c0eC2E51753B";
// router address
const callContractAddress = "0xf471d32cb40837bf24529fcf17418fc1a4807626";
// swap tx data
const calldataHex = "0x415565b0000000000000000000000000409646509be42aea79eab370efc2c0ec2e51753b000000000000000000000000eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee00000000000000000000000000000000000000000000000000000000000011d6000000000000000000000000000000000000000000000000000000000000271000000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000030000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000042000000000000000000000000000000000000000000000000000000000000004c000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000036000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001000000000000000000000000409646509be42aea79eab370efc2c0ec2e51753b0000000000000000000000009c3c9283d3e44854697cd22d3faa240cfb03288900000000000000000000000000000000000000000000000000000000000001400000000000000000000000000000000000000000000000000000000000000320000000000000000000000000000000000000000000000000000000000000032000000000000000000000000000000000000000000000000000000000000002e00000000000000000000000000000000000000000000000000000000000002710000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003200000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000012556e697377617056330000000000000000000000000000000000000000000000000000000000000000000000000011d60000000000000000000000000000000000000000000000000000000000002710000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000e592427a0aece92de3edee1f18e0157c0586156400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002b409646509be42aea79eab370efc2c0ec2e51753b000bb89c3c9283d3e44854697cd22d3faa240cfb0328890000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000400000000000000000000000009c3c9283d3e44854697cd22d3faa240cfb032889ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff000000000000000000000000000000000000000000000000000000000000000b000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000001000000000000000000000000409646509be42aea79eab370efc2c0ec2e51753b0000000000000000000000000000000000000000000000000000000000000000869584cd00000000000000000000000010000000000000000000000000000000000000110000000000000000000000000000000002fdcc3f678d6242a53ad06d046c6080";
const gasPrice = await ethersWallet.getGasPrice();
let op = await mpcAccount.buildTxCallContract(
    walletAddress,
    entryPointAddress,
    gasPrice,
    BigNumber.from(100_0000),
    [
        // approve sell token(swt)
        {
            ethValue: BigNumber.from(0),
            callContractAbi: erc20Abi,
            callContractAddress: swtTokenAddress,
            callFunc: "approve",
            callParams: [callContractAddress, ethers.constants.MaxUint256],
        },
        // swap
        {
            ethValue: BigNumber.from(0),
            callContractAddress,
            calldataHex,
        }
    ],
    tokenPaymasterAddress,
    payGasFeeTokenAddress
);
console.log("build swap SWT->Matic tx on mumbai with token pay master. op:", JSONBigInt.stringify(op));

Cross chain

CCIP

To build a creoss chain transaction by CCIP.

Cross USDC from mumbai to fuji:

// wallet address
const sourceChainSenderAddress = "0x24FE506212F21B989886B06EF8166Ba5EDaB233e";
// fuji selelctor
const destChainSelector = BigNumber.from("14767482510784806043");
const destChainReceiverAddress = "0x895adF48D0F6A57d14C35AcE2Dd75E4FAC09471F";
// USDC address
const erc20ContractAddress = "0x9999f7Fea5938fD3b1E26A12c3f2fb024e194f97";
// fuji receiver address
const receiverAddress = walletAddress;
// cross chain amount
const amount = BigNumber.from(2);

const gasPrice = await ethersWallet.getGasPrice();
let op = await mpcAccount.buildTxCallContract(
    walletAddress,
    entryPointAddress,
    gasPrice,
    BigNumber.from(100_0000),
    [
        // reset allowance
        {
            ethValue: BigNumber.from(0),
            callContractAbi: erc20Abi,
            callContractAddress: erc20ContractAddress,
            callFunc: "approve",
            callParams: [sourceChainSenderAddress, BigNumber.from(0)],
        },
        // approve
        {
            ethValue: BigNumber.from(0),
            callContractAbi: erc20Abi,
            callContractAddress: erc20ContractAddress,
            callFunc: "approve",
            callParams: [sourceChainSenderAddress, amount],
        },
        // function sendMessage(uint64 destinationChainSelector,address receiver,payFeesIn feeToken,address to,uint256 amount) external returns (bytes32 messageId)
        {
            ethValue: BigNumber.from(0),
            callContractAbi: sourceChainSenderAbi,
            callContractAddress: sourceChainSenderAddress,
            callFunc: "sendMessage",
            // feeToken: 1-Link
            callParams: [destChainSelector, destChainReceiverAddress, 1, receiverAddress, amount],
        },
    ],
    tokenPaymasterAddress,
    payGasFeeTokenAddress
);
console.log("build cross SWT tx from mumbai to fuji with token pay master. op:", JSONBigInt.stringify(op));

CCTP

TODO

Unit Test

npm test -- ./test/build-ts.test.ts
npm test -- ./test/mpc-ts.test.ts