Skip to content

Commit ef16f71

Browse files
committed
docs: add header comments
1 parent 554259f commit ef16f71

File tree

3 files changed

+32
-2
lines changed

3 files changed

+32
-2
lines changed

examples/signing/01-ed25519-from-keyring.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1-
/* eslint-disable no-console */
1+
/**
2+
* Example: Ed25519 Signing From Keyring
3+
*
4+
* This example demonstrates how to retrieve secrets from a keyring and use them to sign
5+
* transactions.
6+
*
7+
* Prerequisites:
8+
* - LocalNet running (via `algokit localnet start`)
9+
* - OS that has keyring support
10+
*/
211

12+
/* eslint-disable no-console */
313
import { ed25519SigningKeyFromWrappedSecret, WrappedEd25519Seed } from '@algorandfoundation/algokit-crypto'
414
import { algo, AlgorandClient, microAlgo } from '@algorandfoundation/algokit-utils'
515
import { mnemonicFromSeed, seedFromMnemonic } from '@algorandfoundation/algokit-utils/algo25'

examples/signing/02-hd-from-keyring.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1-
/* eslint-disable no-console */
1+
/**
2+
* Example: HD Signing From Keyring
3+
*
4+
* This example demonstrates how to retrieve secrets from a keyring and use them to sign
5+
* transactions.
6+
*
7+
* Prerequisites:
8+
* - LocalNet running (via `algokit localnet start`)
9+
* - OS that has keyring support
10+
*/
211

312
import {
413
ed25519SigningKeyFromWrappedSecret,

examples/signing/03-aws-kms.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
/**
2+
* Example: Ed25519 Signing from AWS KMS
3+
*
4+
* This example demonstrates how to use the AWS KMS
5+
*
6+
* Prerequisites:
7+
* - LocalNet running (via `algokit localnet start`)
8+
*/
9+
10+
/* eslint-disable no-console */
11+
112
import { RawEd25519Signer } from '@algorandfoundation/algokit-crypto'
213
import { AlgorandClient, microAlgos } from '@algorandfoundation/algokit-utils'
314
import { generateAddressWithSigners } from '@algorandfoundation/algokit-utils/transact'

0 commit comments

Comments
 (0)