Merge pull request #6 from ZelCore-io/dev

Dev

.github/workflows/ci.yml

@@ -7,30 +7,38 @@ on:
             - dev
     pull_request:
 
-env:
-    node_version: 16
-
 jobs:
     Test:
         runs-on: ${{ matrix.os }}
+        env:
+            NPM_TOKEN: ${{ secrets.NPM_TOKEN_READONLY }}
         strategy:
             matrix:
-                os: [ubuntu-latest, windows-latest, macOS-latest]
+                os: [ubuntu-latest]
+                node-version: [18.x]
         steps:
             - uses: actions/checkout@v2
             - uses: actions/setup-node@v2
               with:
                   cache: yarn
-                  node-version: ${{ env.node_version }}
+                  node-version: ${{ matrix.node-version }}
+            - run: echo '//registry.npmjs.org/:_authToken= ${{ secrets.NPM_TOKEN_READONLY }}' >> .npmrc
             - run: yarn --frozen-lockfile --network-timeout 1000000
             - run: yarn test --ci --coverage --maxWorkers=2
     Lint:
         runs-on: ubuntu-latest
+        env:
+            NPM_TOKEN: ${{ secrets.NPM_TOKEN_READONLY }}
+        strategy:
+            matrix:
+                os: [ubuntu-latest]
+                node-version: [18.x]
         steps:
             - uses: actions/checkout@v2
             - uses: actions/setup-node@v2
               with:
                   cache: yarn
-                  node-version: ${{ env.node_version }}
+                  node-version: ${{ matrix.node-version }}
+            - run: echo '//registry.npmjs.org/:_authToken= ${{ secrets.NPM_TOKEN_READONLY }}' >> .npmrc
             - run: yarn --frozen-lockfile
             - run: yarn lint

.github/workflows/dev-release.yml

@@ -0,0 +1,33 @@
+name: Release dev branch (alpha)
+on:
+    push:
+        branches:
+            - dev
+jobs:
+    release:
+        name: Release Dev Branch
+        runs-on: ubuntu-latest
+        env:
+            NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+              with:
+                  fetch-depth: 0
+            - name: Setup Node.js
+              uses: actions/setup-node@v2
+              with:
+                  cache: yarn
+                  node-version: 18.x
+            - name: add .npmrc
+              run: echo '//registry.npmjs.org/:_authToken= ${{ secrets.NPM_TOKEN_READONLY }}' >> .npmrc
+            - name: Install dependencies
+              run: yarn install
+            - name: add publishing .npmrc
+              run: echo '//registry.npmjs.org/:_authToken= ${{ secrets.NPM_TOKEN }}' >> .npmrc
+            - name: Release
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  RELEASE_BRANCH: dev
+                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+              run: yarn run semantic-release

.github/workflows/master-release.yml

@@ -0,0 +1,35 @@
+name: Release master branch
+on:
+    push:
+        branches:
+            - master
+jobs:
+    release:
+        name: Release Master Branch
+        runs-on: ubuntu-latest
+        env:
+            NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+              with:
+                  fetch-depth: 0
+            - name: Setup Node.js
+              uses: actions/setup-node@v1
+              with:
+                  node-version: 18.x
+            - name: add .npmrc
+              run: echo '//registry.npmjs.org/:_authToken= ${{ secrets.NPM_TOKEN_READONLY }}' >> .npmrc
+            - name: Install dependencies
+              run: yarn install
+            - name: Release
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  RELEASE_BRANCH: master
+                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+              run: yarn run semantic-release
+            - name: Rebase dev branch
+              run: |
+                  git checkout dev &&
+                  git rebase master &&
+                  git push origin dev

.gitignore

@@ -46,7 +46,6 @@ build/Release
 # Dependency directories
 node_modules/
 jspm_packages/
-dist/
 
 # TypeScript v1 declaration files
 typings/
@@ -114,4 +113,4 @@ public/
 TODO.md
 
 test_app
-
+yarn.lock

README.md

@@ -5,9 +5,9 @@
 
 # Avalanche Wallet SDK (Beta)
 
-Avalanche wallet SDK is a typescript library for creating and managing decentralized wallets.
+Avalanche Wallet SDK is a Typescript library for creating and managing decentralized wallets.
 
-It provides high level methods to transact on Avalanche's primary networks: X, P and C.
+It provides high level methods to transact on Avalanche's primary networks: X, P and C chain.
 
 Wallet types supported:
 
@@ -44,3 +44,7 @@ or yarn
 ## Webpack
 
 For Webpack version 5 and above you must use this plugin with it. https://www.npmjs.com/package/node-polyfill-webpack-plugin
+
+## Docs
+
+Can generate documentation with `yarn docs` and open `docs/index.html` in a browser.

babel.config.js

@@ -1,14 +1,14 @@
 module.exports = {
-    presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
-    plugins: [
-        [
-            'module-resolver',
-            {
-                root: ['./src'],
-                alias: {
-                    '@': './src',
-                },
-            },
-        ],
-    ],
-};
+  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
+  plugins: [
+      [
+          'module-resolver',
+          {
+              root: ['./src'],
+              alias: {
+                  '@': './src',
+              },
+          },
+      ],
+  ],
+};

dist-esm/Asset/Assets.d.ts

@@ -0,0 +1,7 @@
+import { iAssetDescriptionClean } from '../Asset/types';
+export declare function getAssetDescriptionSync(assetId: string): iAssetDescriptionClean;
+/**
+ * Uses the node api to get meta data given an asset ID. Saves the result to cache.
+ * @param assetId
+ */
+export declare function getAssetDescription(assetId: string): Promise<iAssetDescriptionClean>;