Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(docs): Remove makeLocalAccount #1208

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

(docs): Remove makeLocalAccount #1208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions main/guides/orchestration/getting-started/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,6 @@ Retrieves the chain information and provides access to chain-specific methods. S
const chain = await orchestrator.getChain('chainName')
```

### makeLocalAccount
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is accurate but I suspect not complete. If this repo is about a guide to using the API, shouldn't we also indicate how to make a local account? (getChain('agoric')

If this is just a presentation of the API, why is it defined manually here? We can generate API docs from the API repo.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@turadg this is a work in progress. In fact, I plan to merge this page to a key-concepts page in #1201 - which reminds me that I need to leave a note to remove makeLocalAccount from there.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a work in progress

Sure, but part of my question is about doing less work here. I'm concerned we'll spend time redescribing the API in this repo when we can just import the API output from agoric-sdk.

Copy link
Contributor

@amessbee amessbee Sep 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I digress but have a look at devrel's current plan for orchestration docs(slack link). Look forward to feedback to improve this, but we believe that a certain amount of redundancy will enhance DX. Also, I will drag you to #1201 for feedback now 😆


Creates a new `LocalChainAccount`. See [makeLocalAccount](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.Orchestrator#makeLocalAccount).

```javascript
const localAccount = await orchestrator.makeLocalAccount()
```

### getBrandInfo

Returns information about a `denom`, including the equivalent local Brand, the chain where the denom is held, and the chain that issues the corresponding asset. See [getBrandInfo](https://agoric-sdk.pages.dev/interfaces/_agoric_orchestration.Orchestrator#getBrandInfo).
Expand Down
Loading