Safe Core SDK Monorepo

Software developer tools that facilitate the interaction with the Safe contracts and services.

Guides

Title	Description
Integrating the Safe Core SDK	This guide shows how to use the Safe Core SDK and Safe Service Client.

Packages

Package	Release	Description
safe-core-sdk		TypeScript library that facilitates the interaction with the Safe contracts
safe-core-sdk-types		Common types extracted from the Safe Core SDK packages
safe-core-sdk-utils		Utilities for the Safe Core SDK packages
safe-ethers-lib		Ethers.js utilities and Safe contracts types (typechain ethers-v5) used to initialize the Safe Core SDK
safe-web3-lib		Web3.js utilities and Safe contracts types (typechain web3-v1) used to initialize the Safe Core SDK
safe-service-client		Safe Transaction Service API client library
safe-ethers-adapters		Ethers adapter that facilitates the interaction with the Safe Services

Playground

This project includes a playground with a few scripts that can be used as a starting point to use the Safe Core SDK. These scripts do not cover all the functionality exposed by the SDK, but each of them present steps of the Safe transaction flow.

Update the config inside the scripts and execute the following commands to run each step:

Step 1: Deploy a Safe

yarn play deploy-safe

Step 2: Propose a transaction

yarn play propose-transaction

Step 3: Confirm a transaction

yarn play confirm-transaction

Step 4: Execute a transaction

yarn play execute-transaction