Initial implementation of the Armory SDK #241

Ptroger · 2024-05-02T22:17:21Z

In order to make basic-flow example work in your local, you'll need to:

An engine, a vault and Devtool setuped together and running.
A USER_PRIVATE_KEY in .env, (hex starting with 0x)

You need to replace in examples/basic/src/index.ts

  const config = createArmoryConfig({
    authClientId: '915ed686-ddcd-4018-95f9-69405d2dd740',
    authHost: 'http://localhost:3010',
    authSecret: 'fb46a34690a49c41c6093ada79a14fbefe7e158162ee62da1ebcce47ec893c63d3d015f06de8139e29eb',
    vaultClientId: '4edb675c-3df1-405b-b495-d93229e57b09',
    vaultHost: 'http://localhost:3011',
    vaultSecret: '5014c1a89e2224642ba05217d82cb71d6d07e9edf6d48b57a1c6ac8cce5a8e4b33d4c114f6332824b6ee',
    signer: privateKeyToJwk(UNSAFE_PRIVATE_KEY.Alice)
  })

these values with the correct one you are using.

Also, depending on the EOA you are using to send a transaction (the one you gave the private key in env), you'll need to adjust nonce field of the transactionRequest.

    action: 'signTransaction',
    transactionRequest: {
      from: vaultWalletAddress,
      chainId: 137,
      gas: BigInt(22000),
      to: anotherAddress,
      value: '0x111',
      nonce: 10 <----- This nonce
    },
    resourceId: resourceId(walletId),
    nonce: v4()
  }

This is happening live on polygon, so take care the address you send from and to. You'll need fund to make it work.

wcalderipe

Good job.

I left some comments to kick a conversation.

apps/vault/src/shared/guard/authorization.guard.ts

apps/vault/src/vault/http/rest/controller/import.controller.ts

wcalderipe · 2024-05-03T07:40:59Z

apps/vault/src/vault/http/rest/controller/import.controller.ts

@@ -31,6 +32,7 @@ export class ImportController {
        body.walletId
      )
    } else if (body.privateKey) {
+      console.log('un-encripted private key')


Suggested change

console.log('un-encripted private key')

wcalderipe · 2024-05-03T07:55:58Z

examples/basic/project.json

@@ -0,0 +1,80 @@
+{
+  "name": "basic-flow",


Thanks for adding an example project.

I'm thinking about a better name that describes what it's properly. What do you think armory-sdk-nodejs? I'm adding the runtime in the name of the example because it doesn't solve the problem of using it on the browser.

Remember that the directory structure must reflect the project name (e.g. examples/armory-sdk-nodejs/project.json

Yeah that is actually a very good naming. I tried multiple ones, and gave up with this one as nothing was satisfying.

I did 'basic' because I'm expecting other examples will complexify with time, and this example felt like the most straightforward way to use our system

wcalderipe · 2024-05-03T07:56:21Z

examples/basic/src/index.ts

+const main = async () => {
+  const anotherAddress = '0x3f843E606C79312718477F9bC020F3fC5b7264C2'.toLowerCase() as Hex
+
+  const config = createArmoryConfig({


Why have you changed the naming?

Suggested change

const config = createArmoryConfig({

const config = createArmoryClient({

I'm expecting that we will have an armory client later, that will be instantiated and extends viem clients. It will have other capabilities.
Also, as we integrate with other tools in web3, when they have a client its almost always something that was instantiated with a transport and that has actual broadcasting capabilities. Let's stay on that path, and keep this naming for when we have something with these capabilities

wcalderipe · 2024-05-03T08:12:00Z

packages/armory-sdk/src/lib/sdk.ts

+/**
+ * @param config
+ * @param input
+ * @returns SignatureResponse
+ */


What's the value of a docstring without any text that's exactly like the type signature of the function?

wcalderipe · 2024-05-03T08:13:42Z

packages/armory-sdk/src/lib/utils.ts

+  }
+}
+
+export const buildGnapScopedHeaders = (


What's the goal of this function in the future?

I'm assuming you have a goal because the usage of the word "scope" means something else in an authz flow. Therefore, the implementation and name today are misleading.

'Scoped' here, means that the user that is asking for the transaction, needs to also sign this header. So that the valid AccessToken, that was generated by the engine, will only be valid with this header signed by the user that also wants to perform the transaction.

So yes, it's not about action scopes, but about vault authorization.

I used 'scope' because we kept talking about 'user scoped headers'. Do you have a better idea on the naming ?

wcalderipe · 2024-05-03T08:14:06Z

packages/armory-sdk/src/lib/utils.ts

+    'x-client-id': config.vaultClientId,
+    'x-client-secret': config.vaultSecret


Hint: you can put these into constants and re-use them.

wcalderipe · 2024-05-03T08:15:45Z

packages/armory-sdk/src/lib/utils.ts

+    htm: 'POST',
+    uri,
+    created: new Date().getTime(),
+    ath: hexToBase64Url(hash(accessToken))


Oh wow, I didn't know we had to hash and hex the access token to send it.

wcalderipe · 2024-05-03T08:18:32Z

packages/armory-sdk/src/lib/sdk.ts

+    request: body
+  })
+  return checkDecision(data, config)
+}


Out of curiosity, why this isn't defined in engine.ts?

…nRequest functions

Co-authored-by: William Calderipe <wcalderipe@gmail.com>

* base sdk * config getter * updated lock * working example with sdk * added makefile to sdk * removed unused package * re-installed packages to cleanup lock * remove unused test directory * add one true test * added unit tests on utils, narrowed necessary config for evaluate/signRequest functions * sdk with example for signMessage/Transaction/TypedData working * Update packages/armory-sdk/src/lib/exceptions.ts Co-authored-by: William Calderipe <wcalderipe@gmail.com> * Update packages/armory-sdk/src/lib/exceptions.ts Co-authored-by: William Calderipe <wcalderipe@gmail.com> * Remove console.log * Rename example project to armory-sdk-nodejs --------- Co-authored-by: William Calderipe <wcalderipe@gmail.com>

Ptroger added 9 commits May 2, 2024 17:05

base sdk

cc37b76

config getter

22bd57c

updated lock

5decf21

working example with sdk

fb51d97

added makefile to sdk

861595c

removed unused package

5341487

re-installed packages to cleanup lock

bbd17c9

remove unused test directory

fadfd04

add one true test

db094cb

wcalderipe reviewed May 3, 2024

View reviewed changes

Ptroger and others added 7 commits May 3, 2024 13:30

added unit tests on utils, narrowed necessary config for evaluate/sig…

fcaa9a7

…nRequest functions

sdk with example for signMessage/Transaction/TypedData working

b1303cd

Update packages/armory-sdk/src/lib/exceptions.ts

ca0391a

Co-authored-by: William Calderipe <wcalderipe@gmail.com>

Update packages/armory-sdk/src/lib/exceptions.ts

050cff4

Co-authored-by: William Calderipe <wcalderipe@gmail.com>

Merge branch 'main' into armorySdk/basicTransaction

56bb8cc

Remove console.log

be3eb5c

Rename example project to armory-sdk-nodejs

250a5f0

wcalderipe merged commit 20f6105 into main May 7, 2024
5 checks passed

wcalderipe changed the title ~~base sdk~~ Initial implementation of the Armory SDK May 7, 2024

wcalderipe deleted the armorySdk/basicTransaction branch May 27, 2024 09:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial implementation of the Armory SDK #241

Initial implementation of the Armory SDK #241

Ptroger commented May 2, 2024 •

edited

Loading

wcalderipe left a comment

wcalderipe May 3, 2024

wcalderipe May 3, 2024

Ptroger May 3, 2024

wcalderipe May 3, 2024

Ptroger May 3, 2024

wcalderipe May 3, 2024

wcalderipe May 3, 2024

Ptroger May 3, 2024

wcalderipe May 3, 2024

wcalderipe May 3, 2024

wcalderipe May 3, 2024

	const config = createArmoryConfig({
	const config = createArmoryClient({

		'x-client-id': config.vaultClientId,
		'x-client-secret': config.vaultSecret

Initial implementation of the Armory SDK #241

Initial implementation of the Armory SDK #241

Conversation

Ptroger commented May 2, 2024 • edited Loading

wcalderipe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ptroger commented May 2, 2024 •

edited

Loading