propose-safe-multisig-tx

Safe Multisig Transaction Proposer - Reusable Workflow

Overview 🌟

This reusable GitHub Actions workflow automates the process of proposing transactions to a Safe multi-signature wallet (Gnosis Safe). It handles the proposal submission, making it easy to integrate Safe transactions into your CI/CD pipeline.

Workflow Inputs 🛠️

Input	Description	Required	Default
rpc-url	RPC URL for the blockchain network	Yes	-
safe-address	Address of the Safe contract	Yes	-
transaction-to	Target address for the transaction	Yes	-
transaction-value	Value to send in the transaction (in wei)	No	0
transaction-data	Transaction data/calldata	Yes	-
safe-proposer-private-key	Private key of the proposer wallet	Yes (Secret)	-
safe-api-key	Safe API key for transaction service	Yes (Secret)	-

Workflow Outputs 📤

Output	Description
tx-hash	Hash of the Safe transaction created
tx-details	Complete transaction details (JSON)

How to Use This Reusable Workflow 🔄

1. Call the Reusable Workflow
   In another workflow file, invoke this reusable workflow like so:

    name: Upgrade contract
   
    on:
      workflow_dispatch:
   
    jobs:
      upgrade:
        uses: ./.github/workflows/propose-safe-multisig-tx.yml
        secrets:
          safe-proposer-private-key: ${{ secrets.SAFE_PROPOSER_PRIVATE_KEY }}
          safe-api-key: ${{ secrets.SAFE_API_KEY }}
        with:
          rpc-url: 'https://...'
          safe-address: '0xab...'
          transaction-to: '0xcd...'
          transaction-value: '0'
          transaction-data: '0xef' # Upgrade transaction calldata

2. Configure Secrets
   Ensure that the required secrets are added to your repository's settings:

   • SAFE_PROPOSER_PRIVATE_KEY: The private key of the wallet that will propose the transaction
   • SAFE_API_KEY: Your Safe API key for the transaction service

Security Considerations 🛡️

⚠️ Important: Never expose private keys in logs or code files. Always use GitHub Secrets to store sensitive information securely.