From 3e9490644ae5c793532f09b5becb7f16309c635b Mon Sep 17 00:00:00 2001
From: ryan <ryan@distrust.co>
Date: Tue, 18 Feb 2025 01:08:52 -0500
Subject: [PATCH] add descriptions for newly added workflows

---
 .../icepick/workflows/cosmos/broadcast.yaml   | 12 +++++++---
 crates/icepick/workflows/cosmos/transfer.yaml | 24 ++++++++++++++-----
 crates/icepick/workflows/sol/broadcast.yaml   | 14 ++++++++---
 .../workflows/sol/generate-nonce-account.yaml | 19 ++++++++++++---
 crates/icepick/workflows/sol/transfer.yaml    | 16 +++++++++----
 5 files changed, 66 insertions(+), 19 deletions(-)

diff --git a/crates/icepick/workflows/cosmos/broadcast.yaml b/crates/icepick/workflows/cosmos/broadcast.yaml
index ba677de..fdb7511 100644
--- a/crates/icepick/workflows/cosmos/broadcast.yaml
+++ b/crates/icepick/workflows/cosmos/broadcast.yaml
@@ -1,7 +1,13 @@
 name: "broadcast"
+description: |-
+  Broadcast a transaction on a Cosmos-based blockchain.
 inputs:
-- "nonce_address"
-- "chain_name"
+- name: "nonce_address"
+  description: >-
+    The address of the account used for the transaction nonce.
+- name: "chain_name"
+  description: >-
+    The name of the Cosmos chain to broadcast a transaction on.
 step:
 - type: "cosmos-get-chain-info"
   inputs:
@@ -34,4 +40,4 @@ step:
     status: "status"
     url: "url"
     error: "error"
-    error_code: "error_code"
\ No newline at end of file
+    error_code: "error_code"
diff --git a/crates/icepick/workflows/cosmos/transfer.yaml b/crates/icepick/workflows/cosmos/transfer.yaml
index 8003492..fadcb39 100644
--- a/crates/icepick/workflows/cosmos/transfer.yaml
+++ b/crates/icepick/workflows/cosmos/transfer.yaml
@@ -1,10 +1,22 @@
 name: "transfer"
+description: |-
+  Transfer a Cosmos coin.
 inputs:
-- "from_address"
-- "to_address"
-- "asset_name"
-- "chain_name"
-- "asset_amount"
+- name: "from_address"
+  description: >-
+    The address from which to send coin.
+- name: "to_address"
+  description: >-
+    The address to send coins to.
+- name: "asset_name"
+  description: >-
+    The name of the asset to send.
+- name: "chain_name"
+  description: >-
+    The name of the Cosmos chain the asset lives on.
+- name: "asset_amount"
+  description: >-
+    The amount of the asset to send.
 step:
 - type: "cosmos-get-chain-info"
   inputs:
@@ -40,4 +52,4 @@ step:
   values:
     filename: "transaction.json"
   inputs:
-    transaction: "signed_transaction"
\ No newline at end of file
+    transaction: "signed_transaction"
diff --git a/crates/icepick/workflows/sol/broadcast.yaml b/crates/icepick/workflows/sol/broadcast.yaml
index 2b3c147..239e0a7 100644
--- a/crates/icepick/workflows/sol/broadcast.yaml
+++ b/crates/icepick/workflows/sol/broadcast.yaml
@@ -1,7 +1,15 @@
 name: "broadcast"
+description: |-
+  Broadcast a transaction on the Solana blockchain.
 inputs:
-- "nonce_address"
-- "cluster"
+- name: "nonce_address"
+  description: >-
+    The address of the nonce account.
+- name: "cluster"
+  description: >-
+    The name of the Solana cluster to broadcast the transaction on, if not
+    mainnet-beta.
+  optional: true
 step:
 - type: "sol-get-nonce-account-data"
   inputs:
@@ -29,4 +37,4 @@ step:
   outputs:
     status: "status"
     url: "url"
-    error: "error"
\ No newline at end of file
+    error: "error"
diff --git a/crates/icepick/workflows/sol/generate-nonce-account.yaml b/crates/icepick/workflows/sol/generate-nonce-account.yaml
index fda4b17..2ac4680 100644
--- a/crates/icepick/workflows/sol/generate-nonce-account.yaml
+++ b/crates/icepick/workflows/sol/generate-nonce-account.yaml
@@ -1,7 +1,20 @@
 name: "generate-nonce-account"
+description: |-
+  Using a temporary Keyfork instance, generate a nonce address for the given
+  authorization address.
 inputs:
-- "cluster"
-- "authorization_address"
+- name: "cluster"
+  description: >-
+    Name of the Solana cluster to generate the nonce account on, if not
+    mainnet-beta.
+- name: "authorization_address"
+  description: >-
+    The address used to authorize advancing the nonce.
+
+    The authorization address (also called "address" or "pubkey" in other
+    workflows) is required to be a signer of the transaction, so the
+    authorization address is often the principal address - the one performing
+    the transaction.
 step:
 - type: "sol-generate-wallet"
 - type: "sol-get-wallet-address"
@@ -59,4 +72,4 @@ step:
     status: "status"
     url: "url"
     nonce_account: "nonce_account"
-    error: "error"
\ No newline at end of file
+    error: "error"
diff --git a/crates/icepick/workflows/sol/transfer.yaml b/crates/icepick/workflows/sol/transfer.yaml
index 4788155..ac5c069 100644
--- a/crates/icepick/workflows/sol/transfer.yaml
+++ b/crates/icepick/workflows/sol/transfer.yaml
@@ -1,8 +1,16 @@
 name: "transfer"
+description: |-
+  Transfer SOL from one address to another.
 inputs:
-- "to_address"
-- "from_address"
-- "amount"
+- name: "to_address"
+  description: >-
+    The address to send SOL to.
+- name: "from_address"
+  description: >-
+    The address to send SOL from.
+- name: "amount"
+  description: >-
+    The amount of SOL to send.
 step:
 - type: "internal-load-file"
   values:
@@ -38,4 +46,4 @@ step:
   values:
     filename: "transaction.json"
   inputs:
-    transaction: "signed_transaction"
\ No newline at end of file
+    transaction: "signed_transaction"