Skip to content

Solana Payout Action

Actions

About

Automatically pay SOL/SPL tokens to a specified recipient wallet address in Solana
v0.0.3
Latest
By UraniumCorporation
Star (4)

Tags

 (2)
open-source-managementcommunity

Solana Payout Action

A GitHub Action to automatically pay SOL/SPL tokens to a specified recipient wallet address in Solana.

Features

  • Send SOL or SPL tokens to any valid Solana wallet address
  • Support for multiple Solana networks (mainnet-beta, devnet, testnet)
  • Validates wallet addresses and balances before transactions
    • Checks for sufficient SOL balance to cover transaction fees
    • Verifies sufficient token balance for token transfers
    • Automatically creates token account for recipient if it doesn't exist
    • Ensures sender has enough SOL to create token account for the recipient if needed
  • Comprehensive error handling and validation

Usage

# Send SOL
- name: Solana Payout Action - Send SOL
  uses: UraniumCorporation/solana-payout-action@v0.0.3
  with:
    recipient-wallet-address: "RECIPIENT_WALLET_ADDRESS"
    amount: "1.5" # Amount in SOL
    token: "SOL"
    network: "mainnet-beta" # Optional (default: mainnet-beta)
    timeout: 300000 # Optional (default: 300000ms = 5 minutes)
  env:
    SENDER_WALLET_SECRET: ${{ secrets.SENDER_WALLET_SECRET }}

# Send SPL Token(s)
- name: Solana Payout Action - Send SPL Token(s)
  uses: UraniumCorporation/solana-payout-action@v0.0.3
  with:
    recipient-wallet-address: "RECIPIENT_WALLET_ADDRESS"
    amount: "10" # Amount in tokens
    token: "TOKEN_ADDRESS" # SPL token address
    network: "mainnet-beta" # Optional (default: mainnet-beta)
    timeout: 300000 # Optional (default: 300000ms = 5 minutes)
  env:
    SENDER_WALLET_SECRET: ${{ secrets.SENDER_WALLET_SECRET }}

Inputs

Input Description Type Required Default
recipient-wallet-address Solana wallet address to receive the payment string Yes -
amount Amount to send (in SOL or tokens) string Yes -
token Token to send - either 'SOL' or an SPL token address string Yes -
network Solana network to use (mainnet-beta, devnet, testnet) string No mainnet-beta
timeout Timeout to confirm the transaction in milliseconds number No 300000

Outputs

Output Description Type Possible Values
success Whether the payment was successful string (boolean) "true", "false"
error The error that occurred during the payment (if any) string "<error-message>", "" (empty string if success == "true")
transaction The transaction signature for successful payments string "<transaction-signature>", "" (empty string if success == "false")

Environment Variables

Variable Description Type Required
SENDER_WALLET_SECRET Private key of the sender's wallet in base58 format string Yes

Setup

  1. Create a Solana wallet to use as the sender
  2. Add the wallet's private key as a repository secret named SENDER_WALLET_SECRET
    • The private key must be in base58 format (the standard format used by all Solana wallets)
      • Example: 4wBqpZM9xkVJc8j7Z3gVxmBpMpRxLsQpiUbLaZCziaKAcXdwdKxRvKoRZGYXvEQZUNk5UJUZyeLHz1vHvfnzHYbN
        • You can typically export the private key from wallets providers
        • No other formats are supported
  3. Ensure the sender wallet has sufficient SOL for the amount of SOL to send plus transaction fees
    • The action will check the sender's SOL balance before sending the payment
    • If the sender wallet does not have enough SOL, the action will fail with an error message
  4. If sending SPL tokens, ensure the sender wallet has the tokens and SOL for transaction fees
    • The action will check the sender's token balance and SOL balance before sending the payment
    • If the sender wallet does not have enough tokens or SOL, the action will fail with an error message

Example Workflow

Basic SOL/SPL Token Payment Example (Manual Trigger)

name: Send SOL/SPL Token Payment
on:
  # Manual trigger with inputs
  workflow_dispatch:
    inputs:
      recipient:
        description: "Recipient wallet address"
        required: true
      amount:
        description: "Amount to send (in SOL or tokens)"
        required: true
        default: "0.1"
      token:
        description: "Token to send - either 'SOL' or an SPL token address"
        required: true
        default: "SOL"
      network:
        description: "Solana network (mainnet-beta, devnet, testnet)"
        required: true
        default: "devnet"
        type: choice
        options:
          - mainnet-beta
          - devnet
          - testnet
      timeout:
        description: "Timeout to confirm the transaction in milliseconds"
        required: false
        default: 300000
        type: number

jobs:
  send-payment:
    runs-on: ubuntu-latest
    steps:
      - name: Solana Payout Action
        uses: UraniumCorporation/solana-payout-action@v0.0.3
          id: payout
          continue-on-error: true
          with:
            recipient-wallet-address: ${{ inputs.recipient }}
            amount: ${{ inputs.amount }}
            token: ${{ inputs.token }}
            network: ${{ inputs.network }}
            timeout: ${{ inputs.timeout }}
          env:
            SENDER_WALLET_SECRET: ${{ secrets.SENDER_WALLET_SECRET }}

      # Example of using the transaction output
      - name: Print Successful Payment Details
        if: steps.payout.outputs.success == 'true'
        run: |
          echo "Payment successful!"
          echo "Transaction signature: ${{ steps.payout.outputs.transaction }}"
          echo "View on Solana Explorer: https://explorer.solana.com/tx/${{ steps.payout.outputs.transaction }}"
          echo "View on Solscan: https://solscan.io/tx/${{ steps.payout.outputs.transaction }}"

      # Example of handling payment failure
      - name: Print Failed Payment Details
        if: steps.payout.outputs.success == 'false'
        run: |
          echo "Payment failed!"
          echo "Error message: ${{ steps.payout.outputs.error }}"
          exit 1

Use Case: Simple Automated PR Reward System

This example below shows how to automatically pay contributors in SOL/SPL Tokens when their PR is merged.

Caution

This is a simplified example below and does not have any security guardrails in place. Please ensure you have the appropriate security measures applied in your workflow for your use case. DO NOT simply copy this example and use it as is in a production environment.

Tip

For a more production-ready example of an automated PR reward system, please refer to Uranium Corporation's Maiar AI repo's Bounty Payment Workflow.

Pull Request Format Requirements

Contributors must include their Solana wallet address in the PR description using this format:

## Wallet Address
solana:ABC123...XYZ

Example PR description:

Fixed bug

## Wallet Address

solana:HN7cABqLq46Es1jh92dQQisAq662SmxELLLsHHe4YWrH

Workflow Configuration

name: Pay Contributor
on:
  pull_request_target:
    types: [closed]

env:
  SOLANA_NETWORK: "mainnet-beta" # or devnet, testnet, etc.
  TOKEN: "SOL" # Pay in SOL/SPL Tokens - Valid values are 'SOL' or an SPL token address

jobs:
  pay-contributor:
    if: github.event.pull_request_target.merged == true
    runs-on: ubuntu-latest
    steps:
      # Extract wallet address from PR description
      - name: Extract wallet address
        id: extract-wallet
        run: |
          DESCRIPTION="${{ github.event.pull_request_target.body }}"
          WALLET=$(echo "$DESCRIPTION" | grep -o 'solana:[A-Za-z0-9]\{32,\}' | cut -d':' -f2)
          echo "wallet=$WALLET" >> $GITHUB_OUTPUT

      - uses: UraniumCorporation/solana-payout-action@v0.0.3
        with:
          recipient-wallet-address: ${{ steps.extract-wallet.outputs.wallet }}
          amount: "1.0"
          token: ${{ env.TOKEN }}
          network: ${{ env.SOLANA_NETWORK }}
          timeout: 300000 # Optional, default is 300000ms (5 minutes)
        env:
          SENDER_WALLET_SECRET: ${{ secrets.SENDER_WALLET_SECRET }}

Contributors (2)

@ktn1234@SolSoc

Resources

Solana Payout Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Automatically pay SOL/SPL tokens to a specified recipient wallet address in Solana
v0.0.3
Latest
By UraniumCorporation

Tags

 (2)
open-source-managementcommunity

Contributors (2)

@ktn1234@SolSoc

Resources

Solana Payout Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.