@nexusmutual/sdk 0.0.1

package/.github/workflows/merge-master.yml

@@ -0,0 +1,124 @@
+name: release
+
+on:
+  push:
+    branches:
+      - master
+
+env:
+  NODE_VERSION: '18'
+  CACHE_KEY: ${{ secrets.CACHE_KEY }} # Change to bust caches
+
+jobs:
+  version:
+    runs-on: ubuntu-22.04
+    outputs:
+      local_version: ${{ steps.local_version.outputs.value }}
+      registry_version: ${{ steps.registry_version.outputs.value }}
+    steps:
+      - name: GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Get local version
+        id: local_version
+        run: |
+          version=$(cat ./package.json | jq --raw-output .version)
+          echo $version
+          echo "value=$version" >> $GITHUB_OUTPUT
+
+      - name: Get registry version
+        id: registry_version
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+        run: |
+          package_name="$(cat ./package.json | jq --raw-output .name)"
+          echo $package_name
+          version=$(npm view $package_name version || echo "0.0.0")
+          echo $version
+          echo "value=$version" >> $GITHUB_OUTPUT
+
+      - name: Validate version
+        uses: actions/github-script@v6
+        with:
+          result-encoding: string
+          script: |
+            const local_version = '${{ steps.local_version.outputs.value }}';
+            const registry_version = '${{ steps.registry_version.outputs.value }}';
+            core.info(`Repository version: ${local_version}`);
+            core.info(`Registry version: ${registry_version}`);
+            if (registry_version === local_version) {
+              core.setFailed('Please bump version before merging');
+            }
+
+  build:
+    runs-on: ubuntu-22.04
+    needs: version
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - uses: actions/cache@v3
+        id: cache
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-${{ env.CACHE_KEY }}-${{ hashFiles('package-lock.json') }}
+
+      - name: Install dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: npm i
+
+      - run: npm run build
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: logos-${{ needs.version.outputs.local_version }}
+          path: dist
+
+  publish:
+    runs-on: ubuntu-22.04
+    needs: [version, build]
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          registry-url: 'https://registry.npmjs.org'
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: logos-${{ needs.version.outputs.local_version }}
+          path: dist
+
+      - name: Publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+        run: npm publish --access public
+
+      - name: Create release
+        uses: actions/github-script@v6
+        with:
+          github-token: '${{ github.token }}'
+          script: |
+            try {
+              const response = await github.rest.repos.createRelease({
+                name: "${{ needs.version.outputs.local_version }}",
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                tag_name: "${{ needs.version.outputs.local_version }}",
+                generate_release_notes: true,
+              });
+            } catch (error) {
+              core.setFailed(error.message);
+            }

package/.github/workflows/pull_request.yml

@@ -0,0 +1,62 @@
+name: pull-request
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  NODE_VERSION: "18"
+  CACHE_KEY: ${{ secrets.CACHE_KEY }} # Change to bust caches
+
+jobs:
+  version:
+    runs-on: ubuntu-22.04
+    if: github.base_ref == 'master'
+    outputs:
+      local_version: ${{ steps.local_version.outputs.value }}
+      registry_version: ${{ steps.registry_version.outputs.value }}
+    steps:
+      - name: GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Get local version
+        id: local_version
+        run: |
+          version=$(cat ./package.json | jq --raw-output .version)
+          echo $version
+          echo "value=$version" >> $GITHUB_OUTPUT
+
+      - name: Get registry version
+        id: registry_version
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+        run: |
+          package_name="$(cat ./package.json | jq --raw-output .name)"
+          echo $package_name
+          version=$(npm view $package_name version)
+          echo $version
+          echo "value=$version" >> $GITHUB_OUTPUT
+
+      - name: Validate version
+        uses: actions/github-script@v6
+        with:
+          result-encoding: string
+          script: |
+            const local_version = '${{ steps.local_version.outputs.value }}';
+            const registry_version = '${{ steps.registry_version.outputs.value }}';
+            core.info(`Repository version: ${local_version}`);
+            core.info(`Registry version: ${registry_version}`);
+            if (registry_version === local_version) {
+              core.setFailed('Please bump version before merging');
+            }

package/README.md

@@ -0,0 +1,32 @@
+# Nexus Mutual SDK
+
+## Installation
+
+```bash
+npm install @nexusmutual/sdk
+```
+
+## Usage
+
+This package only exports CommonJS modules. You can import it like this:
+
+```js
+// Usage with ES6 modules
+import products from '@nexusmutual/sdk/products'
+import productTypes from '@nexusmutual/sdk/product-types'
+// logos?
+```
+
+## Nexus Mutual contract addresses and abis
+
+Source of truth for the latest mainnet addresses. Feeds into https://api.nexusmutual.io/sdk/.
+
+## Listed products and product types metadata
+
+The `products` folder contains all protocols listed on Nexus Mutual.
+
+If you're a protocol owner and want to update any details (i.e. logo, website, etc), please submit a PR.
+Logos should meet the following criteria:
+- svg format, with 1:1 ratio
+- no fixed width or height
+- the image should reach the edge of the viewbox