Distribute the SDK through NPM #301

wcalderipe · 2024-06-05T08:29:37Z

This PR adds enough changes to allow us to distribute the Armory SDK through NPM as a standalone artifact bundling the @narval/signature and @narval/policy-engine-shared packages.

Image: just an illustration of what's distributed through the monorepo and NPM (the dependency tree of apps and libs doesn't reflect reality).

Changelog

Updated NX to version 19.
Changed @narval/signature and @narval/policy-engine-shared to buildable projects.
Changed @narval/armory-sdk to a publishable project.
Refactored the tsconfig.json files in the packages. IMPORTANT: The buildable packages MUST have the module property set to commonjs.
Added a CODEOWNERS file with @wcalderipe as the owner of the SDK stack. Since the SDK bundles @narval/signature and @narval/policy-engine-shared, it must include the dependencies of these projects in its package.json. This is not an ideal end state but will work for now.
Minor refactor of the CI build step names.
Added a GitHub action to manually publish packages to NPM through GitHub Packages (the package name is @narval-xyz/armory-sdk). IMPORTANT: it publishes the package with restricted access, meaning projects will be required with an auth token to install it. This must change to public at some point in the future.

Out of Scope

Compiling the SDK to ESM is out of scope. Most applications support CommonJS. If we need to support ESM, we'll have to use Rollup as a bundler (see https://nx.dev/nx-api/rollup/executors/rollup).
Conventional commit adoption (supported by NX release).
Automatic changelog generation (supported by NX release).

Building the SDK

Because we won't publish @narval/signature and @narval/policy-engine-shared through NPM today, we must bundle them as part of the SDK's source code. This is accomplished by setting the external option of the @nx/js:tsc executor to none, meaning "none of the buildable packages from the monorepo should be externalized via NPM".

This whole problem is documented in this issue: nrwl/nx#4620

To get a better view of what's inside the armory-sdk artifact that's published on NPM, click on the expandable section below.

Click to see dist/packages/armory-sdk tree view

dist/packages/armory-sdk
├── package.json
├── packages
│   ├── policy-engine-shared
│   │   └── src
│   │       ├── index.d.ts
│   │       ├── index.js
│   │       ├── index.js.map
│   │       └── lib
│   │           ├── dev.fixture.d.ts
│   │           ├── dev.fixture.js
│   │           ├── dev.fixture.js.map
│   │           ├── schema
│   │           │   ├── address.schema.d.ts
│   │           │   ├── address.schema.js
│   │           │   ├── address.schema.js.map
│   │           │   ├── entity.schema.d.ts
│   │           │   ├── entity.schema.js
│   │           │   ├── entity.schema.js.map
│   │           │   ├── hex.schema.d.ts
│   │           │   ├── hex.schema.js
│   │           │   ├── hex.schema.js.map
│   │           │   ├── policy.schema.d.ts
│   │           │   ├── policy.schema.js
│   │           │   └── policy.schema.js.map
│   │           ├── type
│   │           │   ├── action.type.d.ts
│   │           │   ├── action.type.js
│   │           │   ├── action.type.js.map
│   │           │   ├── client.type.d.ts
│   │           │   ├── client.type.js
│   │           │   ├── client.type.js.map
│   │           │   ├── data-store.type.d.ts
│   │           │   ├── data-store.type.js
│   │           │   ├── data-store.type.js.map
│   │           │   ├── domain.type.d.ts
│   │           │   ├── domain.type.js
│   │           │   ├── domain.type.js.map
│   │           │   ├── engine.type.d.ts
│   │           │   ├── engine.type.js
│   │           │   ├── engine.type.js.map
│   │           │   ├── entity.type.d.ts
│   │           │   ├── entity.type.js
│   │           │   ├── entity.type.js.map
│   │           │   ├── policy.type.d.ts
│   │           │   ├── policy.type.js
│   │           │   └── policy.type.js.map
│   │           └── util
│   │               ├── caip.util.d.ts
│   │               ├── caip.util.js
│   │               ├── caip.util.js.map
│   │               ├── encoding.util.d.ts
│   │               ├── encoding.util.js
│   │               ├── encoding.util.js.map
│   │               ├── entity.util.d.ts
│   │               ├── entity.util.js
│   │               ├── entity.util.js.map
│   │               ├── enum.util.d.ts
│   │               ├── enum.util.js
│   │               ├── enum.util.js.map
│   │               ├── evm.util.d.ts
│   │               ├── evm.util.js
│   │               ├── evm.util.js.map
│   │               ├── json.util.d.ts
│   │               ├── json.util.js
│   │               ├── json.util.js.map
│   │               ├── typeguards.d.ts
│   │               ├── typeguards.js
│   │               └── typeguards.js.map
│   └── signature
│       └── src
│           ├── index.d.ts
│           ├── index.js
│           ├── index.js.map
│           └── lib
│               ├── address.schema.d.ts
│               ├── address.schema.js
│               ├── address.schema.js.map
│               ├── decode.d.ts
│               ├── decode.js
│               ├── decode.js.map
│               ├── encrypt.d.ts
│               ├── encrypt.js
│               ├── encrypt.js.map
│               ├── error.d.ts
│               ├── error.js
│               ├── error.js.map
│               ├── evm.util.d.ts
│               ├── evm.util.js
│               ├── evm.util.js.map
│               ├── hash.d.ts
│               ├── hash.js
│               ├── hash.js.map
│               ├── json.util.d.ts
│               ├── json.util.js
│               ├── json.util.js.map
│               ├── schemas.d.ts
│               ├── schemas.js
│               ├── schemas.js.map
│               ├── sign.d.ts
│               ├── sign.js
│               ├── sign.js.map
│               ├── typeguards.d.ts
│               ├── typeguards.js
│               ├── typeguards.js.map
│               ├── types.d.ts
│               ├── types.js
│               ├── types.js.map
│               ├── utils.d.ts
│               ├── utils.js
│               ├── utils.js.map
│               ├── validate.d.ts
│               ├── validate.js
│               ├── validate.js.map
│               ├── verify.d.ts
│               ├── verify.js
│               └── verify.js.map
├── policy-engine-shared
│   ├── package.json
│   ├── packages
│   │   └── signature
│   │       └── src
│   │           ├── index.d.ts
│   │           ├── index.js
│   │           ├── index.js.map
│   │           └── lib
│   │               ├── address.schema.d.ts
│   │               ├── address.schema.js
│   │               ├── address.schema.js.map
│   │               ├── decode.d.ts
│   │               ├── decode.js
│   │               ├── decode.js.map
│   │               ├── encrypt.d.ts
│   │               ├── encrypt.js
│   │               ├── encrypt.js.map
│   │               ├── error.d.ts
│   │               ├── error.js
│   │               ├── error.js.map
│   │               ├── evm.util.d.ts
│   │               ├── evm.util.js
│   │               ├── evm.util.js.map
│   │               ├── hash.d.ts
│   │               ├── hash.js
│   │               ├── hash.js.map
│   │               ├── json.util.d.ts
│   │               ├── json.util.js
│   │               ├── json.util.js.map
│   │               ├── schemas.d.ts
│   │               ├── schemas.js
│   │               ├── schemas.js.map
│   │               ├── sign.d.ts
│   │               ├── sign.js
│   │               ├── sign.js.map
│   │               ├── typeguards.d.ts
│   │               ├── typeguards.js
│   │               ├── typeguards.js.map
│   │               ├── types.d.ts
│   │               ├── types.js
│   │               ├── types.js.map
│   │               ├── utils.d.ts
│   │               ├── utils.js
│   │               ├── utils.js.map
│   │               ├── validate.d.ts
│   │               ├── validate.js
│   │               ├── validate.js.map
│   │               ├── verify.d.ts
│   │               ├── verify.js
│   │               └── verify.js.map
│   ├── signature
│   │   ├── package.json
│   │   ├── packages
│   │   └── src
│   │       ├── index.d.ts
│   │       ├── index.js
│   │       ├── index.js.map
│   │       └── lib
│   │           ├── __test__
│   │           │   └── unit
│   │           │       ├── mock.d.ts
│   │           │       ├── mock.js
│   │           │       └── mock.js.map
│   │           ├── address.schema.d.ts
│   │           ├── address.schema.js
│   │           ├── address.schema.js.map
│   │           ├── decode.d.ts
│   │           ├── decode.js
│   │           ├── decode.js.map
│   │           ├── encrypt.d.ts
│   │           ├── encrypt.js
│   │           ├── encrypt.js.map
│   │           ├── error.d.ts
│   │           ├── error.js
│   │           ├── error.js.map
│   │           ├── evm.util.d.ts
│   │           ├── evm.util.js
│   │           ├── evm.util.js.map
│   │           ├── hash.d.ts
│   │           ├── hash.js
│   │           ├── hash.js.map
│   │           ├── json.util.d.ts
│   │           ├── json.util.js
│   │           ├── json.util.js.map
│   │           ├── schemas.d.ts
│   │           ├── schemas.js
│   │           ├── schemas.js.map
│   │           ├── sign.d.ts
│   │           ├── sign.js
│   │           ├── sign.js.map
│   │           ├── typeguards.d.ts
│   │           ├── typeguards.js
│   │           ├── typeguards.js.map
│   │           ├── types.d.ts
│   │           ├── types.js
│   │           ├── types.js.map
│   │           ├── utils.d.ts
│   │           ├── utils.js
│   │           ├── utils.js.map
│   │           ├── validate.d.ts
│   │           ├── validate.js
│   │           ├── validate.js.map
│   │           ├── verify.d.ts
│   │           ├── verify.js
│   │           └── verify.js.map
│   └── src
│       ├── index.d.ts
│       ├── index.js
│       ├── index.js.map
│       └── lib
│           ├── dev.fixture.d.ts
│           ├── dev.fixture.js
│           ├── dev.fixture.js.map
│           ├── schema
│           │   ├── address.schema.d.ts
│           │   ├── address.schema.js
│           │   ├── address.schema.js.map
│           │   ├── entity.schema.d.ts
│           │   ├── entity.schema.js
│           │   ├── entity.schema.js.map
│           │   ├── hex.schema.d.ts
│           │   ├── hex.schema.js
│           │   ├── hex.schema.js.map
│           │   ├── policy.schema.d.ts
│           │   ├── policy.schema.js
│           │   └── policy.schema.js.map
│           ├── type
│           │   ├── action.type.d.ts
│           │   ├── action.type.js
│           │   ├── action.type.js.map
│           │   ├── client.type.d.ts
│           │   ├── client.type.js
│           │   ├── client.type.js.map
│           │   ├── data-store.type.d.ts
│           │   ├── data-store.type.js
│           │   ├── data-store.type.js.map
│           │   ├── domain.type.d.ts
│           │   ├── domain.type.js
│           │   ├── domain.type.js.map
│           │   ├── engine.type.d.ts
│           │   ├── engine.type.js
│           │   ├── engine.type.js.map
│           │   ├── entity.type.d.ts
│           │   ├── entity.type.js
│           │   ├── entity.type.js.map
│           │   ├── policy.type.d.ts
│           │   ├── policy.type.js
│           │   └── policy.type.js.map
│           └── util
│               ├── caip.util.d.ts
│               ├── caip.util.js
│               ├── caip.util.js.map
│               ├── encoding.util.d.ts
│               ├── encoding.util.js
│               ├── encoding.util.js.map
│               ├── entity.util.d.ts
│               ├── entity.util.js
│               ├── entity.util.js.map
│               ├── enum.util.d.ts
│               ├── enum.util.js
│               ├── enum.util.js.map
│               ├── evm.util.d.ts
│               ├── evm.util.js
│               ├── evm.util.js.map
│               ├── json.util.d.ts
│               ├── json.util.js
│               ├── json.util.js.map
│               ├── typeguards.d.ts
│               ├── typeguards.js
│               └── typeguards.js.map
├── signature
│   ├── package.json
│   ├── packages
│   └── src
│       ├── index.d.ts
│       ├── index.js
│       ├── index.js.map
│       └── lib
│           ├── __test__
│           │   └── unit
│           │       ├── mock.d.ts
│           │       ├── mock.js
│           │       └── mock.js.map
│           ├── address.schema.d.ts
│           ├── address.schema.js
│           ├── address.schema.js.map
│           ├── decode.d.ts
│           ├── decode.js
│           ├── decode.js.map
│           ├── encrypt.d.ts
│           ├── encrypt.js
│           ├── encrypt.js.map
│           ├── error.d.ts
│           ├── error.js
│           ├── error.js.map
│           ├── evm.util.d.ts
│           ├── evm.util.js
│           ├── evm.util.js.map
│           ├── hash.d.ts
│           ├── hash.js
│           ├── hash.js.map
│           ├── json.util.d.ts
│           ├── json.util.js
│           ├── json.util.js.map
│           ├── schemas.d.ts
│           ├── schemas.js
│           ├── schemas.js.map
│           ├── sign.d.ts
│           ├── sign.js
│           ├── sign.js.map
│           ├── typeguards.d.ts
│           ├── typeguards.js
│           ├── typeguards.js.map
│           ├── types.d.ts
│           ├── types.js
│           ├── types.js.map
│           ├── utils.d.ts
│           ├── utils.js
│           ├── utils.js.map
│           ├── validate.d.ts
│           ├── validate.js
│           ├── validate.js.map
│           ├── verify.d.ts
│           ├── verify.js
│           └── verify.js.map
└── src
    ├── index.d.ts
    ├── index.js
    ├── index.js.map
    └── lib
        ├── __test__
        │   └── unit
        │       ├── mock.d.ts
        │       ├── mock.js
        │       └── mock.js.map
        ├── constants.d.ts
        ├── constants.js
        ├── constants.js.map
        ├── domain.d.ts
        ├── domain.js
        ├── domain.js.map
        ├── exceptions.d.ts
        ├── exceptions.js
        ├── exceptions.js.map
        ├── http
        │   ├── armory.d.ts
        │   ├── armory.js
        │   ├── armory.js.map
        │   ├── data-store.d.ts
        │   ├── data-store.js
        │   ├── data-store.js.map
        │   ├── policy-engine.d.ts
        │   ├── policy-engine.js
        │   ├── policy-engine.js.map
        │   ├── vault.d.ts
        │   ├── vault.js
        │   └── vault.js.map
        ├── schema.d.ts
        ├── schema.js
        ├── schema.js.map
        ├── sdk.d.ts
        ├── sdk.js
        ├── sdk.js.map
        ├── types
        │   ├── armory.d.ts
        │   ├── armory.js
        │   ├── armory.js.map
        │   ├── index.d.ts
        │   ├── index.js
        │   ├── index.js.map
        │   ├── policy-engine.d.ts
        │   ├── policy-engine.js
        │   ├── policy-engine.js.map
        │   ├── vault.d.ts
        │   ├── vault.js
        │   └── vault.js.map
        ├── utils.d.ts
        ├── utils.js
        └── utils.js.map

Reference

linear · 2024-06-05T08:29:39Z

NAR-1609 Distribute the Armory SDK via NPM

Context

We're looking into publishing the SDK on NPM so third-party applications outside the monorepo can use it. However, we don't want to lose the local development experience of simply importing the latest state of the library directly, rather than having to import it via NPM ourselves.

image.png

In the diagram above, the developer imports a specific version of the SDK (e.g., 1.1.51) through NPM, while the applications within the monorepo will always import the latest version of the SDK.

Problems

✅ How do we maintain the same developer experience locally of importing libraries via NX's workspace?
- ✅ We don't want to go through NPM to develop libraries within the monorepo.
✅ How do we publish a library to NPM?
How do we build a library including all its dependencies from the main package.json, plus bundling any dependencies on other internal libraries' code?
How to manually publish to NPM from GitHub actions?

Needs validation

Is it possible to have a publishable library while continuing to import it using TypeScript's paths in the workspace?

Notes

Buildable libraries cannot import or export from non-buildable libraries nx/enforce-module-boundaries
- It means if armory-sdk becomes a publishable library, everything it imports like policy-engine-shared must become a buildable library.
When generating a publishable library, NX adds the import path of the library in the TS' path. It means locally the experience stays the same and we don't have to go through NPM.
- The import path is a valid NPM package. In Narval's case is something like narval-xyz/<package-name>
Solving each problem
- How do we publish a library to NPM?
  - Publish a pacakge from the monorepo to NPM, import it in another application.
For npm publish to work, the .npmrc containing the GitHub token MUST be in the package's root not the monorepo's.
- Maybe NX has an executor to solve that problem.
By default, the publishable package is private. It means, the application importing it through NPM also needs the GitHub token.
A buildable library has two important properties required by a publishable library to build.
- A build target in the project.json
- A package.json in the library's root
ngx-deploy-npm is a great tool
Auto version generation, do we need to solve it now? https://github.com/jscutlery/semver
Publishable libraries MUST include the tslib as part of their dependencies
⚠️ IMPORTANT: to make the nx/js:tsc build of a publishable library to bundle buildable libraries code with it, you MUST set the option external to none in the library's project.json
You can use nx g nx/js:setup-build to make a project buildable.

npx nx build <project>
cd <project>
npm publish

Side quest

How to sync dependencies' version from the main package.json to the ones in publishable libraries?
- Problem: since publishable libraries MUST have their own package.json used when we distribute it via npm, there's a chance of that getting out of date.

Reference

RFC 032: ArmorySDK

https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry

https://nx.dev/concepts/buildable-and-publishable-libraries

https://www.npmjs.com/package/altack/nx-bundlefy

https://github.com/bikecoders/ngx-deploy-npm

https://github.com/nrwl/nx-incremental-large-repo

Packaging TypeScript Libraries - The Right Way!

IMPORTANT: Because the SDK bundles the signature and the policy engine shared libraries, it MUST include its peer dependencies in its own `package.json`. This is not ideal because peer dependencies lose their autonomy to manage their own dependencies.

package.json

wcalderipe · 2024-06-05T16:19:26Z

packages/armory-sdk/package.json

  "dependencies": {
    "axios": "^1.6.7",
    "tslib": "^2.3.0",
    "uuid": "^9.0.1",
    "viem": "^2.7.16",
-    "zod": "^3.22.4"
+    "zod": "^3.22.4",
+    "lodash": "^4.17.21",
+    "@noble/curves": "1.4.0",
+    "jose": "^5.2.2"


Because the armory-sdk bundles the signature and policy-engine-shared, its package.json MUST contain the other libraries' dependencies.

wcalderipe · 2024-06-05T16:20:57Z

packages/armory-sdk/project.json

+      "executor": "ngx-deploy-npm:deploy",
+      "options": {
+        "distFolderPath": "dist/packages/armory-sdk",
+        "access": "restricted"


Keep it restricted for now.

IMPORTANT: You'll need a .npmrc with a valid token to install the library in another project. You can use the updated version of the file in our 1password.

wcalderipe · 2024-06-05T16:23:03Z

packages/policy-engine-shared/project.json

+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/policy-engine-shared",
+        "main": "packages/policy-engine-shared/src/index.ts",
+        "tsConfig": "packages/policy-engine-shared/tsconfig.lib.json",
+        "assets": [],
+        "external": "none"
+      }
+    },


A publishable library MUST only depend on buildable libraries. Since the armory-sdk depends on the policy-engine-shared and signature, we have to add a build target on them.

Hint: you can use npx nx g @nx/js:setup-build to turn a given library into buildable.

wcalderipe · 2024-06-05T16:23:11Z

packages/signature/project.json

@@ -4,6 +4,17 @@
  "sourceRoot": "packages/signature/src",
  "projectType": "library",
  "targets": {
+    "build": {


Same as above.

wcalderipe · 2024-06-05T16:46:26Z

packages/armory-sdk/project.json

+        "main": "packages/armory-sdk/src/index.ts",
+        "tsConfig": "packages/armory-sdk/tsconfig.lib.json",
+        "assets": [],
+        "external": "none"


This option tells NX to bundle buildable packages in a single artifact. Here it's set to "none" meaning every buildable package will be included. However, it can be set as an array of packages like ["@narval/signature"] for more granular control.

tsconfig.base.json

Clean up tsconfig files.

Send a notification on either success or failure.

Disable changelog file.

* Update Vault Image Version to e654acd * Update policy-engine Image Version to e654acd * Update Armory Image Version to 156a15a * Require admin API key to manage clients in the Armory (#286) * Update Armory Image Version to 30f4cf5 * Feature/nar 1647 devtool improvement (#290) * Update Vault Image Version to ebe09f1 * Update policy-engine Image Version to ebe09f1 * added vault setup to 'make setup' command, update log (#292) * fix test (#293) * Update Armory Image Version to 79ef401 * Add app provision on module init (#291) * Update Armory Image Version to e57f9b9 * move onboarding functions to SDK (#295) * Update Armory Image Version to 2075a0d * Update policy-engine Image Version to 2075a0d * Update Vault Image Version to 2075a0d * Feature/nar 1651 devtool (#296) * Update Vault Image Version to 2c723f9 * Update Armory Image Version to 2c723f9 * Update policy-engine Image Version to 2c723f9 * Feature/nar 1645 add collection and clientid fields to keyvalue model (#289) * mnemonic generation and key derivation from mnemonic * backup stored mnemonics * added e2e test * logs * repared failing test after Wallet type modification * fixed linting * revised unit test * Unit tests on util, switched table storage for unencrypted KV storage * switch dto declaration to zod * schema and naming changes * switched url to plural * import persistence module and not prisma service * backup has to be rsa key on schema * create-client-dto use zod, use PublicWallet.parse instead of custom func * removed function * removed unnecessary constructor for DTO * remove code duplication in importService * migration + some logic * modified repos to set metadatas * fixed wallet test * breaking migration * added tests * Update Vault Image Version to d886cbe * SDK - Encrypt Imports + Vault keygen & derivation (#299) * Update Vault Image Version to 10b7a58 * Update Armory Image Version to 10b7a58 * Update policy-engine Image Version to 10b7a58 * Feature/nar 1606 vault list wallets (#297) * mnemonic generation and key derivation from mnemonic * backup stored mnemonics * added e2e test * logs * repared failing test after Wallet type modification * fixed linting * revised unit test * Unit tests on util, switched table storage for unencrypted KV storage * switch dto declaration to zod * schema and naming changes * switched url to plural * import persistence module and not prisma service * backup has to be rsa key on schema * create-client-dto use zod, use PublicWallet.parse instead of custom func * removed function * removed unnecessary constructor for DTO * remove code duplication in importService * migration + some logic * modified repos to set metadatas * fixed wallet test * breaking migration * added tests * e2e test to generate and list wallets * fixed expected nextaddres * fixed e2e test * Update Vault Image Version to 2a9398e * deleting extra chart directory * Updating Policy Engine helm chart for MPC cluster * Update Vault Image Version to 1273d01 * Update Armory Image Version to 1273d01 * Update policy-engine Image Version to 1273d01 * Changing Armory APP_ID env to APP_UID to be consistent with rest of stack * Update Armory Image Version to 53e52e4 * Engine TSM_API_KEY should be optional env * Hotfix devtool importing removed value * Update policy-engine Image Version to 3b1457d * Renaming armory admin_api_key env to match the rest of the stack * Fixing provision; should set adminApiKey if it does not exist * Update Armory Image Version to 02894b1 * Attempting correct service naming to match argocd app config * provision withMasterKey fix * Fixing provision in Armory; appRespository.save should upsert * Update Vault Image Version to 75b293b * Update policy-engine Image Version to 75b293b * Update Armory Image Version to 441d048 * Feature/nar 1652 devtool encrypt imports vault keygen derivation (#300) * Update Vault Image Version to 2867faa * Update Armory Image Version to 2867faa * Update policy-engine Image Version to 2867faa * Refactor devtool for staging env (#302) * Update policy-engine Image Version to 195b4a3 * Update Vault Image Version to 195b4a3 * Update Armory Image Version to 195b4a3 * Feature/nar 1656 refactor devtool to support staging env (#303) * Update policy-engine Image Version to ecaed98 * Update Armory Image Version to ecaed98 * Update Vault Image Version to ecaed98 * Fix bug when signing DS (#306) * Distribute the SDK through NPM (#301) * Update Armory Image Version to 6c45789 * Update Vault Image Version to 6c45789 * chore(release): publish 0.0.2 * chore(release): publish 0.0.3 * Revert release commits from main (#311) * Revert "chore(release): publish 0.0.2" This reverts commit c6be407. * Revert "chore(release): publish 0.0.3" This reverts commit c39a31b. * Fix SDK version * Update Vault Image Version to 06e52fe * Update Armory Image Version to 06e52fe * Update policy-engine Image Version to 06e52fe * Fix publishable packages NX release projectRoot (#313) * chore(release): publish 0.0.2 * Fix NX release project root * Update Vault Image Version to 0547a82 * Update policy-engine Image Version to 0547a82 * Update Armory Image Version to 0547a82 * Include the SDK README in the release (#314) * Add README in the SDK release * Delete SDK changelog file * Bump SDK to 0.0.3 * Update Armory Image Version to ba8ece5 * Update Vault Image Version to ba8ece5 * Update policy-engine Image Version to ba8ece5 * Expose a /sync endpoint in Armory (#307) * Update Vault Image Version to a68e8eb * Update Armory Image Version to a68e8eb * Update policy-engine Image Version to a68e8eb * Fix SDK release assets (#315) * Delete transaction engine template module (#316) * Delete transaction engine module * Remove references from package-lock.json * Update policy-engine Image Version to 01f8f3d * Update Armory Image Version to 01f8f3d * Update Armory Image Version to 8bb8967 * Update policy-engine Image Version to 8bb8967 * Ensure GitHub actions are using the same Node.js version and NPM cache (#318) * Update policy-engine Image Version to a4bce48 * Update Vault Image Version to a4bce48 * Update Armory Image Version to a4bce48 * Bump supertest from 6.3.4 to 7.0.0 (#275) Bumps [supertest](https://github.com/ladjs/supertest) from 6.3.4 to 7.0.0. - [Release notes](https://github.com/ladjs/supertest/releases) - [Commits](ladjs/supertest@v6.3.4...v7.0.0) --- updated-dependencies: - dependency-name: supertest dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: William Calderipe <[email protected]> * Bump @nestjs/axios from 3.0.1 to 3.0.2 (#276) Bumps [@nestjs/axios](https://github.com/nestjs/axios) from 3.0.1 to 3.0.2. - [Release notes](https://github.com/nestjs/axios/releases) - [Changelog](https://github.com/nestjs/axios/blob/master/.release-it.json) - [Commits](nestjs/axios@3.0.1...3.0.2) --- updated-dependencies: - dependency-name: "@nestjs/axios" dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: William Calderipe <[email protected]> * Update Vault Image Version to 1998b02 * Update Armory Image Version to 1998b02 * Update policy-engine Image Version to 1998b02 * Bump @docusaurus/tsconfig from 3.0.0 to 3.4.0 (#298) Bumps [@docusaurus/tsconfig](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-tsconfig) from 3.0.0 to 3.4.0. - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.4.0/packages/docusaurus-tsconfig) --- updated-dependencies: - dependency-name: "@docusaurus/tsconfig" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: William Calderipe <[email protected]> * Bump jose from 5.2.2 to 5.4.0 (#309) Bumps [jose](https://github.com/panva/jose) from 5.2.2 to 5.4.0. - [Release notes](https://github.com/panva/jose/releases) - [Changelog](https://github.com/panva/jose/blob/main/CHANGELOG.md) - [Commits](panva/jose@v5.2.2...v5.4.0) --- updated-dependencies: - dependency-name: jose dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: William Calderipe <[email protected]> * Update Vault Image Version to 3c4278b * Update Vault Image Version to d37e3f1 * Update Armory Image Version to 3c4278b * Update Armory Image Version to d37e3f1 * Update policy-engine Image Version to d37e3f1 * Update policy-engine Image Version to 3c4278b * removed nextAddrIndex, added utils and tests (#312) * removed nextAddrIndex, added utils and tests * naming and removed unused functionality * Update Armory Image Version to 15e394a * Update policy-engine Image Version to 15e394a * implicit undefined doesn't compile (#320) * Update Vault Image Version to 8fd5a89 * Feature/nar 1665 armory add client secret (#319) * Update Vault Image Version to 8e71293 * Update Armory Image Version to 8e71293 * Update policy-engine Image Version to 8e71293 * Add Swagger documentation in the vault controllers (#325) * Add Swagger documentation in the vault controllers * Add mandatory headers * Refactor permissions decorator * Update policy-engine Image Version to e66d656 * Update Vault Image Version to e66d656 * Update Armory Image Version to e66d656 * update response when syncing engine (#326) * Update Vault Image Version to b26cdd3 * Update Armory Image Version to b26cdd3 * Update policy-engine Image Version to b26cdd3 * Add missing Swagger documentation in the PE controllers (#327) * Document PE controllers * Fix client guard * Update Vault Image Version to ef510cf * Update Armory Image Version to ef510cf * Fix SDK unit tests and PE sync response (#328) * Fix wrong import * Fix sync DTO Refactor for simplicity * Fix Armory cluster integration tests * Update Armory Image Version to d09cba3 * Update Vault Image Version to d09cba3 * Update policy-engine Image Version to d09cba3 * dependabot private regisry update * dependabot private regisry update #2 * Bump tslib from 2.6.2 to 2.6.3 (#324) Bumps [tslib](https://github.com/Microsoft/tslib) from 2.6.2 to 2.6.3. - [Release notes](https://github.com/Microsoft/tslib/releases) - [Commits](microsoft/tslib@v2.6.2...v2.6.3) --- updated-dependencies: - dependency-name: tslib dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update Vault Image Version to 7598fb0 * Update Armory Image Version to 7598fb0 * Update policy-engine Image Version to 7598fb0 * revert dependabot.yml registry change for now * check existing keyId before inserting mnemonic (#317) * check existing keyId before inserting mnemonic * move integrity check in service * removed unit test on removed feature * Update policy-engine Image Version to 0293daf * Update Vault Image Version to 0293daf * Update Armory Image Version to 0293daf * Making chain required in tx request * Version bumps from dependabot; bypassing pipeline issue w/ private repo (#331) * Update Armory Image Version to 4315d32 * Update policy-engine Image Version to 4315d32 * Adding noop provider for vault * Update Vault Image Version to 9ae6b94 * Modify Armory to improve generated HTTP clients (#333) * Modify controllers and schemas to improve generated HTTP client * Remove unused example config * Refactor managed data store API scheme Prevent cluster service to throw when a node failed to sync * Change client API tag * Rephrase the AssetId TODO comment * Fix data store client * Revert viem bump * update package-loc * Update Armory Image Version to dc235f3 * Update Vault Image Version to dc235f3 * Update policy-engine Image Version to dc235f3 * Fix package-lock.json (#335) * Switch font awesome to free (#337) * Update Armory Image Version to 8dbe49d * Update Vault Image Version to 8dbe49d * Update policy-engine Image Version to 8dbe49d * set default client issuer in the db (#339) * Update Vault Image Version to 0600c09 * fix policy engine unit tests (#340) * Update policy-engine Image Version to 83bc7a9 * Feature/nar 1672 vault refactor (#334) * renamed wallet and wallets to _OLD_WALLET_ and _OLD_WALLETS_ * renamed mnemonic collection/repository to root-key * readme changes * format and readme change * fixed conflict * renamed wallets to accounts * renamed api and controllers * change rootKey schema to have keyType and curve properties * removed unused curve and moved types to correct file * format * updated readme * Update Vault Image Version to 4b02e95 * Update Armory Image Version to 4b02e95 * Update policy-engine Image Version to 4b02e95 * new endpoint to list wallets (#342) * new endpoint to list wallets * revised naming for Wallet and added guard on endpoint * Update Vault Image Version to 199b106 * fixed naming on devtool (#344) * fixed naming on devtool * generatedKey singular in playground * Fixes to be more explicit on spending limits (#341) * Update policy-engine Image Version to 1eab535 * CI to update platform repo helm chart * CI to update platform repo helm chart - 2 * Update Vault Image Version to 4647e28 * update branch name * Update Vault Image Version to 9add0b7 * Adding repo in app token * Update Vault Image Version to 690919d * Pull out helm update action * Update Vault Image Version to 852bba8 * Fix vars & secrets in composite action * Update Vault Image Version to 4b15deb * Update Armory Image Version to 4b15deb * Update policy-engine Image Version to 4b15deb * Removing extra action steps * Removing helm charts; moving to platform repo * Fix devtool following refactor from wallet to account (#351) * Adding vault-prod workflow * Feature/nar 1646 support client issuer in the access token (#343) * Updating non-prod to re-build when prod workflow changes * Removing tags from triggering test workflow * Updating registry config for prod * trigger vault workflow * Adding branch match back to vault workflow * syntax * Adding prod action workflows for Armory and Engine * Remove remeda and playwright deps that are unused (#353) * Remove remeda and playwright deps that are unused * fixing actions wildcard match * Armory e2e test over client secret hashing behavior * Auth and Data Store SDK (#336) * Custom path derivation doesn't derive one too many account (#357) * Fix new sdk types in devtool (#358) * Wallet -> Account in armory and engine (#356) * renamed wallet entities into accounts * removed console statement * renamed fixtures and WALLET classification into VAULT * renamed fixtures in vault and devtool * vault format * rego permissions on wallet not account * fix viem link in comments * Revert "Fix new sdk types in devtool (#358)" This reverts commit 56caa6f. * Revert "Revert "Fix new sdk types in devtool (#358)"" This reverts commit b84f048. * Revert "Wallet -> Account in armory and engine (#356)" This reverts commit 8bdd845. * Add random secret data api key to access data store (#350) * Add retry data store sync on armory boot (#354) * Rename wallet -> account in engine and data store, regenerate sdk clients (#360) * renamed wallet entities into accounts * removed console statement * renamed fixtures and WALLET classification into VAULT * renamed fixtures in vault and devtool * vault format * rego permissions on wallet not account * fix viem link in comments * re-generated client * Vault SDK (#359) * Removing non-mpc engine from prod release * trigger workflow when prod workflow changes * supports pem import for backup keys (#368) * supports pem import for backup keys * fixed devtool account/wallet generation/import * removed console.log * bump viem and re-added the signatureToHex function (#371) * fixed signing service and added a test (#372) * Use new SDK in the Devtool (#362) * Add client id guard to auth request endpoints (#361) * Fix bug on duplicated approvals (#363) * Add MPL 2.0 license (#373) * Add MPL 2.0 license * Update package.json license to MPL-2.0 * Feature/nar 1709 rsapubkeytohex throws (#374) * add unit test for rsaPublicKeyToHex * add browser implementation for rsaPubKeyToHex function * removed polyfill from devtool * cleaned up unit.spec file * fix usage of PEM --> JWK converter in devtool * Add LICENSES_DISCLOSURE.md (#377) * Update README (#378) Update logo. Remove projects section. Add a "what" section. * Cleanup package.json (#370) * Bump prisma from 5.8.1 to 5.16.1 (#379) Bumps [prisma](https://github.com/prisma/prisma/tree/HEAD/packages/cli) from 5.8.1 to 5.16.1. - [Release notes](https://github.com/prisma/prisma/releases) - [Commits](https://github.com/prisma/prisma/commits/5.16.1/packages/cli) --- updated-dependencies: - dependency-name: prisma dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump @docusaurus/core from 3.1.1 to 3.4.0 (#367) Bumps [@docusaurus/core](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus) from 3.1.1 to 3.4.0. - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.4.0/packages/docusaurus) --- updated-dependencies: - dependency-name: "@docusaurus/core" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump @nestjs/swagger from 7.2.0 to 7.3.1 (#349) Bumps [@nestjs/swagger](https://github.com/nestjs/swagger) from 7.2.0 to 7.3.1. - [Release notes](https://github.com/nestjs/swagger/releases) - [Changelog](https://github.com/nestjs/swagger/blob/master/.release-it.json) - [Commits](nestjs/swagger@7.2.0...7.3.1) --- updated-dependencies: - dependency-name: "@nestjs/swagger" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump usehooks-ts from 3.0.2 to 3.1.0 (#364) Bumps [usehooks-ts](https://github.com/juliencrn/usehooks-ts) from 3.0.2 to 3.1.0. - [Release notes](https://github.com/juliencrn/usehooks-ts/releases) - [Commits](https://github.com/juliencrn/usehooks-ts/compare/[email protected]@3.1.0) --- updated-dependencies: - dependency-name: usehooks-ts dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump @swc/core from 1.5.7 to 1.6.5 (#366) Bumps [@swc/core](https://github.com/swc-project/swc) from 1.5.7 to 1.6.5. - [Release notes](https://github.com/swc-project/swc/releases) - [Changelog](https://github.com/swc-project/swc/blob/main/CHANGELOG.md) - [Commits](swc-project/swc@v1.5.7...v1.6.5) --- updated-dependencies: - dependency-name: "@swc/core" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fix bug when polling auth req after creation (#381) * Replace @sepior/tsmsdkv2 by a @narval-xyz/blockdaemon-tsm (#376) * Replace @sepior/tsmsdkv2 by a wrapper package * Load Blockdaemon dependency on demand * Use BlockdaemonTsmService * Delete tsmsdkv2 types * Update package-lock.json * Minor updates in docker-compose Rename a few make targets and update the README. Re-generate package-lock.json * Check PSQL container healthy before start others * Update NPM section in the README * Release SDK version 0.0.4 (#384) * Bump SDK to 0.0.4 * Order the README sections It brings the most important sections to the top. * Update package-lock.json * Remove Bullboard from Prod (#382) * Add spending limit for fixed period. Daily, monthly and yearly basis. (#385) * Feature/nar 1734 add rate limit policy criteria + add transfer destinations filter (#391) * added signRaw support in auth server (#392) * added signRaw support in auth server * added e2e test for raw signing * SDK proxy internal packages (#393) * Proxy signature and policy-engine-shared through the SDK * Bump package.json version * Feature/nar 1689 api versioning (#380) * created withVersionning to shared/nest * every controller at version 1 * fixed tests with prefix * renamed version helper * format * saved exported util * updated armory-sdk version * Revert "updated armory-sdk version" This reverts commit cd32d55. * updated sdk-version (#394) * updated version * ran npm install * user operation being processed * e2e script working * added test to vault userOp signing * new tests lints and readme * serializedEvalRequest in test * corrected some tests * removed nested packages and linted * changed userOperation v6 to take a number chainId * read/create type are serialized unserialized for user operation * use fixtures for e2e test --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Samuel <[email protected]> Co-authored-by: Ptroger <[email protected]> Co-authored-by: Matt Schoch <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Pierre Troger <[email protected]>

wcalderipe added 2 commits June 5, 2024 10:24

Fix package.json workspace

b0fd5aa

Turn SDK, signature, and policy engine shared into buildable packages

c08d60b

wcalderipe self-assigned this Jun 5, 2024

wcalderipe commented Jun 5, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

wcalderipe commented Jun 5, 2024

View reviewed changes

tsconfig.base.json Outdated Show resolved Hide resolved

wcalderipe added 18 commits June 5, 2024 19:03

Revert armory-sdk TS path

8b7fb59

Ensure buildable libraries use module CJS

1252551

Clean up tsconfig files.

chore(release): publish 0.0.2

2190b58

Update package-lock.json

37e61a4

Add releasable projects in nx.json

321a0b4

Fix lint issues

9fe7c56

Fix client create

c3664a4

Rename CI step from buildpush to release

b18d4d7

Attempt of manual workflow to publish packages

5ec1cf4

Walk around manual dispatch dependency on main

522d6a9

Uncomment a few steps of the pipeline

976e548

Add step to create .npmrc

ce7d714

Add publish step

1877593

chore(release): publish 0.0.3

4caaf00

chore(release): publish 0.0.4

7e13d7e

Update package-lock.json

3f422ae

Point NPM to GitHub

a842ccb

Set provenance to false while pkg is restricted

1021eec

wcalderipe added 8 commits June 7, 2024 09:50

Trigger the package release workflow manually

04bd6dc

Send a notification on either success or failure.

Document release process in the README

afc6357

Fix section link

fb862a9

Disable automatic versioning

e3e1407

Disable changelog file.

Change SDK version to 0.0.0

3ca08d3

chore(release): publish 0.0.1

464dd72

Update package-lock.json

f39cdb7

Add CODEOWNERS file

d1fd9c1

wcalderipe marked this pull request as ready for review June 7, 2024 09:37

wcalderipe changed the title ~~Distribute the SDK via NPM~~ Distribute the SDK through NPM Jun 7, 2024

wcalderipe merged commit 6c45789 into main Jun 7, 2024

This was referenced Jun 7, 2024

Fix publishable packages NX release projectRoot #313

Merged

Bumping nx to version 19 & updating project to crystal migration #251

Closed

mattschoch pushed a commit that referenced this pull request Jun 19, 2024

Distribute the SDK through NPM (#301)

9949387

wcalderipe added a commit that referenced this pull request Jul 5, 2024

Distribute the SDK through NPM (#301)

96c7044

wcalderipe deleted the feature/nar-1609-distribute-via-npm branch July 5, 2024 09:08

wcalderipe mentioned this pull request Jul 16, 2024

SDK import by module #431

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Distribute the SDK through NPM #301

Distribute the SDK through NPM #301

wcalderipe commented Jun 5, 2024 •

edited

Loading

linear bot commented Jun 5, 2024

Context

Problems

Needs validation

Notes

Side quest

Reference

wcalderipe Jun 5, 2024

wcalderipe Jun 5, 2024

wcalderipe Jun 5, 2024

wcalderipe Jun 5, 2024

wcalderipe Jun 5, 2024

Distribute the SDK through NPM #301

Distribute the SDK through NPM #301

Conversation

wcalderipe commented Jun 5, 2024 • edited Loading

Changelog

Out of Scope

Building the SDK

Reference

linear bot commented Jun 5, 2024

Context

Problems

Needs validation

Notes

Side quest

Reference

wcalderipe Jun 5, 2024

Choose a reason for hiding this comment

wcalderipe Jun 5, 2024

Choose a reason for hiding this comment

wcalderipe Jun 5, 2024

Choose a reason for hiding this comment

wcalderipe Jun 5, 2024

Choose a reason for hiding this comment

wcalderipe Jun 5, 2024

Choose a reason for hiding this comment

wcalderipe commented Jun 5, 2024 •

edited

Loading