Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 5.21 KB

README.md

File metadata and controls

53 lines (34 loc) · 5.21 KB

license Coverage Status

Safe_Logos_Core_SDK_Black

Table of contents

About

This is a mono-repository containing Javascript/Typescript software developer tools that facilitate the interaction with Safe Smart Accounts, Safe Transaction Service API, and enabling uses like ERC-4337 compatibility.

Documentation

If you want to develop using Safe Smart Accounts in a Javascript/Typescript app, we recommend that you visit our documentation site.

Packages

Package Release Description
protocol-kit npm Version TypeScript library that facilitates the interaction with Safe Smart Accounts. Can be used to create new Safe accounts, update the configuration of existing Safes, create and execute transactions, among other features.
api-kit npm Version Safe Transaction Service API typescript library. Allows to propose and share transactions with the other signers of a Safe, sending the signatures to the service to collect them, and getting information about a Safe, among other features.
relay-kit ​​​npm Version Typescript library that enables ERC-4337 with Safe and allows users to pay for the transaction fees from their Safe account balance using the blockchain native token or ERC-20 tokens, or to get their transactions sponsored.
types-kit npm Version Common types used in the Safe Core SDK packages.

Guides

Title Description
Integrating the Safe{Core} SDK This guide shows how to use the Protocol Kit and API Kit.

Need Help or Have Questions?

If you have any doubts, questions, or need assistance, feel free to reach out! Here you will find how to get support.

Contributing

If you are interested in contributing, please read the Contributing Guidelines before opening an issue or submitting a pull request.

Playground

This project includes a playground with a few scripts that can be used as a starting point to use the Safe{Core} SDK.

License

This library is released under MIT.