A package for crafting multi-send transaction from a Zodiac Avatar, such as a Safe, based on ethers.js
npm install ethers-multisend
An npm package for crafting multi-send transaction from a Safe, based on ethers.js v5.
- Easily encode the most common types of transactions from JSON inputs:
- ETH & ERC20 token transfers
- NFT transfers
- Contract function calls
- Raw transactions
- Encode a batch of transactions into a single multi-send call.
The encode functions produce JavaScript objects that can be used to actually execute the described transactions.
There are various ways to do that, using direct calls to your Safe contract, or by relaying it using the infrastructure provided by Safe.
Check out the Safe{Core} SDK to learn more: https://github.com/safe-global/safe-core-sdk
This module is distributed via npm. For adding it to your project, run:
``
npm install --save ethers-multisend
To install it using yarn, run:
`
yarn add ethers-multisend
`ts`
encodeSingle(transactionInput: TransactionInput): MetaTransaction
Encodes a single transaction input and turns into an format that is ready for execution.
`ts`
encodeMulti(
metaTransaction: MetaTransaction[],
multiSendContractAddress?: string
): MetaTransaction
Batches a set of meta transactions into a single multi-send contract call.
You can optionally provide the multiSendContractAddress to use. By default, it will use MultiSendCallOnly v1.4.1 or MultiSend v1.4.1 if the batch includes any delegate calls.
`ts`
decodeSingle(
metaTransaction: MetaTransaction,
provider: Provider,
fetchAbi?: (address: string) => Promise
id?: string
): Promise
Decodes a meta transaction and returns a transaction input object of one of the four supported types.
It needs an ethers provider instance to fetch decimals for ERC20 token transfers, and a function for fetching the ABI for a contract address.
`ts`
decodeMulti(data: string): MetaTransaction[]
Given the data string of a multi-send transaction, returns an array of the included meta transactions.
`ts`
createTransaction(type: TransactionType, id?: string): TransactionInput
Creates an empty transaction input of the specified type.
`ts`
isValid(transactionInput: TransactionInput): boolean
Returns whether the provided transaction input can be encoded into a meta transaction without errors and has a valid to address.
The TransactionInput type captures the information for any of the four supported transaction types.
`ts`
type TransactionInput =
| CallContractTransactionInput
| TransferFundsTransactionInput
| TransferCollectibleTransactionInput
| RawTransactionInput
The library's encoding functions return objects of the MetaTransaction type, which is a format with an ABI encoded data field so it is ready for execution.
`ts``
interface MetaTransaction {
readonly to: string
readonly value: string
readonly data: string
readonly operation?: OperationType
}
Find the full information about all TypeScript types here: src/types.ts