(
5 | handler: CustomRequestHandler,
6 | ) => RPCHandler = (handler) => (req) => {
7 | return handler(req.params);
8 | };
9 |
--------------------------------------------------------------------------------
/packages/server/src/internalHandlers/message.ts:
--------------------------------------------------------------------------------
1 | import {
2 | createAccountNotFound,
3 | createNotImplementedByWallet,
4 | MessageSign,
5 | schemaMessageSign,
6 | ServerError,
7 | } from "@ledgerhq/wallet-api-core";
8 | import { firstValueFrom } from "rxjs";
9 | import type { RPCHandler } from "../types";
10 |
11 | export const sign: RPCHandler = async (
12 | req,
13 | context,
14 | handlers,
15 | ) => {
16 | const walletHandler = handlers["message.sign"];
17 |
18 | if (!walletHandler) {
19 | throw new ServerError(createNotImplementedByWallet("message.sign"));
20 | }
21 |
22 | const safeParams = schemaMessageSign.params.parse(req.params);
23 |
24 | const accounts = await firstValueFrom(context.accounts$);
25 |
26 | const { accountId, hexMessage, options, meta } = safeParams;
27 |
28 | const account = accounts.find((acc) => acc.id === accountId);
29 |
30 | if (!account) {
31 | throw new ServerError(createAccountNotFound(accountId));
32 | }
33 |
34 | const signedMessage = await walletHandler({
35 | account,
36 | message: Buffer.from(hexMessage, "hex"),
37 | options,
38 | meta,
39 | });
40 |
41 | return {
42 | hexSignedMessage: signedMessage.toString("hex"),
43 | };
44 | };
45 |
--------------------------------------------------------------------------------
/packages/server/src/internalHandlers/wallet.ts:
--------------------------------------------------------------------------------
1 | import type {
2 | MethodId,
3 | WalletCapabilities,
4 | WalletUserId,
5 | WalletInfo,
6 | } from "@ledgerhq/wallet-api-core";
7 | import type { RPCHandler } from "../types";
8 |
9 | export const capabilities: RPCHandler = (
10 | _req,
11 | _context,
12 | handlers,
13 | ) => {
14 | const walletHandlerIds = Object.keys(handlers) as MethodId[];
15 |
16 | // we add the wallet
17 | const methodIds: MethodId[] = [
18 | ...walletHandlerIds,
19 | "account.list",
20 | "currency.list",
21 | "wallet.capabilities",
22 | "wallet.info",
23 | "wallet.userId",
24 | ];
25 |
26 | return Promise.resolve({
27 | methodIds,
28 | });
29 | };
30 |
31 | export const userId: RPCHandler = (_req, context) =>
32 | Promise.resolve({
33 | userId: context.config.userId,
34 | });
35 |
36 | export const info: RPCHandler = (_req, context) => {
37 | const { wallet, tracking } = context.config;
38 |
39 | return Promise.resolve({
40 | tracking,
41 | wallet,
42 | });
43 | };
44 |
--------------------------------------------------------------------------------
/packages/server/tests/server.spec.ts:
--------------------------------------------------------------------------------
1 | describe("Server", () => {
2 | it.todo("Should write server tests");
3 | });
4 |
--------------------------------------------------------------------------------
/packages/server/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../tsconfig.base.json",
3 | "compilerOptions": {
4 | "outDir": "./lib"
5 | },
6 | "include": ["src/**/*", "jest.config.ts", "tests/**/*"]
7 | }
8 |
--------------------------------------------------------------------------------
/packages/simulator/.eslintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | env: {
3 | es2021: true,
4 | node: true,
5 | },
6 | parserOptions: {
7 | project: true,
8 | tsconfigRootDir: __dirname,
9 | },
10 | rules: {
11 | "no-console": "off",
12 | "no-underscore-dangle": "off",
13 | "class-methods-use-this": "warn",
14 | },
15 | };
16 |
--------------------------------------------------------------------------------
/packages/simulator/jest.config.ts:
--------------------------------------------------------------------------------
1 | import path from "path";
2 | import type { JestConfigWithTsJest } from "ts-jest";
3 |
4 | const config: JestConfigWithTsJest = {
5 | preset: "@ledgerhq/jest-shared-config",
6 | moduleNameMapper: {
7 | "^@ledgerhq/wallet-api-(.*)$": path.join(
8 | __dirname,
9 | "../../packages/$1/src/index.ts",
10 | ),
11 | },
12 | };
13 |
14 | export default config;
15 |
--------------------------------------------------------------------------------
/packages/simulator/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@ledgerhq/wallet-api-simulator",
3 | "version": "1.2.11",
4 | "license": "MIT",
5 | "main": "lib/index.js",
6 | "module": "lib-es/index.js",
7 | "types": "lib/index.d.ts",
8 | "files": [
9 | "/lib",
10 | "/lib-es"
11 | ],
12 | "scripts": {
13 | "format:check": "prettier --check \"src\"",
14 | "format:fix": "prettier --write \"src\"",
15 | "lint": "eslint --cache --ext .ts \"src\"",
16 | "lint:fix": "eslint --cache --fix --ext .ts \"src\"",
17 | "dev": "tsc -p prod.tsconfig.json --watch",
18 | "build": "rm -rf lib/* lib-es/* && tsc -p prod.tsconfig.json && tsc -p prod-esm.tsconfig.json",
19 | "test": "jest"
20 | },
21 | "devDependencies": {
22 | "@ledgerhq/errors": "^6.16.2",
23 | "@ledgerhq/jest-shared-config": "workspace:*",
24 | "@types/jest": "^29.5.12",
25 | "@types/node": "^20.11.19",
26 | "@types/ws": "^8.5.10",
27 | "bignumber.js": "^9.1.2",
28 | "eslint": "^8.56.0",
29 | "jest": "^29.7.0",
30 | "jest-environment-jsdom": "^29.7.0",
31 | "ts-jest": "^29.1.2",
32 | "ts-node": "^10.9.2",
33 | "typescript": "^5.3.3"
34 | },
35 | "dependencies": {
36 | "@ledgerhq/hw-transport": "^6.30.4",
37 | "@ledgerhq/wallet-api-client": "workspace:*",
38 | "@ledgerhq/wallet-api-core": "workspace:*",
39 | "@ledgerhq/wallet-api-server": "workspace:*",
40 | "rxjs": "^7.8.1",
41 | "ws": "^8.16.0"
42 | }
43 | }
44 |
--------------------------------------------------------------------------------
/packages/simulator/prod-esm.tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "https://json.schemastore.org/tsconfig",
3 | "extends": "./tsconfig.json",
4 | "compilerOptions": {
5 | "baseUrl": ".",
6 | "module": "ESNext",
7 | "outDir": "./lib-es"
8 | },
9 | "include": ["src/**/*"]
10 | }
11 |
--------------------------------------------------------------------------------
/packages/simulator/prod.tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "https://json.schemastore.org/tsconfig",
3 | "extends": "./tsconfig.json",
4 | "compilerOptions": {
5 | "baseUrl": ".",
6 | "module": "commonjs",
7 | "outDir": "./lib"
8 | },
9 | "include": ["src/**/*"]
10 | }
11 |
--------------------------------------------------------------------------------
/packages/simulator/src/index.ts:
--------------------------------------------------------------------------------
1 | export * from "./transport";
2 | export * from "./profiles";
3 |
--------------------------------------------------------------------------------
/packages/simulator/src/profiles/index.ts:
--------------------------------------------------------------------------------
1 | import { deviceProfile } from "./device";
2 | import { standardProfile } from "./standard";
3 |
4 | export const profiles = {
5 | STANDARD: standardProfile,
6 | DEVICE: deviceProfile,
7 | };
8 |
--------------------------------------------------------------------------------
/packages/simulator/src/profiles/standard/accounts.json:
--------------------------------------------------------------------------------
1 | [
2 | {
3 | "id": "account-btc-1",
4 | "name": "Bitcoin 1",
5 | "address": "address",
6 | "currency": "bitcoin",
7 | "balance": "42",
8 | "spendableBalance": "42",
9 | "blockHeight": 1,
10 | "lastSyncDate": "1995-12-17T03:24:00"
11 | },
12 | {
13 | "id": "account-eth-1",
14 | "name": "Ethereum 1",
15 | "address": "address",
16 | "currency": "ethereum",
17 | "balance": "42",
18 | "spendableBalance": "42",
19 | "blockHeight": 1,
20 | "lastSyncDate": "1995-12-17T03:24:00"
21 | }
22 | ]
23 |
--------------------------------------------------------------------------------
/packages/simulator/src/profiles/standard/currencies.json:
--------------------------------------------------------------------------------
1 | [
2 | {
3 | "type": "CryptoCurrency",
4 | "id": "bitcoin",
5 | "ticker": "BTC",
6 | "name": "Bitcoin",
7 | "family": "bitcoin",
8 | "color": "#ffae35",
9 | "decimals": 8
10 | },
11 | {
12 | "type": "CryptoCurrency",
13 | "id": "ethereum",
14 | "ticker": "ETH",
15 | "name": "Ethereum",
16 | "family": "ethereum",
17 | "color": "#0ebdcd",
18 | "decimals": 18
19 | }
20 | ]
21 |
--------------------------------------------------------------------------------
/packages/simulator/src/test-run.ts:
--------------------------------------------------------------------------------
1 | import { WalletAPIClient } from "@ledgerhq/wallet-api-client";
2 | import { profiles } from "./profiles";
3 | // import { deserializeTransaction } from "@ledgerhq/wallet-api-core";
4 | import { getSimulatorTransport } from "./transport";
5 |
6 | async function main() {
7 | // eslint-disable-next-line @typescript-eslint/no-unused-vars
8 | const transport = getSimulatorTransport(profiles.STANDARD);
9 | const client = new WalletAPIClient(transport);
10 |
11 | const userId = await client.wallet.userId();
12 | const info = await client.wallet.info();
13 |
14 | console.log({
15 | userId,
16 | info,
17 | });
18 | /* transport.send(
19 | JSON.stringify({
20 | id: "49f2b5e9-9e77-495c-8add-8542127b4a50",
21 | jsonrpc: "2.0",
22 | method: "transaction.signAndBroadcast",
23 | params: {
24 | rawTransaction: {
25 | family: "ethereum",
26 | amount: "12",
27 | recipient: "0xananas",
28 | },
29 | },
30 | })
31 | );
32 | */
33 | }
34 |
35 | main()
36 | .then(() => console.log("done"))
37 | .catch((err) => console.log(err));
38 |
--------------------------------------------------------------------------------
/packages/simulator/src/types.ts:
--------------------------------------------------------------------------------
1 | import type { Account, Currency, Permission } from "@ledgerhq/wallet-api-core";
2 | import type { ServerConfig, WalletHandlers } from "@ledgerhq/wallet-api-server";
3 |
4 | export type SimulatorProfile = {
5 | config: ServerConfig;
6 | permissions: Permission;
7 | accounts: Account[];
8 | currencies: Currency[];
9 | methods: Partial;
10 | };
11 |
--------------------------------------------------------------------------------
/packages/simulator/src/ws.ts:
--------------------------------------------------------------------------------
1 | import { WebSocketServer } from "ws";
2 |
3 | const wss = new WebSocketServer({ port: 8080 });
4 |
5 | wss.on("connection", (ws) => {
6 | ws.on("message", (data) => {
7 | console.log("received: %s", data);
8 | });
9 |
10 | ws.send("something");
11 | });
12 |
--------------------------------------------------------------------------------
/packages/simulator/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../tsconfig.base.json",
3 | "compilerOptions": {
4 | "outDir": "./lib",
5 | "resolveJsonModule": true
6 | },
7 | "include": ["src/**/*", "jest.config.ts", "tests/**/*"]
8 | }
9 |
--------------------------------------------------------------------------------
/pnpm-workspace.yaml:
--------------------------------------------------------------------------------
1 | packages:
2 | - "packages/*"
3 | - "apps/*"
4 | - "examples/*"
5 |
--------------------------------------------------------------------------------
/renovate.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json",
3 | "extends": ["config:recommended"]
4 | }
5 |
--------------------------------------------------------------------------------
/rfc/rfc-template.md:
--------------------------------------------------------------------------------
1 | # RFC {RFC-NUMBER}: {TITLE}
2 |
3 | ## Changelog
4 |
5 | - {date}: {changelog}
6 |
7 | ## Abstract
8 |
9 | > A brief high-level synopsis of the topic of discussion for this RFC, ideally
10 | > just a few sentences. This should help the reader quickly decide whether the
11 | > rest of the discussion is relevant to their interest.
12 |
13 | ## Background
14 |
15 | > Any context or orientation needed for a reader to understand and participate
16 | > in the substance of the Discussion. If necessary, this section may include
17 | > links to other documentation or sources rather than restating existing
18 | > material, but should provide enough detail that the reader can tell what they
19 | > need to read to be up-to-date.
20 |
21 | ### References
22 |
23 | > Links to external materials needed to follow the discussion may be added here.
24 | >
25 | > In addition, if the discussion in a request for comments leads to any design
26 | > decisions, it may be helpful to add links to the Issue/PR here after the
27 | > discussion has settled.
28 |
29 | ## Discussion
30 |
31 | > This section contains the core of the discussion.
32 | >
33 | > There is no fixed format for this section, but ideally changes to this
34 | > section should be updated before merging to reflect any discussion that took
35 | > place on the PR that made those changes.
36 |
--------------------------------------------------------------------------------
/spec/README.md:
--------------------------------------------------------------------------------
1 | # Platform API Specifications
2 |
3 | This directory hosts the canonical Markdown specifications of the Platform API.
4 |
5 | It shall be used to describe protocol semantics, namely the client-server RPC methods, types and errors. The specification includes encoding descriptions used in interprocess communication to comply with the protocol. It defines the interface between the application and the Platform API.
6 |
7 | ## Table of Contents
8 |
9 | - [Overview](#overview)
10 | - [Server](./server/README.md)
11 | - [Client](./client/README.md)
12 | - [Types](./core/types.md)
13 | - [Errors](./core/errors.md)
14 | - [Encoding](./core/encoding.md)
15 | - [Manifest](./core/manifest.md)
16 | - [Remote Procedure Calls](./rpc/README.md)
17 |
18 | ## Version
19 |
20 | This specification uses [semantic versioning](https://semver.org/)
21 |
22 | **Version: 0.1.0**
23 |
24 | ### Changelog
25 |
26 | | Version | Description |
27 | | ------- | ------------- |
28 | | 0.1.0 | Initial draft |
29 |
30 | ## Contibuting
31 |
32 | Contributions are welcome.
33 |
34 | Proposals at an early stage can first be drafted as Github issues. To progress, a proposal will often need to be written out and approved as a [Request For Comment (RFC)](../rfc/README.md).
35 |
36 | The standard language for coding is Typescript.
37 |
38 | If you find discrepancies between the spec and the code that
39 | do not have an associated issue or pull request on github,
40 | please create a new issue !
41 |
42 | ## Overview
43 |
--------------------------------------------------------------------------------
/spec/core/README.md:
--------------------------------------------------------------------------------
1 | This section describes the core types and errors of the Platform API implementation.
2 |
3 | - [Errors](./errors.md)
4 | - [Families](./families.md)
5 | - [Manifest](./manifest.md)
6 | - [Types](./types.md)
7 |
--------------------------------------------------------------------------------
/spec/core/families.md:
--------------------------------------------------------------------------------
1 | # Crypto families
2 |
--------------------------------------------------------------------------------
/spec/server/README.md:
--------------------------------------------------------------------------------
1 | # Server spec
2 |
3 | This file defines the Server spec of the Platform API. This is meant to be implemented by all wallets (we are talking about a wallets like Live, Vault or Connect).
4 |
5 | The Server API allows a Wallet to interact with an Application and allows it's features to be used by implementing a bi-directonnal [JSON-RPC 2.0](https://www.jsonrpc.org/specification) server and the specification of the Platform API defined [here](../rpc/README.md).
6 |
7 | The Server will allow custom UI to be used when handling RPC calls through the JSON-RPC spec of the Platform API. It will listen for a connection to a Client through a transport layer, deserialize and respond to Application requests with serialized responses or errors.
8 |
9 | ## Middlewares
10 |
11 | The Server allows for middlewares to be used.
12 | With middlewares the wallet is able to do permissions or validation across all RPC calls.
13 |
14 | ## Serialization and deserialization
15 |
16 | All [`Transaction`]()s and [`Account`]()s specific to the Wallet should be serialized before being broadcasted to the Application via RPC.
17 |
18 | Similarly, the request received from the Application, formatted as [`RawTransaction`]() and [`RawAccount`]() should be deserialized before being used by the Wallet.
19 |
20 | ## Errors
21 |
22 | The errors returned by the server are defined [here](/spec/core/errors.md).
23 |
24 | ## Methods
25 |
--------------------------------------------------------------------------------
/tsconfig.base.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "@tsconfig/recommended/tsconfig.json",
3 | "compilerOptions": {
4 | "target": "ES2022",
5 | "moduleResolution": "Node10",
6 | "sourceMap": true,
7 | "declaration": true,
8 | "declarationMap": true,
9 | "skipLibCheck": false,
10 | "baseUrl": ".",
11 | "paths": {
12 | "@ledgerhq/wallet-api-*": ["packages/*/src/index.ts"]
13 | },
14 |
15 | "strict": true,
16 | "allowUnusedLabels": false,
17 | "allowUnreachableCode": false,
18 | "exactOptionalPropertyTypes": false, // change that to true when moving to typia
19 | "noFallthroughCasesInSwitch": true,
20 | "noImplicitOverride": true,
21 | "noImplicitReturns": true,
22 | "noPropertyAccessFromIndexSignature": true,
23 | "noUncheckedIndexedAccess": true,
24 | "noUnusedLocals": true,
25 | "noUnusedParameters": true,
26 |
27 | "isolatedModules": true,
28 |
29 | "checkJs": true,
30 |
31 | "esModuleInterop": true,
32 | "forceConsistentCasingInFileNames": true,
33 |
34 | "lib": ["DOM", "DOM.Iterable"]
35 | },
36 | "exclude": ["node_modules"]
37 | }
38 |
--------------------------------------------------------------------------------