MultiSend

README.md

@@ -1,5 +1,8 @@
 # Safe Core SDK
 
+[![NPM Version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-core-sdk.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-core-sdk)
+[![GitHub Release](https://img.shields.io/github/release/gnosis/safe-core-sdk.svg?style=flat)](https://github.com/gnosis/safe-core-sdk/releases)
+[![GitHub](https://img.shields.io/github/license/gnosis/safe-core-sdk)](https://github.com/gnosis/safe-core-sdk/blob/main/LICENSE.md)
 [![Coverage Status](https://coveralls.io/repos/github/gnosis/safe-core-sdk/badge.svg?branch=main)](https://coveralls.io/github/gnosis/safe-core-sdk?branch=main)
 
 Software development kit that facilitates the interaction with the [Gnosis Safe contracts](https://github.com/gnosis/safe-contracts).
@@ -28,7 +31,7 @@ A Safe account with three owners and threshold equal three will be used as the s
 
 ```js
 import { ethers } from 'ethers'
-import EthersSafe, { SafeTransaction } from '@gnosis.pm/safe-core-sdk'
+import EthersSafe from '@gnosis.pm/safe-core-sdk'
 
 const web3Provider = // ...
 const provider = new ethers.providers.Web3Provider(web3Provider)
@@ -38,23 +41,23 @@ const signer3 = provider.getSigner(2)
 
 // Existing Safe address (e.g. Safe created via https://app.gnosis-safe.io)
 // Where signer1, signer2 and signer3 are the Safe owners
-const safeAddress = "0x<safe_address>"
+const safeAddress = '0x<safe_address>'
 ```
 
 Create an instance of the Safe Core SDK with `signer1` connected as the signer.
 
 ```js
-const safeSdk = await EthersSafe.create(ethers, safeAddress, signer1)
+const safeSdk = await EthersSafe.create({ ethers, safeAddress, providerOrSigner: signer1 })
 ```
 
 ### 1. Create a Safe transaction
 
 ```js
-const tx = await safeSdk.createTransaction({
+const tx = await safeSdk.createTransaction([{
   to: safeAddress,
-  value: '0',
-  data: '0x',
-})
+  value: '<eth_value_in_wei>',
+  data: '0x<data>'
+}])
 ```
 
 Before executing this transaction, it must be signed by the owners and this can be done off-chain or on-chain. In this example the owner `signer1` will sign it off-chain and the owner `signer3` would have to explicitly sign it too.
@@ -74,7 +77,7 @@ Because the signature is off-chain, there is no interaction with the contract an
 After `signer2` account is connected to the SDK as the signer the transaction hash is approved on-chain.
 
 ```js
-const safeSdk2 = await safeSdk.connect(signer2)
+const safeSdk2 = await safeSdk.connect({ providerOrSigner: signer2 })
 const txHash = await safeSdk2.getTransactionHash(tx)
 const signer2Signature = await safeSdk2.approveTransactionHash(txHash)
 ```
@@ -84,7 +87,7 @@ const signer2Signature = await safeSdk2.approveTransactionHash(txHash)
 Lastly, `signer3` account is connected to the SDK as the signer and executor of the Safe transaction to execute it.
 
 ```js
-const safeSdk3 = await safeSdk2.connect(signer3)
+const safeSdk3 = await safeSdk2.connect({ providerOrSigner: signer3 })
 const txResponse = await safeSdk3.executeTransaction(tx)
 await txResponse.wait()
 ```
@@ -97,27 +100,49 @@ All the signatures used to execute the transaction are available at `tx.signatur
 Returns an instance of the Safe Core SDK with the `providerOrSigner` connected to the `safeAddress`.
 
 ```js
-const safeSdk = await EthersSafe.create(ethers, safeAddress, providerOrSigner)
+const safeSdk = await EthersSafe.create({ ethers, safeAddress, providerOrSigner })
 ```
 
 If `providerOrSigner` is not provided, `ethers` default provider will be used.
 
 ```js
-const safeSdk = await EthersSafe.create(ethers, safeAddress)
+const safeSdk = await EthersSafe.create({ ethers, safeAddress })
+```
+
+The property `contractNetworks` can be added to provide the Safe contract addresses in case the SDK is used in a network where the Safe contracts are not deployed.
+
+```js
+const contractNetworks: ContractNetworksConfig = {
+  [chainId]: {
+    multiSendAddress: '0x<multisend_address>'
+  }
+}
+const safeSdk = await EthersSafe.create({ ethers, safeAddress, providerOrSigner, contractNetworks })
 ```
 
 ### connect
 
 Returns a new instance of the Safe Core SDK with the `providerOrSigner` connected to the `safeAddress`.
 
 ```js
-const safeSdk2 = await safeSdk.connect(providerOrSigner, safeAddress)
+const safeSdk2 = await safeSdk.connect({ providerOrSigner, safeAddress })
 ```
 
 If `safeAddress` is not provided, the `providerOrSigner` will be connected to the previous Safe.
 
 ```js
-const safeSdk2 = await safeSdk.connect(providerOrSigner)
+const safeSdk2 = await safeSdk.connect({ providerOrSigner })
+```
+
+The property `contractNetworks` can be added to provide the Safe contract addresses in case the SDK is used in a network where the Safe contracts are not deployed.
+
+```js
+const contractNetworks: ContractNetworksConfig = {
+  [chainId]: {
+    multiSendAddress: '0x<multisend_address>'
+  }
+}
+const safeSdk = await EthersSafe.create({ ethers, safeAddress, providerOrSigner, contractNetworks })
 ```
 
 ### getProvider
@@ -136,12 +161,12 @@ Returns the connected signer.
 const signer = safeSdk.getSigner()
 ```
 
-### getAddress
+### getSafeAddress
 
 Returns the address of the current Safe Proxy contract.
 
 ```js
-const address = safeSdk.getAddress()
+const address = safeSdk.getSafeAddress()
 ```
 
 ### getContractVersion
@@ -218,7 +243,7 @@ const isOwner = await safeSdk.isOwner(address)
 
 ### createTransaction
 
-Returns a Safe transaction ready to be signed by the owners and executed.
+Returns a Safe transaction ready to be signed by the owners and executed. Batched transactions are allowed if more than one transaction is added to the array of transactions.
 
 Each of the transactions provided as input to this function must be an object with the following properties:
 
@@ -236,22 +261,27 @@ Each of the transactions provided as input to this function must be an object wi
 Read more about the [Safe transaction properties](https://docs.gnosis.io/safe/docs/contracts_tx_execution/).
 
 ```js
-const partialTx: SafeTransactionDataPartial = {
+const partialTx1: SafeTransactionDataPartial = {
+  to: '0x<address>',
+  data: '0x<data>',
+  value: '<eth_value_in_wei>'
+}
+const partialTx2: SafeTransactionDataPartial = {
   to: '0x<address>',
   data: '0x<data>',
   value: '<eth_value_in_wei>'
 }
-const safeTransaction = await safeSdk.createTransaction(partialTx)
+const safeTransaction = await safeSdk.createTransaction([partialTx1, partialTx2])
 ```
 
 ### getTransactionHash
 
 Returns the transaction hash of a Safe transaction.
 
 ```js
-const tx = await safeSdk.createTransaction({
+const tx = await safeSdk.createTransaction([{
   // ...
-})
+}])
 const txHash = await safeSdk.getTransactionHash(tx)
 ```
 
@@ -260,9 +290,9 @@ const txHash = await safeSdk.getTransactionHash(tx)
 Signs a hash using the current signer account.
 
 ```js
-const tx = await safeSdk.createTransaction({
+const tx = await safeSdk.createTransaction([{
   // ...
-})
+}])
 const txHash = await safeSdk.getTransactionHash(tx)
 const signature = await safeSdk.signTransactionHash(txHash)
 ```
@@ -272,9 +302,9 @@ const signature = await safeSdk.signTransactionHash(txHash)
 Adds the signature of the current signer to the Safe transaction object.
 
 ```js
-const tx = await safeSdk.createTransaction({
+const tx = await safeSdk.createTransaction([{
   // ...
-})
+}])
 await safeSdk.signTransaction(tx)
 ```
 
@@ -283,9 +313,9 @@ await safeSdk.signTransaction(tx)
 Approves on-chain a hash using the current signer account.
 
 ```js
-const tx = await safeSdk.createTransaction({
+const tx = await safeSdk.createTransaction([{
   // ...
-})
+}])
 const txHash = await safeSdk.getTransactionHash(tx)
 const txResponse = await safeSdk.approveTransactionHash(txHash)
 await txResponse.wait()
@@ -296,9 +326,9 @@ await txResponse.wait()
 Returns a list of owners who have approved a specific Safe transaction.
 
 ```js
-const tx = await safeSdk.createTransaction({
+const tx = await safeSdk.createTransaction([{
   // ...
-})
+}])
 const txHash = await safeSdk.getTransactionHash(tx)
 const owners = await safeSdk.getOwnersWhoApprovedTx(txHash)
 ```

contracts/Deps.sol

@@ -2,5 +2,6 @@ pragma solidity >=0.5.0 <0.7.0;
 
 import { GnosisSafeProxyFactory } from "@gnosis.pm/safe-contracts/contracts/proxies/GnosisSafeProxyFactory.sol";
 import { GnosisSafe } from "@gnosis.pm/safe-contracts/contracts/GnosisSafe.sol";
+import { MultiSend } from "@gnosis.pm/safe-contracts/contracts/libraries/MultiSend.sol";
 import { DailyLimitModule } from "@gnosis.pm/safe-contracts/contracts/modules/DailyLimitModule.sol";
 import { SocialRecoveryModule } from "@gnosis.pm/safe-contracts/contracts/modules/SocialRecoveryModule.sol";

hardhat/deploy/deploy-contracts.ts

@@ -20,6 +20,13 @@ const deploy: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
     deterministicDeployment: true
   })
 
+  await deploy('MultiSend', {
+    from: deployer,
+    args: [],
+    log: true,
+    deterministicDeployment: true
+  })
+
   await deploy('DailyLimitModule', {
     from: deployer,
     args: [],

package.json

@@ -39,14 +39,14 @@
     "@types/chai": "^4.2.17",
     "@types/chai-as-promised": "^7.1.3",
     "@types/mocha": "^8.2.2",
-    "@types/node": "^15.0.1",
+    "@types/node": "^15.0.2",
     "@types/yargs": "^16.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.22.0",
-    "@typescript-eslint/parser": "^4.22.0",
+    "@typescript-eslint/eslint-plugin": "^4.22.1",
+    "@typescript-eslint/parser": "^4.22.1",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "coveralls": "^3.1.0",
-    "dotenv": "^8.2.0",
+    "dotenv": "^9.0.0",
     "eslint": "^7.25.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^3.4.0",
@@ -65,7 +65,7 @@
     "ts-node": "^9.1.1",
     "typechain": "^4.0.3",
     "typescript": "^4.2.4",
-    "yargs": "^16.2.0"
+    "yargs": "^17.0.1"
   },
   "lint-staged": {
     "src/**/!(*test).ts": [