@cubist-labs/cubesigner-sdk 0.1.23

package/LICENSE-APACHE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/LICENSE-MIT

@@ -0,0 +1,25 @@
+Copyright (C) 2022-2023 Cubist, Inc.
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

package/NOTICE

@@ -0,0 +1,13 @@
+Copyright (C) 2023 Cubist, Inc.
+
+This software is licensed under either of
+
+- Apache License, Version 2.0
+  (see https://www.apache.org/licenses/LICENSE-2.0 or LICENSE-APACHE)
+
+- MIT license
+  (see https://opensource.org/licenses/MIT or LICENSE-MIT)
+  
+at your option.
+
+The SPDX identifier for this project is "MIT OR Apache-2.0".

package/README.md

@@ -0,0 +1,470 @@
+# CubeSigner TypeScript SDK
+
+CubeSigner is a hardware-backed, non-custodial key management platform
+built by Cubist for programmatically managing cryptographic keys.
+
+This repository is our SDK written in TypeScript for programmatically
+interacting with CubeSigner services.
+
+## Installing the SDK
+
+You can install the SDK from npm, or from GitHub:
+
+```bash
+npm install --save "@cubist-labs/cubesigner-sdk" "github:cubist-labs/CubeSigner-TypeScript-SDK"
+```
+
+## Logging into CubeSigner
+
+Before running the "getting started" examples below (or tests later), you must
+log into your CubeSigner organization using the `cs` command-line tool, e.g.,
+
+```bash
+cs login owner@example.com --env '<gamma|prod|...>'
+```
+
+## Getting started
+
+In this section we are going to walk through a simple CubeSigner
+setup. We'll create a signing key, then sign some EVM
+transactions, and then add a security policy to restrict the kinds of
+transactions that CubeSigner is allowed to sign.
+
+To start, we'll instantiate the top-level `CubeSigner` class from an
+existing CubeSigner management session already stored on disk
+(remember, you must already be logged in).
+
+Let's also assume that the following imports are available to all the
+examples below.
+
+```typescript
+import * as cs from "@cubist-labs/cubesigner-sdk";
+import assert from "assert";
+```
+
+### Instantiate `CubeSigner`
+
+The first order of business is to create an instance of `CubeSigner`.
+We can do that by simply loading the management session token from the
+default location on disk (which is where the `cs login` command saves
+it):
+
+```typescript
+const cubesigner = await cs.CubeSigner.loadManagementSession();
+```
+
+Alternatively, a `CubeSigner` instance can be created by explicitly providing a
+session manager:
+
+```typescript
+// Load session from a JSON file
+const fileStorage = new cs.JsonFileSessionStorage<cs.ManagementSessionInfo>(
+  `${process.env.HOME}/.config/cubesigner/management-session.json`,
+);
+// Create a session manager for a management token
+const sessionMgr = await cs.ManagementSessionManager.loadFromStorage(fileStorage);
+new cs.CubeSigner({
+  sessionMgr,
+});
+```
+
+### Get `User` and `Org` info
+
+We can now obtain some information about the logged-in user and the
+organization the user belongs to:
+
+```typescript
+const me = await cubesigner.aboutMe();
+console.log(me);
+assert(me.user_id); // each user has a globally unique ID
+assert(me.org_ids); // IDs of all organizations this user is a member of
+assert(me.org_ids.length > 0); // assume that the user is a member of at least one org
+
+const org = await cubesigner.getOrg(me.org_ids[0]);
+assert(await org.enabled()); // assume that the org is enabled
+```
+
+There is a lot more to do with an organization, like creating/listing
+keys, creating/listing roles, setting up org-wide security policies,
+etc.
+
+For the rest of this tutorial, we assume the logged-in user is a
+member of at least one organization.
+
+### Create a `Key`
+
+Next, let's create a key that we'll later use to sign an Ethereum
+transaction. For that, we need a key of type `Secp256k1.Evm`.
+
+```typescript
+const secpKey = await org.createKey(cs.Secp256k1.Evm);
+assert((await secpKey.owner()) == me.user_id);
+assert(await secpKey.enabled());
+console.log(`Created '${secpKey.type}' key ${secpKey.id}`);
+```
+
+### Create a `Role` and a `SignerSession`
+
+CubeSigner differentiates between _management_ and _signer_ sessions
+since managing keys (and an org) is often separate from using keys.
+
+Everything we've done so far has been using a management session. To
+sign a message with a key, we now need to create a signer
+session. Signer sessions are associated with roles (which we discuss
+in this section) or users (which we discuss [later](#create-a-session-for-an-oidc-user)).
+
+You can think of roles as groups
+that give certain users access to certain keys. To get started, let's
+create a `Role` and then simply call `createSession` on it:
+
+```typescript
+const role = await org.createRole();
+const sessionStorage = new cs.MemorySessionStorage<cs.SignerSessionData>();
+const session = await role.createSession(sessionStorage, "readme");
+console.log(`Created signer session for role '${role.id}'`);
+```
+
+Sessions have lifetimes, so they need to periodically refresh
+themselves to stay valid. When that happens, the refreshed session
+needs to be saved somewhere, which is why the `createSession` method
+requires an instance of `SessionStorage`. In this example, we don't
+plan to persist the session across multiple runs, so a simple
+in-memory storage suffices; otherwise, opting for
+`JsonFileSessionStorage` would be a better idea, i.e.,
+
+```typescript
+// this storage persists the signer session token to a file
+// named 'session.json' in the current working directory
+new cs.JsonFileSessionStorage("session.json");
+```
+
+### Sign an Ethereum transaction
+
+Let's create a dummy `EvmSignRequest`.
+
+```typescript
+const eth1Request = <cs.EvmSignRequest>{
+  chain_id: 1,
+  tx: <any>{
+    to: "0xff50ed3d0ec03ac01d4c79aad74928bff48a7b2b",
+    type: "0x00",
+    gas: "0x61a80",
+    gasPrice: "0x77359400",
+    nonce: "0",
+    value: "0x100",
+  },
+};
+```
+
+It seems we have everything in place to sign this request with the
+previously created key. However, attempting to do so fails with `403
+Forbidden` saying something like `Role 'Role#... is not authorized to
+access key 'Key#...'`:
+
+```typescript
+try {
+  console.log("Trying to sign before adding key to role");
+  await session.signEvm(secpKey, eth1Request);
+  assert(false, "Must not be allowed to sign with key not in role");
+} catch (e) {
+  assert(`${e}`.includes("not authorized to access key"));
+}
+```
+
+By default, a newly created role does not get to access any
+keys. Instead, keys have to be added to a role explicitly.
+After we do that, the `signEvm` call should succeed:
+
+```typescript
+console.log("Adding key to role, then signing an Ethereum transaction");
+await role.addKey(secpKey);
+let sig = await session.signEvm(secpKey, eth1Request);
+console.log(sig.data());
+assert(sig.data().rlp_signed_tx);
+```
+
+### Using ethers.js instead of the SDK directly
+
+```typescript
+const { ethers } = require("ethers");
+// Create new Signer
+const ethersSigner = new cs.ethers.Signer(secpKey.materialId, session /*, provider */);
+assert((await ethersSigner.getAddress()) === secpKey.materialId);
+// sign transaction as usual:
+console.log(
+  "ethers.js signature:",
+  await ethersSigner.signTransaction({
+    to: "0xff50ed3d0ec03ac01d4c79aad74928bff48a7b2b",
+    value: ethers.parseEther("0.0000001"),
+  }),
+);
+```
+
+### Set security policies
+
+When we add a `Secp256k1.Evm` key to a role (as we did above), a signer session
+associated with that role allows us to sign **any** Ethereum
+transaction with that key. If that seems too permissive, we can attach a security
+policy to restrict the allowed usages of this key in this role.
+
+For example, to restrict signing to transactions with a pre-approved
+recipient, we can attach a `TxReceiver` policy to our key:
+
+```typescript
+console.log("Setting transaction receiver policy");
+await secpKey.setPolicy([{ TxReceiver: "0xff50ed3d0ec03ac01d4c79aad74928bff48a7b2b" }]);
+console.log("Signing transaction");
+sig = await session.signEvm(secpKey, eth1Request);
+assert(sig.data().rlp_signed_tx);
+```
+
+Try changing the transaction receiver and verify that the transaction
+indeed gets rejected:
+
+```typescript
+console.log("Signing a transaction to a different receiver must be rejected");
+try {
+  await session.signEvm(secpKey, {
+    chain_id: 1,
+    tx: <any>{
+      ...eth1Request.tx,
+      to: "0x0000000000000000000000000000000000000000",
+    },
+  });
+  assert(false, "Must be rejected by policy");
+} catch (e) {
+  assert(`${e}`.includes("Transaction receiver not allowed by policy"));
+}
+```
+
+> **Warning**
+> Setting new policies overwrites the previous ones. Call
+> `Key::appendPolicy` instead of `Key::setPolicy` to append to
+> existing policies.
+
+### Sign a raw blob
+
+The `SignerSession` class exposes the `signBlob` method, which signs
+an arbitrary (raw, uninterpreted) bag of bytes with a given key. This
+operation, however, is not permitted by default; it is permanently
+disabled for `BLS` keys, and for other key types it can be enabled by
+attaching an `"AllowRawBlobSigning"` policy:
+
+```typescript
+console.log("Confirming that raw blob is rejected by default");
+const blobReq = <cs.BlobSignRequest>{
+  message_base64: "L1kE9g59xD3fzYQQSR7340BwU9fGrP6EMfIFcyX/YBc=",
+};
+try {
+  await session.signBlob(secpKey, blobReq);
+  assert(false, "Must be rejected by policy");
+} catch (e) {
+  assert(`${e}`.includes("Raw blob signing not allowed"));
+}
+
+console.log("Signing raw blob after adding 'AllowRawBlobSigning' policy");
+await secpKey.appendPolicy(["AllowRawBlobSigning"]);
+const blobSig = await session.signBlob(secpKey, blobReq);
+console.log(blobSig.data());
+assert(blobSig.data().signature);
+```
+
+> **Warning**
+> When signing a raw blob with a `Secp256k1` key, the blob **MUST** be the output of a secure hash function like SHA-256, and must be exactly 32 bytes long. This is a strict requirement of the ECDSA signature algorithm used by Bitcoin, Ethereum, and other blockchains. Signing any byte string that is not the output of a secure hash function can lead to catastrophic security failure, including completely leaking your secret key.
+
+Trying to sign an invalid message with a secp key will fail with
+`400 Bad Request` saying `Signature scheme: InvalidMessage`.
+
+### Load a signer session
+
+If signing is all that your application needs to do, you can instantiate a
+`SignerSession` directly from a signer session token, without ever needing a
+management session.
+
+First, get an existing token for a signer session:
+
+```typescript
+const token = await sessionStorage.retrieve();
+// alternatively, save this object to a file
+```
+
+or generate a new one from the command line:
+
+```bash
+cs token create --role-id $ROLE_ID --purpose MyPurpose --output json
+```
+
+Next, create a `MemorySessionStorage` containing the previously
+exported signer token, and just load the session from it.
+
+```typescript
+const signerSession = await cs.CubeSigner.loadSignerSession(
+  // alternatively, load 'token' from file or environment variable
+  new cs.MemorySessionStorage(token),
+);
+```
+
+Finally, use the new signer session to sign a transaction. To specify
+the signing key, you can pass its "material id" as a plain string:
+
+```typescript
+console.log("Signing transaction using imported signer session");
+const secpKeyStr: string = secpKey.materialId;
+sig = await signerSession.signEvm(secpKeyStr, eth1Request);
+console.log(sig.data());
+assert(sig.data().rlp_signed_tx);
+```
+
+### Create a session for an OIDC user
+
+CubeSigner supports the [OIDC](https://openid.net/developers/how-connect-works/)
+standard for authenticating third-party users.
+
+First, we need an OIDC token. We can get one from Google or any other
+supported OIDC issuer, including CubeSigner! Remember that we had to
+[log in](#logging-into-cubesigner) before we could instantiate
+`CubeSigner`; now we can simply ask that instance of `CubeSigner` to
+export the underlying token:
+
+```typescript
+const oidcToken = await cubesigner.sessionMgr!.token();
+```
+
+and then exchange it for either a _signer_ session (i.e., an instance
+of `SignerSession`, required by all signing endpoints, e.g.,
+`signEvm`)
+
+```typescript
+const oidcSession = await cubesigner.createOidcSession(oidcToken, org.id, ["sign:*"]);
+```
+
+or a _management_ session (i.e., and instance of `CubeSigner`,
+required by all management endpoints, e.g., retrieving user
+information, configuring user MFA methods, etc.).
+
+```typescript
+const oidcCubeSigner = new cs.CubeSigner({
+  sessionMgr: await cubesigner.createOidcManager(oidcToken, org.id, ["manage:*"]),
+});
+```
+
+> **Info**
+> For full details on how to use this SDK to create a CubeSigner
+> account for a third-party user and then exchange a valid OIDC token
+> CubeSigner session, check out the [OIDC
+> Example](./examples/oidc/README.md).
+
+### Set up TOTP for a user
+
+To manage a user we need a management session bound to that user. It
+doesn't matter if that user is native to CubeSigner or a third-party
+OIDC user. For that purpose, in this section we are going to use the
+previously created `oidcCubeSigner` instance.
+
+To set up TOTP, we call the `resetTotp` method which creates a new
+TOTP configuration for the users (overwriting the previous one, if
+any) and returns a [TOTP
+url](https://github.com/google/google-authenticator/wiki/Key-Uri-Format).
+
+```typescript
+console.log(`Setting up TOTP for user ${me.email}`);
+const totpResp = await oidcCubeSigner.resetTotp();
+assert(totpResp.totp_url);
+```
+
+From that url, we can generate a QR code to present to the user, or
+create an authenticator for automated testing.
+
+```typescript
+import { authenticator } from "otplib"; // npm install otplib@12.0.1
+
+const totpSecret = new URL(totpResp.totp_url).searchParams.get("secret");
+assert(totpSecret);
+
+console.log(`Verifying current TOTP code`);
+let code = authenticator.generate(totpSecret);
+await oidcCubeSigner.verifyTotp(code);
+```
+
+We can also check that the user's profile now indeed includes `Totp`
+as one of the configured MFA factors.
+
+```typescript
+const mfa = (await oidcCubeSigner.aboutMe()).mfa;
+console.log("Configured MFA types", mfa);
+assert(mfa.includes("Totp"));
+```
+
+### Configure MFA policy for signing
+
+We've already discussed assigning a [security
+policy](#set-security-policies) to a key; requiring multi-factor
+authentication is another such policy.
+
+Let's update our `secpKey` key to require an additional approval via
+TOTP before anything may be signed with that key:
+
+```typescript
+console.log(`Require TOTP for key ${secpKey.materialId}`);
+await secpKey.appendPolicy([{ RequireMfa: { count: 1, allowed_mfa_types: ["Totp"] } }]);
+```
+
+Now, when we call any signing operation on `secpKey`, we'll
+receive `202 Accepted` instead of `200 Ok`. The response body contains
+an MFA ID, which we can use to fetch and inspect the associated MFA
+request, see how many approvals it requires, what kind of MFA factors
+it allows, etc. Instead, since we know that our key requires TOTP, we
+can just call `approveTotp` on the response and pass the current TOTP
+code to it; if the code is correct, the call will succeed
+and return the signature.
+
+```typescript
+console.log(`Signing a transaction now requires TOTP`);
+let resp = await oidcSession.signEvm(secpKeyStr, eth1Request);
+assert(resp.requiresMfa());
+
+console.log(`Approving with TOTP code`);
+code = authenticator.generate(totpSecret);
+resp = await resp.approveTotp(oidcSession, code);
+assert(!resp.requiresMfa());
+console.log(resp.data());
+assert(resp.data().rlp_signed_tx);
+```
+
+### Clean up
+
+Once we are done, we can revoke the signer session and delete the role
+we created.
+
+```typescript
+console.log("Cleaning up");
+await session.sessionMgr.revoke();
+await role.delete();
+```
+
+As of now, deleting keys is not supported.
+
+## Building the SDK
+
+```bash
+npm install
+npm run build
+```
+
+## Running the SDK tests
+
+After [logging in](#logging-into-cubesigner), you can just run:
+
+```bash
+npm test
+```
+
+The tests will create some temporary keys and roles (in the
+organization of the signed-in user), then sign some messages, and
+finally clean (most of it) up.
+
+## License
+
+Copyright (C) 2022-2023 Cubist, Inc.
+
+See the [NOTICE](NOTICE) file for licensing information.

package/dist/examples/ethers.d.ts

@@ -0,0 +1 @@
+export {};