Development

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Hardhat Test
+name: Monorepo Test
 on: [push, pull_request]
 env:
   INFURA_KEY: ${{ secrets.INFURA_KEY }}

.github/workflows/test_V1_2_0.yml

@@ -0,0 +1,21 @@
+name: Safe Core SDK Test (Safe v1.2.0)
+on: [push, pull_request]
+env:
+  INFURA_KEY: ${{ secrets.INFURA_KEY }}
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14.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:ethers:v1.2.0

.github/workflows/test_V1_3_0.yml

@@ -0,0 +1,21 @@
+name: Safe Core SDK Test (Safe v1.3.0)
+on: [push, pull_request]
+env:
+  INFURA_KEY: ${{ secrets.INFURA_KEY }}
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14.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:ethers:v1.3.0

packages/guides/README.md

@@ -0,0 +1,46 @@
+# Guide: Integrating the Safe Core SDK
+
+## What is Gnosis Safe
+
+Read about the basics of Gnosis Safe and how it compares to other solutions [here](https://help.gnosis-safe.io/en/articles/3876456-what-is-gnosis-safe).
+
+## Safe Core SDK
+
+The [Safe Core SDK](https://github.com/gnosis/safe-core-sdk) is a monorepo that contains software developer tools that allows interaction with the [Safe contracts](https://github.com/gnosis/safe-contracts) and the [Safe Transaction Service](https://github.com/gnosis/safe-transaction-service).
+
+In this guide we will use the following packages to deploy new Safes, create transactions, collect off-chain signatures and execute transactions:
+* **safe-core-sdk-types**
+
+  Contains the types that are shared among the different packages inside the monorepo.
+
+* **safe-core-sdk**
+
+  Offers most of the functionality of the Safe contracts. This library only interacts with the Safe contracts and every action then happens on-chain. Among others, it allows for actions such as:
+    - Deploy new Safes
+    - Get Safe information from the contracts (nonce, threshold, owners, modules, etc.)
+    - Build Safe transaction objects that can be executed or batched
+    - Approve Safe transactions on-chain
+    - Execute Safe transactions once they have the required confirmations
+
+  Check the complete [API reference](/packages/safe-core-sdk#api-reference) for more details.
+
+* **safe-service-client**
+
+  Consumes the Safe Transaction Service API. This library only interacts with this service and every action performed with it happens off-chain. Among others, it allows to execute actions like:
+    - Get information of a Safe
+    - Store a Safe transaction to allow for signature collection from owners
+    - Add signatures to stored transactions
+    - Get the transaction history of a Safe (and filter by pending, incoming, multisig transactions, etc.)
+    - Get balances, list of tokens, etc.
+
+  Check the complete [API reference](/packages/safe-service-client#api-reference) for more details.
+
+## Prerequisites
+
+We'll assume that you are familiar with TypeScript (JavaScript), Ethereum and have `node.js` and `npm` installed.
+
+## Help
+
+If you need help, you can reach Gnosis Safe developers in the #safe-developers channel at https://chat.gnosis.io/ or create a discussion at https://github.com/gnosis/safe-core-sdk/discussions.
+
+Let's jump into the guide: [Integrating the Safe Core SDK](/packages/guides/integrating-the-safe-core-sdk.md)