Merge pull request #154 from gnosis/development

Development

Author: germartinez

.github/workflows/e2e-test.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [16.x]
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}

.github/workflows/test.yml

@@ -7,14 +7,29 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [16.x]
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-      - run: |
-          yarn install
-          yarn build
-          yarn test
+
+      - name: Yarn cache
+        uses: actions/cache@v2
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+
+      - name: Yarn install
+        run: |
+          mkdir .yarncache
+          yarn install --cache-folder ./.yarncache --frozen-lockfile
+          rm -rf .yarncache
+          yarn cache clean
+
+      - name: Build
+        run: yarn build
+
+      - name: Test
+        run: yarn test

.github/workflows/test_V1_2_0.yml renamed to .github/workflows/test_ethers_V1_2_0.yml

@@ -1,4 +1,4 @@
-name: Safe Core SDK Test (Safe v1.2.0)
+name: Safe Core SDK Test - Ethers - Safe v1.2.0
 on: [push, pull_request]
 env:
   INFURA_KEY: ${{ secrets.INFURA_KEY }}
@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [16.x]
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}

.github/workflows/test_V1_3_0.yml renamed to .github/workflows/test_ethers_V1_3_0.yml

@@ -1,4 +1,4 @@
-name: Safe Core SDK Test (Safe v1.3.0)
+name: Safe Core SDK Test - Ethers - Safe v1.3.0
 on: [push, pull_request]
 env:
   INFURA_KEY: ${{ secrets.INFURA_KEY }}
@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [16.x]
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}

.github/workflows/test_web3_V1_2_0.yml

@@ -0,0 +1,21 @@
+name: Safe Core SDK Test - Web3 - Safe v1.2.0
+on: [push, pull_request]
+env:
+  INFURA_KEY: ${{ secrets.INFURA_KEY }}
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: |
+          yarn install
+          yarn build
+          cd packages/safe-core-sdk
+          yarn test:hardhat:web3:v1.2.0

.github/workflows/test_web3_V1_3_0.yml

@@ -0,0 +1,21 @@
+name: Safe Core SDK Test - Web3 - Safe v1.3.0
+on: [push, pull_request]
+env:
+  INFURA_KEY: ${{ secrets.INFURA_KEY }}
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: |
+          yarn install
+          yarn build
+          cd packages/safe-core-sdk
+          yarn test:hardhat:web3:v1.3.0

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Gnosis Ltd
+Copyright (c) 2021-2022 Gnosis Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -6,11 +6,9 @@ Software developer tools that facilitate the interaction with the Gnosis Safe [c
 
 | Package | Release | Description |
 | ------- | :-----: | ----------- |
-| [safe-core-sdk](https://github.com/gnosis/safe-core-sdk/tree/master/packages/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) | TypeScript library that facilitates the interaction with the [Gnosis Safe contracts](https://github.com/gnosis/safe-contracts) |
-[safe-core-sdk-types](https://github.com/gnosis/safe-core-sdk/tree/master/packages/safe-core-sdk-types) | [![NPM Version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-core-sdk-types.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-core-sdk-types) | Common types extracted from the [Safe Core SDK](https://github.com/gnosis/safe-core-sdk/tree/master/packages/safe-core-sdk) |
-[safe-service-client](https://github.com/gnosis/safe-core-sdk/tree/master/packages/safe-service-client) | [![NPM Version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-service-client.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-service-client) | [Safe Transaction Service API](https://github.com/gnosis/safe-transaction-service) client library |
-[safe-ethers-adapters](https://github.com/gnosis/safe-core-sdk/tree/master/packages/safe-ethers-adapters) | [![NPM Version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-ethers-adapters.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-ethers-adapters) | [Ethers](https://docs.ethers.io/v5/single-page/) adapter that facilitates the interaction with the [Gnosis Safe Services](https://github.com/gnosis/safe-transaction-service) |
-<!--
-| [safe-core-sdk-app](https://github.com/gnosis/safe-core-sdk/tree/master/packages/safe-core-sdk-app) | - | Example Dapp that uses the [Safe Core SDK](https://github.com/gnosis/safe-core-sdk/tree/master/packages/safe-core-sdk) |
-| 
--->
+| [safe-core-sdk](https://github.com/gnosis/safe-core-sdk/tree/main/packages/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) | TypeScript library that facilitates the interaction with the [Gnosis Safe contracts](https://github.com/gnosis/safe-contracts) |
+[safe-core-sdk-types](https://github.com/gnosis/safe-core-sdk/tree/main/packages/safe-core-sdk-types) | [![NPM Version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-core-sdk-types.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-core-sdk-types) | Common types extracted from the [Safe Core SDK](https://github.com/gnosis/safe-core-sdk/tree/main/packages) packages |
+[safe-ethers-lib](https://github.com/gnosis/safe-core-sdk/tree/main/packages/safe-ethers-lib) | [![NPM Version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-ethers-lib.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-ethers-lib) | Ethers.js utilities and Safe contracts types (typechain ethers-v5) used to initialize the [Safe Core SDK](https://github.com/gnosis/safe-core-sdk/tree/main/packages/safe-core-sdk) |
+[safe-web3-lib](https://github.com/gnosis/safe-core-sdk/tree/main/packages/safe-web3-lib) | [![NPM Version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-web3-lib.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-web3-lib) | Web3.js utilities and Safe contracts types (typechain web3-v1) used to initialize the [Safe Core SDK](https://github.com/gnosis/safe-core-sdk/tree/main/packages/safe-core-sdk) |
+[safe-service-client](https://github.com/gnosis/safe-core-sdk/tree/main/packages/safe-service-client) | [![NPM Version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-service-client.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-service-client) | [Safe Transaction Service API](https://github.com/gnosis/safe-transaction-service) client library |
+[safe-ethers-adapters](https://github.com/gnosis/safe-core-sdk/tree/main/packages/safe-ethers-adapters) | [![NPM Version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-ethers-adapters.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-ethers-adapters) | [Ethers](https://docs.ethers.io/v5/single-page/) adapter that facilitates the interaction with the [Gnosis Safe Services](https://github.com/gnosis/safe-transaction-service) |

package.json

@@ -4,9 +4,11 @@
   "scripts": {
     "clean": "lerna clean",
     "unbuild": "lerna run unbuild",
-    "build": "lerna run build --stream",
-    "test": "FORCE_COLOR=1 lerna run test --stream",
-    "test:ci": "FORCE_COLOR=1 lerna run test:ci --stream"
+    "build": "lerna run build --stream --npm-client=yarn",
+    "test": "FORCE_COLOR=1 lerna run test --stream --npm-client=yarn",
+    "test:ci": "FORCE_COLOR=1 lerna run test:ci --stream --npm-client=yarn",
+    "format": "lerna run format --npm-client=yarn",
+    "postinstall": "cd packages/safe-ethers-lib; hardhat compile"
   },
   "workspaces": {
     "packages": [

packages/guides/integrating-the-safe-core-sdk.md

@@ -41,10 +41,10 @@ The [Safe Core SDK](https://github.com/gnosis/safe-core-sdk/tree/main/packages/s
 
 * **Using ethers.js**
 
-  We can use the class `EthersAdapter` from `@gnosis.pm/safe-core-sdk` as the wrapper for `ethers.js`.
+  We can use the class `EthersAdapter` from `@gnosis.pm/safe-ethers-lib` as the wrapper for `ethers.js`.
 
   ```js
-  import { EthersAdapter } from '@gnosis.pm/safe-core-sdk'
+  import EthersAdapter from '@gnosis.pm/safe-ethers-lib'
   import { ethers } from 'ethers'
 
   const web3Provider = // ...
@@ -59,10 +59,10 @@ The [Safe Core SDK](https://github.com/gnosis/safe-core-sdk/tree/main/packages/s
 
 * **Using web3.js**
 
-  We can use the class `Web3Adapter` from `@gnosis.pm/safe-core-sdk` as the wrapper for `web3.js`.
+  We can use the class `Web3Adapter` from `@gnosis.pm/safe-web3-lib` as the wrapper for `web3.js`.
 
   ```js
-  import { Web3Adapter } from '@gnosis.pm/safe-core-sdk'
+  import Web3Adapter from '@gnosis.pm/safe-web3-lib'
   import Web3 from 'web3'
 
   const ethAdapter = new Web3Adapter({
@@ -131,7 +131,7 @@ const safeAccountConfig: SafeAccountConfig = {
   threshold: 2,
   // ... (optional params)
 }
-const safeSdk = await safeFactory.deploySafe(safeAccountConfig)
+const safeSdk = await safeFactory.deploySafe({ safeAccountConfig })
 ```
 
 Calling the method `deploySafe` will deploy the desired Safe and return a Safe Core SDK initialized instance ready to be used.
@@ -213,6 +213,7 @@ Once we have the Safe transaction object we can share it with the other owners o
 - `safeTransaction`: The Safe transaction object returned from the method `createTransaction`. Make sure that this object includes the signature of the owner which is proposing it.
 - `safeTxHash`: The Safe transaction hash, calculated by calling the method `getTransactionHash` from the Safe Core SDK.
 - `senderAddress`: The Safe owner proposing the transaction.
+- `origin`: Optional string that allows to provide more information about the app proposing the transaction.
 
 ```js
 await safeSdk.signTransaction(safeTransaction)
@@ -221,7 +222,8 @@ await safeService.proposeTransaction({
   safeAddress,
   safeTransaction,
   safeTxHash,
-  senderAddress
+  senderAddress,
+  origin
 })
 ```