@openfort/openfort-node 0.6.78 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.7.0
+
+### Minor Changes
+
+- [#32](https://github.com/openfort-xyz/openfort-node/pull/32) [`105c4668d86686698d260822347dd873925b446f`](https://github.com/openfort-xyz/openfort-node/commit/105c4668d86686698d260822347dd873925b446f) Thanks [@jamalavedra](https://github.com/jamalavedra)! - include backend wallets and update account namespace interactions'
+
 ## 0.6.78
 
 ### Patch Changes

package/Makefile

@@ -0,0 +1,75 @@
+.PHONY: update-openapi check-openapi generate-client help
+
+# OpenAPI spec URLs with timestamp for cache-busting
+TIMESTAMP := $(shell date +%s)
+OPENAPI_MAIN_URL := https://api.openfort.io/api-docs/swagger.json?timestamp=$(TIMESTAMP)
+OPENAPI_AUTH_URL := https://api.openfort.io/iam/v2/auth/reference?timestamp=$(TIMESTAMP)
+OPENAPI_MAIN_LOCAL := openapi.json
+OPENAPI_AUTH_LOCAL := openapi-auth.json
+OPENAPI_MAIN_TEMP := openapi.json.new
+OPENAPI_AUTH_TEMP := openapi-auth.json.new
+
+help:
+	@echo "Available commands:"
+	@echo "  make update-openapi    - Download the latest OpenAPI specs (main + auth)"
+	@echo "  make check-openapi     - Check if newer OpenAPI specs are available"
+	@echo "  make generate-client   - Generate the TypeScript client from the specs"
+
+# Generate the TypeScript client using Orval
+generate-client:
+	@echo "Generating TypeScript client..."
+	@pnpm orval --config orval.config.ts
+	@echo "Client generated successfully!"
+
+# Download all OpenAPI specs
+update-openapi:
+	@echo "Downloading OpenAPI specs..."
+	@MAIN_UPDATED=0; AUTH_UPDATED=0; \
+	curl -s -o $(OPENAPI_MAIN_TEMP) "$(OPENAPI_MAIN_URL)"; \
+	curl -s -o $(OPENAPI_AUTH_TEMP) "$(OPENAPI_AUTH_URL)"; \
+	if [ ! -f $(OPENAPI_MAIN_LOCAL) ] || ! cmp -s $(OPENAPI_MAIN_TEMP) $(OPENAPI_MAIN_LOCAL); then \
+		mv $(OPENAPI_MAIN_TEMP) $(OPENAPI_MAIN_LOCAL); \
+		echo "Main API spec updated."; \
+		MAIN_UPDATED=1; \
+	else \
+		rm $(OPENAPI_MAIN_TEMP); \
+		echo "Main API spec is already up to date."; \
+	fi; \
+	if [ ! -f $(OPENAPI_AUTH_LOCAL) ] || ! cmp -s $(OPENAPI_AUTH_TEMP) $(OPENAPI_AUTH_LOCAL); then \
+		mv $(OPENAPI_AUTH_TEMP) $(OPENAPI_AUTH_LOCAL); \
+		echo "IAM v2 auth spec updated."; \
+		AUTH_UPDATED=1; \
+	else \
+		rm $(OPENAPI_AUTH_TEMP); \
+		echo "IAM v2 auth spec is already up to date."; \
+	fi
+
+# Check if newer OpenAPI specs are available (returns exit code 1 if update available)
+check-openapi:
+	@echo "Checking for OpenAPI updates..."
+	@NEEDS_UPDATE=0; \
+	curl -s -o $(OPENAPI_MAIN_TEMP) "$(OPENAPI_MAIN_URL)"; \
+	curl -s -o $(OPENAPI_AUTH_TEMP) "$(OPENAPI_AUTH_URL)"; \
+	if [ ! -f $(OPENAPI_MAIN_LOCAL) ]; then \
+		echo "Main API spec not found locally."; \
+		NEEDS_UPDATE=1; \
+	elif ! cmp -s $(OPENAPI_MAIN_TEMP) $(OPENAPI_MAIN_LOCAL); then \
+		echo "A newer main API spec is available."; \
+		NEEDS_UPDATE=1; \
+	else \
+		echo "Main API spec is up to date."; \
+	fi; \
+	if [ ! -f $(OPENAPI_AUTH_LOCAL) ]; then \
+		echo "IAM v2 auth spec not found locally."; \
+		NEEDS_UPDATE=1; \
+	elif ! cmp -s $(OPENAPI_AUTH_TEMP) $(OPENAPI_AUTH_LOCAL); then \
+		echo "A newer IAM v2 auth spec is available."; \
+		NEEDS_UPDATE=1; \
+	else \
+		echo "IAM v2 auth spec is up to date."; \
+	fi; \
+	rm -f $(OPENAPI_MAIN_TEMP) $(OPENAPI_AUTH_TEMP); \
+	if [ $$NEEDS_UPDATE -eq 1 ]; then \
+		echo "Run 'make update-openapi' to update."; \
+		exit 1; \
+	fi

package/README.md

@@ -1,104 +1,213 @@
-![Illustration_04 1-min](https://github.com/user-attachments/assets/84796219-8196-40fb-a28a-6ca24a388818)
-
 <div align="center">
-  <h4>
-    <a href="https://www.openfort.io/">
-      Website
-    </a>
-    <span> | </span>
-    <a href="https://www.openfort.io/docs">
-      Documentation
-    </a>
-    <span> | </span>
-    <a href="https://x.com/openfort_hq">
-      Twitter
-    </a>
-  </h4>
+
+![Openfort](https://github.com/user-attachments/assets/84796219-8196-40fb-a28a-6ca24a388818)
+
+  <p>
+    Server-side SDK for managing EVM and Solana wallets, gas sponsorship, and blockchain interactions.
+  </p>
+
+[![npm version](https://img.shields.io/npm/v/@openfort/openfort-node.svg)](https://www.npmjs.org/package/@openfort/openfort-node)
+[![npm downloads](https://img.shields.io/npm/dm/@openfort/openfort-node.svg)](https://www.npmjs.org/package/@openfort/openfort-node)
+[![Follow @openfort_hq](https://img.shields.io/twitter/follow/openfort_hq.svg?style=social)](https://x.com/openfort_hq)
+[![MIT License](https://img.shields.io/badge/license-MIT-0052FF?style=flat-square)](https://github.com/openfort-xyz/openfort-node/blob/main/LICENSE)
+
 </div>
 
+<br />
+
+## Table of Contents
 
-# Openfort Node.js Library
+- [Table of Contents](#table-of-contents)
+- [Overview](#overview)
+- [Installation](#installation)
+- [Quickstart](#quickstart)
+- [Features](#features)
+  - [Wallet Management](#wallet-management)
+  - [Signing](#signing)
+  - [Gas Sponsorship](#gas-sponsorship)
+  - [IAM \& Authentication](#iam--authentication)
+- [Examples](#examples)
+- [Documentation](#documentation)
+- [Support](#support)
+- [License](#license)
 
-[![Version](https://img.shields.io/npm/v/@openfort/openfort-node.svg)](https://www.npmjs.org/package/@openfort/openfort-node)
+## Overview
 
-The Openfort Node library provides convenient access to the Openfort API from applications written in server-side JavaScript.
-\
-## Requirements
+The Openfort Node.js SDK provides convenient access to the [Openfort API](https://www.openfort.io/docs) for server-side applications. It enables developers to:
 
-Node 14 or higher.
+- Create and manage EVM and Solana backend wallets
+- Sign messages, typed data, and transactions
+- Execute gasless transactions with gas sponsorship policies
+- Manage users, accounts, and transaction intents
+- Integrate with smart contracts and token swaps
 
 ## Installation
 
-```shell
+Requires Node.js 14 or higher.
+
+```bash
 npm install @openfort/openfort-node
 ```
 
-```shell
+```bash
 yarn add @openfort/openfort-node
 ```
 
-## Usage
+```bash
+pnpm add @openfort/openfort-node
+```
+
+## Quickstart
+
+Get your API key from the [Openfort Dashboard](https://dashboard.openfort.io/api-keys).
+
+```typescript
+import Openfort from "@openfort/openfort-node";
 
-The package needs to be configured with your account's secret key, which is
-available in the [Openfort Dashboard][api-keys]. Require it with the key's
-value:
+const openfort = new Openfort("sk_test_...", {
+  walletSecret: "your-wallet-secret", // Required for signing operations
+});
 
-<!-- prettier-ignore -->
-```js
-const openfort = require('@openfort/openfort-node')('sk_test_...');
+// Create an EVM backend account
+const account = await openfort.accounts.evm.backend.create({
+  name: "MyWallet",
+});
+console.log("Account address:", account.address);
 
-openfort.players.create({
-    name: 'Joan McCoain',
-    description: 'API created player'
-})
-  .then(player => console.log(player.id))
-  .catch(error => console.error(error));
+// Sign a message (methods are on the account object)
+const signature = await account.signMessage({
+  message: "Hello, Openfort!",
+});
+console.log("Signature:", signature);
 ```
 
-Or using ES modules and `async`/`await`:
+## Features
+
+### Wallet Management
+
+Create and manage wallets across EVM chains and Solana:
 
-```js
-import Openfort from '@openfort/openfort-node';
-const openfort = new Openfort('sk_test_...');
+```typescript
+// EVM backend accounts
+const evmAccount = await openfort.accounts.evm.backend.create({
+  name: "MyEVMWallet",
+});
 
-const player = await openfort.players.create({
-    name: 'customer@example.com',
-    description: 'API created player'
+// Solana backend accounts
+const solanaAccount = await openfort.accounts.solana.backend.create({
+  name: "MySolanaWallet",
 });
 
-console.log(player.id);
+// Import existing wallet
+const imported = await openfort.accounts.evm.backend.import({
+  privateKey: "0x...",
+  name: "ImportedWallet",
+});
 ```
 
-Below code snippet shows exemplary usage of the configuration and the API. 
+### Signing
+
+Sign messages, typed data, and transactions. Methods are called directly on the account object:
 
 ```typescript
-import Openfort from "@openfort/openfort-node";
+// Sign message
+const signature = await account.signMessage({
+  message: "Hello, Openfort!",
+});
 
-async function example() {
-    const openfort = new Openfort("sk_test_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
-    const players = await openfort.players.list();
-    for (const player of players.data) {
-        console.log(player.id);
-    }
+// Sign EIP-712 typed data
+const typedSig = await account.signTypedData({
+  domain: { name: "MyApp", version: "1", chainId: 1 },
+  types: {
+    Person: [
+      { name: "name", type: "string" },
+      { name: "wallet", type: "address" },
+    ],
+  },
+  primaryType: "Person",
+  message: { name: "Alice", wallet: "0x..." },
+});
+```
+
+### Gas Sponsorship
+
+Sponsor gas fees for your users with policies:
+
+```typescript
+// Create a sponsorship policy
+const policy = await openfort.policies.create({
+  name: "Free gas for users",
+  chainId: 80002,
+  strategy: { sponsorSchema: "pay_for_user" },
+});
+
+// Register a contract
+const contract = await openfort.contracts.create({
+  name: "MyContract",
+  chainId: 80002,
+  address: "0x38090d1636069c0ff1af6bc1737fb996b7f63ac0",
+});
+
+// Add rules to control sponsorship
+await openfort.policyRules.create({
+  policy: policy.id,
+  type: "account_functions",
+  contract: contract.id,
+  functionName: "mint",
+});
+```
 
-    const newPlayer = await openfort.players.create({name: "Test"});
-    console.log(newPlayer.id)
+### IAM & Authentication
 
-    const transactionIntents = await openfort.transactionIntents.list();
-    for (const intent of transactionIntents.data) {
-        console.log(`Intent ${intent.id} by ${intent.player.name}`);
-    }
-}
+Manage users and verify sessions:
 
-example().catch((e) => console.error(e));
+```typescript
+// List authenticated users
+const users = await openfort.iam.users.list({ limit: 10 });
+
+// Verify session from access token
+const session = await openfort.iam.getSession({ accessToken });
+console.log("User ID:", session.user.id);
+console.log("Session expires:", session.session.expiresAt);
+```
+
+
+## Examples
+
+The SDK includes comprehensive examples for all features. See the [examples directory](./examples) for runnable code.
+
+| Category       | Examples                                           |
+| -------------- | -------------------------------------------------- |
+| EVM Wallets    | Create, import, export, sign messages/transactions |
+| Solana Wallets | Create, import, export, sign messages/transactions |
+| Policies       | Gas sponsorship, policy rules, enable/disable      |
+| Transactions   | Create intents, estimate gas, read contracts       |
+| Exchange       | Token swap quotes and execution                    |
+| IAM            | User management, session verification              |
+
+Run examples:
+
+```bash
+cd examples
+cp .env.example .env
+# Edit .env with your API key
+pnpm example evm/accounts/createAccount.ts
 ```
 
+## Documentation
+
+- [Official Documentation](https://www.openfort.io/docs)
+- [API Reference](https://www.openfort.io/docs/reference/api)
+- [Dashboard](https://dashboard.openfort.io)
+
 ## Support
 
-New features and bug fixes are released on the latest major version of the `openfort` package. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
+- [GitHub Issues](https://github.com/openfort-xyz/openfort-node/issues) - Report bugs and request features
+- [Twitter](https://x.com/openfort_hq) - Follow for updates
+- [Website](https://www.openfort.io) - Learn more about Openfort
+
+New features and bug fixes are released on the latest major version. We recommend upgrading to the latest version for security updates and new functionality.
 
-[api-keys]: https://dashboard.openfort.io/api-keys
+## License
 
-<!--
-# vim: set tw=79:
--->
+This project is licensed under the MIT License.

package/biome.json

@@ -1,7 +1,14 @@
 {
   "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
   "files": {
-    "includes": ["src/**/*", "*.ts", "*.js", "!src/generated", "*.json"]
+    "includes": [
+      "src/**/*",
+      "*.ts",
+      "*.js",
+      "!src/generated",
+      "!src/openapi-client/generated",
+      "*.json"
+    ]
   },
   "formatter": {
     "enabled": true,
@@ -24,8 +31,14 @@
         "noUnusedVariables": "error"
       },
       "performance": {
-        "noBarrelFile": "error",
-        "noReExportAll": "error",
+        "noBarrelFile": {
+          "level": "error",
+          "options": {}
+        },
+        "noReExportAll": {
+          "level": "error",
+          "options": {}
+        },
         "noDelete": "off"
       },
       "style": {
@@ -52,5 +65,22 @@
       "semicolons": "asNeeded"
     }
   },
-  "assist": { "actions": { "source": { "organizeImports": "on" } } }
+  "assist": { "actions": { "source": { "organizeImports": "on" } } },
+  "overrides": [
+    {
+      "includes": [
+        "src/index.ts",
+        "src/openapi-client/index.ts",
+        "src/wallets/**/index.ts"
+      ],
+      "linter": {
+        "rules": {
+          "performance": {
+            "noBarrelFile": "off",
+            "noReExportAll": "off"
+          }
+        }
+      }
+    }
+  ]
 }