export getWallet, ensure it works + is exampled

entropyxyz / sdk

Official JavaScript SDK for Entropy blockchain.

GNU Affero General Public License v3.0

7 stars 0 forks source link

export getWallet, ensure it works + is exampled #309

Closed mixmix closed 2 months ago

mixmix commented 2 months ago

in the example, it was unclear where getWallet come from.

This PR

ensures getWallet is importable
changes tests to use import
changes Example code
changes the inline docs to be true (only takes a string)

mixmix commented 2 months ago

What I don't know:

why tests are not passing locally
why there ./README.md is a duplicate of ./docs/README.md
are the docs generated from inline comments? (couldn't see an npm script for it)

frankiebee commented 2 months ago

What I don't know:

why tests are not passing locally

why there ./README.md is a duplicate of ./docs/README.md

are the docs generated from inline comments? (couldn't see an npm script for it)

Tesser not running locally correctly because we rely on docker dot docs/Readme.md is a generated file. We should put a disclaimer that those docs come from a tool it should be in the package.json file I guess also we could ignore them?

mixmix commented 2 months ago

I'm gonna close this, got a mega branch working on this and other things