Merge pull request #34 from thencc/main

updating npm stable release w new name + version

.github/workflows/npm-publish-beta.yml

@@ -31,7 +31,7 @@ jobs:
         SHOULD_PUBLISH=0
         PKG_VERSION_LOCAL=`cat package.json | jq -r '.version'`
         echo 'local pkg: '$PKG_VERSION_LOCAL
-        PKG_VERSION_PUBLISHED=`npm view algonaut.js@beta version`
+        PKG_VERSION_PUBLISHED=`npm view @thencc/algonautjs@beta version`
         echo 'beta pkg: '$PKG_VERSION_PUBLISHED
         npx semver-compare $PKG_VERSION_LOCAL gt $PKG_VERSION_PUBLISHED && SHOULD_PUBLISH=1
         echo 'publish beta?: '$SHOULD_PUBLISH

.github/workflows/npm-publish.yml

@@ -31,6 +31,6 @@ jobs:
         run: |
           npm config set registry https://registry.npmjs.org/
           PKG_VERSION_LOCAL=`cat package.json | jq -r '.version'`
-          npm dist-tag add algonaut.js@$PKG_VERSION_LOCAL latest
+          npm dist-tag add @thencc/algonautjs@$PKG_VERSION_LOCAL latest
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -15,7 +15,7 @@ We package, expose and depend on the JavaScript Algosdk.  It's there if you need
 To create an instance with a node and get ready to transact:
 
 ```js
-import AlgonautJS from 'algonaut.js';
+import AlgonautJS from '@thencc/algonautjs';
 
 const algonaut = new AlgonautJS({
   BASE_SERVER: 'https://testnet-algorand.api.purestake.io/ps2',
@@ -67,12 +67,12 @@ const response = await algonaut.callApp(
 
 Install from NPM:
 
-```npm install algonaut.js --save```
+```npm install @thencc/algonautjs --save```
 
 Usage:
 
 ```js
-import Algonaut from 'algonaut.js';
+import Algonaut from '@thencc/algonautjs';
 const algonaut = new Algonaut({
   BASE_SERVER: 'https://testnet-algorand.api.purestake.io/ps2',
   LEDGER: 'TestNet',
@@ -101,14 +101,28 @@ Rudimentary tests done in `test/` dir.
 
 ## Contributing
 
+### To generate docs:
+
+```npm run docs```
+
+[Typedoc options](https://typedoc.org/guides/options/) are set in `typedoc.json`.
+
+---
+### Publishing to NPM:
+
+[ *latest/release* ]
+stable releases have the default npm tag of `latest` (installable via `npm i @thencc/algonautjs` or `npm i @thencc/algonautjs@latest`) and are automatically published from the repo's `release` branch via a Github Action. so simply pull request the `main` branch (or feature specific branch) into `release` to publish to npm.
+
+[ *beta/main* ]
+similarly, pushing commits or merging pull requests to the repo's `main` branch will automatically publish to the npm `beta` release installable via `npm i @thencc/algonautjs@beta`.
+
+note:
+- to update either the `latest` or `beta` releases, the version in `package.json` must be higher than the previous release.
+
+---
+
 TBD:
 
 - setting up a dev env
 - ESLint and code style
 - building and testing with Vite and Node
-
-To generate docs:
-
-```npm run docs```
-
-[Typedoc options](https://typedoc.org/guides/options/) are set in `typedoc.json`.

dist/index.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="node" />
 import algosdk from 'algosdk';
-import { AlgonautConfig, AlgonautWallet, AlgonautTransactionStatus, AlgonautAtomicTransaction, AlgonautAppState, AlgonautStateData, AlgonautError, WalletConnectListener, AlgonautTxnCallbacks, AlgonautCreateAssetArguments, AlgonautSendAssetArguments, AlgonautCallAppArguments, AlgonautDeployArguments, AlgonautLsigDeployArguments, AlgonautLsigCallAppArguments, AlgonautLsigSendAssetArguments, AlgonautPaymentArguments, AlgonautLsigPaymentArguments, AlgonautUpdateAppArguments, AlgonautAppStateEncoded } from './AlgonautTypes';
-import { IInternalEvent } from '@walletconnect/types';
+import type { AlgonautConfig, AlgonautWallet, AlgonautTransactionStatus, AlgonautAtomicTransaction, AlgonautAppState, AlgonautStateData, AlgonautError, WalletConnectListener, AlgonautTxnCallbacks, AlgonautCreateAssetArguments, AlgonautSendAssetArguments, AlgonautCallAppArguments, AlgonautDeployArguments, AlgonautLsigDeployArguments, AlgonautLsigCallAppArguments, AlgonautLsigSendAssetArguments, AlgonautPaymentArguments, AlgonautLsigPaymentArguments, AlgonautUpdateAppArguments, AlgonautAppStateEncoded } from './AlgonautTypes';
 import { FrameBus } from './FrameBus';
+import { IInternalEvent } from '@walletconnect/types';
 declare global {
     interface Window {
         AlgoSigner: any;
@@ -11,12 +11,11 @@ declare global {
 export declare class Algonaut {
     algodClient: algosdk.Algodv2;
     indexerClient: algosdk.Indexer | undefined;
+    sdk: typeof algosdk;
+    config: AlgonautConfig | undefined;
     account: algosdk.Account | undefined;
     address: string | undefined;
-    sKey: Uint8Array | undefined;
     mnemonic: string | undefined;
-    config: AlgonautConfig | undefined;
-    sdk: typeof algosdk | undefined;
     uiLoading: boolean;
     inkeyWallet: {
         defaultSrc: string;
@@ -38,7 +37,7 @@ export declare class Algonaut {
      * Usage:
      *
      * ```js
-     * import Algonaut from 'algonaut.js';
+     * import Algonaut from '@thencc/algonautjs';
      * const algonaut = new Algonaut({
      *	 BASE_SERVER: 'https://testnet-algorand.api.purestake.io/ps2',
      *	 INDEX_SERVER: 'https://testnet-algorand.api.purestake.io/idx2'
@@ -53,9 +52,18 @@ export declare class Algonaut {
      * @param config config object
      */
     constructor(config: AlgonautConfig);
-    initInkey(mountConfig: {
-        src?: string;
-    }): void;
+    /**
+     * checks if config obj is valid for use
+     * @param config algonaut config for network + signing mode
+     * @returns boolean. true is good.
+     */
+    isValidConfig(config: AlgonautConfig): boolean;
+    /**
+     * sets config for use (new algod, indexerClient, etc)
+     * @param config algonaut config for network + signing mode
+     * 		- will throw Error if config is lousy
+     */
+    setConfig(config: AlgonautConfig): void;
     /**
      * @returns config object or `false` if no config is set
      */
@@ -65,6 +73,9 @@ export declare class Algonaut {
      * @returns Promise resolving to status of Algorand network
      */
     checkStatus(): Promise<any | AlgonautError>;
+    initInkey(mountConfig: {
+        src?: string;
+    }): void;
     /**
      * if you already have an account, set it here
      * @param account an algosdk account already created