Safe Protocol Wrapper SDK

A TypeScript wrapper for the Safe Protocol Kit, making it easier to interact with Safe smart contract wallets.

Installation

npm install safe-wrapper-sdk

Features

• Re-exports Safe Protocol Kit with proper TypeScript types
• Simplified imports for common Safe operations
• TypeScript support with full type definitions

Usage

import { Safe, SafeConfig, SafeTransactionDataPartial, OperationType } from 'safe-wrapper-sdk';

// Initialize Safe
const safeConfig: SafeConfig = {
  provider: 'YOUR_RPC_URL',
  signer: 'YOUR_PRIVATE_KEY'
};

const safe = await Safe.init(safeConfig);

// Create a new Safe
const safeAccountConfig = {
  owners: ['OWNER_ADDRESS'],
  threshold: 1
};

const newSafe = await safe.createSafe(safeAccountConfig);

// Create and execute a transaction
const transaction: SafeTransactionDataPartial = {
  to: 'TARGET_ADDRESS',
  data: 'TRANSACTION_DATA',
  value: '0', // value in wei
  operation: OperationType.Call
};

const safeTransaction = await safe.createTransaction({
  transactions: [transaction]
});

const signedSafeTransaction = await safe.signTransaction(safeTransaction);
const executeTxResponse = await safe.executeTransaction(signedSafeTransaction);

Requirements

• Node.js 14 or later
• TypeScript 4.0 or later

Dependencies

This SDK wraps the following Safe Global package:

• @safe-global/protocol-kit

License

MIT