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.

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

Update Root-level README #20

Open
bravetarget opened this issue Oct 18, 2021 · 1 comment
Open

Update Root-level README #20

bravetarget opened this issue Oct 18, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@bravetarget
Copy link
Contributor

bravetarget commented Oct 18, 2021

Problem

There is no clear documentation on what the Factory Module is or what it does

Solution

Update README to include a few things:

  • Introduction to the Star Atlas Factory
  • Current program list this module supports
    • Official progam ids for devnet/mainnet included, or a link to the source of truth
  • Badges w/npm downloads and latest health check status

Alternatives Considered

Notes

We may want a separate document for each integrated program to describe the associated functions

@MikeLuDev MikeLuDev added the documentation Improvements or additions to documentation label Jul 28, 2022
@uaktags
Copy link

uaktags commented Feb 16, 2023

Obviously not an answer for the issue:

https://build.staratlas.com/apis-and-data/factory

Some things i've done with just experimenting:

  import * as factory from "@staratlas/factory";
  ////
  const starAtlasId = new PublicKey('FLEET1qqzpexyaDpqb2DGsSzE2sDCizewCg9WjrA6DBW');
  const idl: Idl = factory.getIDL(starAtlasId) as Idl;
  const programStarAtlas = new Program(idl, starAtlasId, provider);
  const fleet = await factory.getAllFleetsForUserPublicKey(
                connection,
                new PublicKey(...), //pubkey for playerAccount
                starAtlasId
            );
            
            ```

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants