https://github.com/5afe/contract-proxy-kit
Enable batched transactions and contract account interactions using a unique deterministic Gnosis Safe.
https://github.com/5afe/contract-proxy-kit
Last synced: 11 months ago
JSON representation
Enable batched transactions and contract account interactions using a unique deterministic Gnosis Safe.
- Host: GitHub
- URL: https://github.com/5afe/contract-proxy-kit
- Owner: 5afe
- Created: 2019-11-07T14:26:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T10:38:12.000Z (over 3 years ago)
- Last Synced: 2025-03-27T16:48:51.263Z (about 1 year ago)
- Language: TypeScript
- Size: 15.6 MB
- Stars: 101
- Watchers: 14
- Forks: 38
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contract Proxy Kit Monorepo
[](https://coveralls.io/github/gnosis/contract-proxy-kit?branch=master)
## Packages
| Package | Description |
| ------- | ----------- |
| [contract-proxy-kit](https://github.com/gnosis/contract-proxy-kit/tree/master/packages/contract-proxy-kit) [](https://badge.fury.io/js/contract-proxy-kit) | TypeScript SDK that enables batched transactions and contract account interactions using a unique deterministic Gnosis Safe. |
| [cpk-configuration-app](https://github.com/gnosis/contract-proxy-kit/tree/master/packages/cpk-configuration-app) | Example Dapp that uses the CPK showing all its possible configurations and allowing to play around with it. |
## Setting up the development environment
### Installing dependencies
```
yarn global add lerna
lerna bootstrap
```
### Running commands
Build the Contract Proxy Kit:
```
yarn cpk:build
```
Test the Contract Proxy Kit:
```
yarn cpk:test
```
Build the CPK Configuration App
```
yarn app:build
```
Run the CPK Configuration App
```
yarn app:start
```
## Useful links
- [API Documentation](https://cpk-docs.surge.sh/)
- [CPK Configuration App demo](https://cpk-app.surge.sh)
- [Video introduction to Building with Safe Apps SDK & Contract Proxy Kit](https://www.youtube.com/watch?v=YGw8WfBw5OI)
You can find more resources on the Contract Proxy Kit in the [Gnosis Safe Developer Portal](https://docs.gnosis.io/safe/docs/sdks_safe_apps/).