Document using a different source account for an operation that is different from the parent transaction envelope account

Open
#1,022 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Domain
blockchain, documentation

Research direction

Start with the existing documentation discussed in re #1011 and the Lab guidance around set ops. Document how operation sources differ from the parent transaction envelope source, including basic examples and the signature and key-custody implications. Done means a new user can distinguish the two sources and understand the relevant signing requirements.

Written by the indexing model from the issue text.

Description

bot:needs-decision dev-rel documentation good first issue
What problem does your feature solve? 📝

It is my present understanding of the Docs that there is not a source of reference detailing how operations can have a source account different than that of the parent transaction envelope. In re #1011, might we clarify explicitly how default source account overrides work for new users?

What would you like to see?

Explain how each transaction's operation can have it's own source, unique from an envelope source. 💌 Ideally, provide a few code examples showing some very basic applications. Materially, the signature implications ought be extensively detailed per key custody implications.

What alternatives are there? 💭

We could require new users to learn all this when they start messing around with the Lab, but that may not be ideal. Namely, a new developer could confuse transaction and operation source accounts in re set ops functions which lock an account, potentially through no fault of their own. 🔐 A brief and informative explanation here could greatly protect newcomers.

Dominant language
MDX
Stars
138
Forks
313
Avg merge
3d 11h
Merged PRs (30d)
44

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from stellar/stellar-docs

All issues in stellar/stellar-docs

Similar issues

More Blockchain issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.