@subwallet/extension-base 0.3.6-0

package/build/package.json

@@ -0,0 +1,210 @@
+{
+  "author": "Jaco Greeff <jacogr@gmail.com>",
+  "bugs": "https://github.com/Koniverse/Subwallet-V2/issues",
+  "contributors": [],
+  "description": "Functions, classes and other utilities used in @subwallet/extension",
+  "homepage": "https://github.com/Koniverse/Subwallet-V2/tree/master/packages/extension-base#readme",
+  "license": "Apache-2.0",
+  "maintainers": [],
+  "name": "@subwallet/extension-base",
+  "repository": {
+    "directory": "packages/extension-base",
+    "type": "git",
+    "url": "https://github.com/Koniverse/Subwallet-V2.git"
+  },
+  "sideEffects": [
+    "./detectPackage.js",
+    "./cjs/detectPackage.js"
+  ],
+  "type": "module",
+  "version": "0.3.6-0",
+  "main": "./cjs/index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "./cjs/package.json": "./cjs/package.json",
+    "./cjs/*": "./cjs/*.js",
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./cjs/index.js",
+      "default": "./index.js"
+    },
+    "./background/handlers": {
+      "types": "./background/handlers/index.d.ts",
+      "require": "./cjs/background/handlers/index.js",
+      "default": "./background/handlers/index.js"
+    },
+    "./background/handlers/Extension": {
+      "types": "./background/handlers/Extension.d.ts",
+      "require": "./cjs/background/handlers/Extension.js",
+      "default": "./background/handlers/Extension.js"
+    },
+    "./background/handlers/helpers": {
+      "types": "./background/handlers/helpers.d.ts",
+      "require": "./cjs/background/handlers/helpers.js",
+      "default": "./background/handlers/helpers.js"
+    },
+    "./background/handlers/State": {
+      "types": "./background/handlers/State.d.ts",
+      "require": "./cjs/background/handlers/State.js",
+      "default": "./background/handlers/State.js"
+    },
+    "./background/handlers/subscriptions": {
+      "types": "./background/handlers/subscriptions.d.ts",
+      "require": "./cjs/background/handlers/subscriptions.js",
+      "default": "./background/handlers/subscriptions.js"
+    },
+    "./background/handlers/Tabs": {
+      "types": "./background/handlers/Tabs.d.ts",
+      "require": "./cjs/background/handlers/Tabs.js",
+      "default": "./background/handlers/Tabs.js"
+    },
+    "./background/KoniTypes": {
+      "types": "./background/KoniTypes.d.ts",
+      "require": "./cjs/background/KoniTypes.js",
+      "default": "./background/KoniTypes.js"
+    },
+    "./background/RequestBytesSign": {
+      "types": "./background/RequestBytesSign.d.ts",
+      "require": "./cjs/background/RequestBytesSign.js",
+      "default": "./background/RequestBytesSign.js"
+    },
+    "./background/RequestExtrinsicSign": {
+      "types": "./background/RequestExtrinsicSign.d.ts",
+      "require": "./cjs/background/RequestExtrinsicSign.js",
+      "default": "./background/RequestExtrinsicSign.js"
+    },
+    "./background/types": {
+      "types": "./background/types.d.ts",
+      "require": "./cjs/background/types.js",
+      "default": "./background/types.js"
+    },
+    "./bundle": {
+      "types": "./bundle.d.ts",
+      "require": "./cjs/bundle.js",
+      "default": "./bundle.js"
+    },
+    "./defaults": {
+      "types": "./defaults.d.ts",
+      "require": "./cjs/defaults.js",
+      "default": "./defaults.js"
+    },
+    "./detectOther": {
+      "types": "./detectOther.d.ts",
+      "require": "./cjs/detectOther.js",
+      "default": "./detectOther.js"
+    },
+    "./detectPackage": {
+      "types": "./detectPackage.d.ts",
+      "require": "./cjs/detectPackage.js",
+      "default": "./detectPackage.js"
+    },
+    "./package.json": "./package.json",
+    "./packageInfo.js": {
+      "types": "./packageInfo.d.ts",
+      "require": "./cjs/packageInfo.js",
+      "default": "./packageInfo.js"
+    },
+    "./packageInfo": {
+      "types": "./packageInfo.d.ts",
+      "require": "./cjs/packageInfo.js",
+      "default": "./packageInfo.js"
+    },
+    "./page": {
+      "types": "./page/index.d.ts",
+      "require": "./cjs/page/index.js",
+      "default": "./page/index.js"
+    },
+    "./page/Accounts": {
+      "types": "./page/Accounts.d.ts",
+      "require": "./cjs/page/Accounts.js",
+      "default": "./page/Accounts.js"
+    },
+    "./page/Injected": {
+      "types": "./page/Injected.d.ts",
+      "require": "./cjs/page/Injected.js",
+      "default": "./page/Injected.js"
+    },
+    "./page/Metadata": {
+      "types": "./page/Metadata.d.ts",
+      "require": "./cjs/page/Metadata.js",
+      "default": "./page/Metadata.js"
+    },
+    "./page/PostMessageProvider": {
+      "types": "./page/PostMessageProvider.d.ts",
+      "require": "./cjs/page/PostMessageProvider.js",
+      "default": "./page/PostMessageProvider.js"
+    },
+    "./page/Signer": {
+      "types": "./page/Signer.d.ts",
+      "require": "./cjs/page/Signer.js",
+      "default": "./page/Signer.js"
+    },
+    "./page/types": {
+      "types": "./page/types.d.ts",
+      "require": "./cjs/page/types.js",
+      "default": "./page/types.js"
+    },
+    "./stores": {
+      "types": "./stores/index.d.ts",
+      "require": "./cjs/stores/index.js",
+      "default": "./stores/index.js"
+    },
+    "./stores/Accounts": {
+      "types": "./stores/Accounts.d.ts",
+      "require": "./cjs/stores/Accounts.js",
+      "default": "./stores/Accounts.js"
+    },
+    "./stores/Base": {
+      "types": "./stores/Base.d.ts",
+      "require": "./cjs/stores/Base.js",
+      "default": "./stores/Base.js"
+    },
+    "./stores/Metadata": {
+      "types": "./stores/Metadata.d.ts",
+      "require": "./cjs/stores/Metadata.js",
+      "default": "./stores/Metadata.js"
+    },
+    "./types": {
+      "types": "./types.d.ts",
+      "require": "./cjs/types.js",
+      "default": "./types.js"
+    },
+    "./utils": {
+      "types": "./utils/index.d.ts",
+      "require": "./cjs/utils/index.js",
+      "default": "./utils/index.js"
+    },
+    "./utils/canDerive": {
+      "types": "./utils/canDerive.d.ts",
+      "require": "./cjs/utils/canDerive.js",
+      "default": "./utils/canDerive.js"
+    },
+    "./utils/getId": {
+      "types": "./utils/getId.d.ts",
+      "require": "./cjs/utils/getId.js",
+      "default": "./utils/getId.js"
+    }
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.16.7",
+    "@ethereumjs/common": "^2.6.3",
+    "@polkadot/api": "^7.3.1",
+    "@polkadot/keyring": "^8.3.1",
+    "@polkadot/networks": "^8.3.1",
+    "@polkadot/phishing": "^0.11.30",
+    "@polkadot/rpc-provider": "^7.3.1",
+    "@polkadot/types": "^7.3.1",
+    "@polkadot/ui-keyring": "^0.89.1",
+    "@polkadot/ui-settings": "^0.89.1",
+    "@polkadot/util": "^8.3.1",
+    "@polkadot/util-crypto": "^8.3.1",
+    "@subwallet/extension-chains": "^0.3.6-0",
+    "@subwallet/extension-dapp": "^0.3.6-0",
+    "@subwallet/extension-inject": "^0.3.6-0",
+    "ethereumjs-tx": "^2.1.2",
+    "eventemitter3": "^4.0.7",
+    "rxjs": "^7.5.1",
+    "web3": "^1.7.1"
+  }
+}

package/build/packageInfo.d.ts

@@ -0,0 +1,6 @@
+export declare const packageInfo: {
+    name: string;
+    path: string;
+    type: string;
+    version: string;
+};

package/build/packageInfo.js

@@ -0,0 +1,9 @@
+// Copyright 2017-2022 @subwallet/extension-base authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+// Do not edit, auto-generated by @polkadot/dev
+export const packageInfo = {
+  name: '@subwallet/extension-base',
+  path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto',
+  type: 'esm',
+  version: '0.3.6-0'
+};

package/build/page/Accounts.d.ts

@@ -0,0 +1,7 @@
+import type { InjectedAccount, InjectedAccounts, Unsubcall } from '@subwallet/extension-inject/types';
+import type { SendRequest } from './types';
+export default class Accounts implements InjectedAccounts {
+    constructor(_sendRequest: SendRequest);
+    get(anyType?: boolean): Promise<InjectedAccount[]>;
+    subscribe(cb: (accounts: InjectedAccount[]) => unknown): Unsubcall;
+}

package/build/page/Accounts.js

@@ -0,0 +1,22 @@
+// Copyright 2019-2022 @subwallet/extension authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+// External to class, this.# is not private enough (yet)
+let sendRequest;
+export default class Accounts {
+  constructor(_sendRequest) {
+    sendRequest = _sendRequest;
+  }
+
+  get(anyType) {
+    return sendRequest('pub(accounts.listV2)', {
+      anyType
+    });
+  }
+
+  subscribe(cb) {
+    sendRequest('pub(accounts.subscribeV2)', null, cb).catch(error => console.error(error));
+    return () => {// FIXME we need the ability to unsubscribe
+    };
+  }
+
+}

package/build/page/Injected.d.ts

@@ -0,0 +1,13 @@
+import type { Injected } from '@subwallet/extension-inject/types';
+import type { SendRequest } from './types';
+import Accounts from './Accounts';
+import Metadata from './Metadata';
+import PostMessageProvider from './PostMessageProvider';
+import Signer from './Signer';
+export default class implements Injected {
+    readonly accounts: Accounts;
+    readonly metadata: Metadata;
+    readonly provider: PostMessageProvider;
+    readonly signer: Signer;
+    constructor(sendRequest: SendRequest);
+}

package/build/page/Injected.js

@@ -0,0 +1,15 @@
+// Copyright 2019-2022 @subwallet/extension authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import Accounts from "./Accounts.js";
+import Metadata from "./Metadata.js";
+import PostMessageProvider from "./PostMessageProvider.js";
+import Signer from "./Signer.js";
+export default class {
+  constructor(sendRequest) {
+    this.accounts = new Accounts(sendRequest);
+    this.metadata = new Metadata(sendRequest);
+    this.provider = new PostMessageProvider(sendRequest);
+    this.signer = new Signer(sendRequest);
+  }
+
+}

package/build/page/Metadata.d.ts

@@ -0,0 +1,7 @@
+import type { InjectedMetadata, InjectedMetadataKnown, MetadataDef } from '@subwallet/extension-inject/types';
+import type { SendRequest } from './types';
+export default class Metadata implements InjectedMetadata {
+    constructor(_sendRequest: SendRequest);
+    get(): Promise<InjectedMetadataKnown[]>;
+    provide(definition: MetadataDef): Promise<boolean>;
+}

package/build/page/Metadata.js

@@ -0,0 +1,18 @@
+// Copyright 2019-2022 @subwallet/extension authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+// External to class, this.# is not private enough (yet)
+let sendRequest;
+export default class Metadata {
+  constructor(_sendRequest) {
+    sendRequest = _sendRequest;
+  }
+
+  get() {
+    return sendRequest('pub(metadata.list)');
+  }
+
+  provide(definition) {
+    return sendRequest('pub(metadata.provide)', definition);
+  }
+
+}

package/build/page/PostMessageProvider.d.ts

@@ -0,0 +1,62 @@
+import type { InjectedProvider, ProviderList, ProviderMeta } from '@subwallet/extension-inject/types';
+import type { ProviderInterfaceEmitCb, ProviderInterfaceEmitted } from '@polkadot/rpc-provider/types';
+import type { AnyFunction } from '@polkadot/types/types';
+import type { SendRequest } from './types';
+declare type CallbackHandler = (error?: null | Error, value?: unknown) => void;
+interface SubscriptionHandler {
+    callback: CallbackHandler;
+    type: string;
+}
+/**
+ * @name PostMessageProvider
+ *
+ * @description Extension provider to be used by dapps
+ */
+export default class PostMessageProvider implements InjectedProvider {
+    #private;
+    /**
+     * @param {function}  sendRequest  The function to be called to send requests to the node
+     * @param {function}  subscriptionNotificationHandler  Channel for receiving subscription messages
+     */
+    constructor(_sendRequest: SendRequest);
+    /**
+     * @description Returns a clone of the object
+     */
+    clone(): PostMessageProvider;
+    /**
+     * @description Manually disconnect from the connection, clearing autoconnect logic
+     */
+    connect(): Promise<void>;
+    /**
+     * @description Manually disconnect from the connection, clearing autoconnect logic
+     */
+    disconnect(): Promise<void>;
+    /**
+     * @summary `true` when this provider supports subscriptions
+     */
+    get hasSubscriptions(): boolean;
+    /**
+     * @summary Whether the node is connected or not.
+     * @return {boolean} true if connected
+     */
+    get isConnected(): boolean;
+    listProviders(): Promise<ProviderList>;
+    /**
+     * @summary Listens on events after having subscribed using the [[subscribe]] function.
+     * @param  {ProviderInterfaceEmitted} type Event
+     * @param  {ProviderInterfaceEmitCb}  sub  Callback
+     * @return unsubscribe function
+     */
+    on(type: ProviderInterfaceEmitted, sub: ProviderInterfaceEmitCb): () => void;
+    send(method: string, params: unknown[], _?: boolean, subscription?: SubscriptionHandler): Promise<any>;
+    /**
+     * @summary Spawn a provider on the extension background.
+     */
+    startProvider(key: string): Promise<ProviderMeta>;
+    subscribe(type: string, method: string, params: unknown[], callback: AnyFunction): Promise<number>;
+    /**
+     * @summary Allows unsubscribing to subscriptions made with [[subscribe]].
+     */
+    unsubscribe(type: string, method: string, id: number): Promise<boolean>;
+}
+export {};

package/build/page/PostMessageProvider.js

@@ -0,0 +1,171 @@
+// Copyright 2019-2022 @subwallet/extension-base authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import EventEmitter from 'eventemitter3';
+import { isUndefined, logger } from '@polkadot/util';
+const l = logger('PostMessageProvider');
+// External to class, this.# is not private enough (yet)
+let sendRequest;
+/**
+ * @name PostMessageProvider
+ *
+ * @description Extension provider to be used by dapps
+ */
+
+export default class PostMessageProvider {
+  #eventemitter; // Whether or not the actual extension background provider is connected
+
+  #isConnected = false; // Subscription IDs are (historically) not guaranteed to be globally unique;
+  // only unique for a given subscription method; which is why we identify
+  // the subscriptions based on subscription id + type
+
+  #subscriptions = {}; // {[(type,subscriptionId)]: callback}
+
+  /**
+   * @param {function}  sendRequest  The function to be called to send requests to the node
+   * @param {function}  subscriptionNotificationHandler  Channel for receiving subscription messages
+   */
+
+  constructor(_sendRequest) {
+    this.#eventemitter = new EventEmitter();
+    sendRequest = _sendRequest;
+  }
+  /**
+   * @description Returns a clone of the object
+   */
+
+
+  clone() {
+    return new PostMessageProvider(sendRequest);
+  }
+  /**
+   * @description Manually disconnect from the connection, clearing autoconnect logic
+   */
+  // eslint-disable-next-line @typescript-eslint/require-await
+
+
+  async connect() {
+    // FIXME This should see if the extension's state's provider can disconnect
+    console.error('PostMessageProvider.disconnect() is not implemented.');
+  }
+  /**
+   * @description Manually disconnect from the connection, clearing autoconnect logic
+   */
+  // eslint-disable-next-line @typescript-eslint/require-await
+
+
+  async disconnect() {
+    // FIXME This should see if the extension's state's provider can disconnect
+    console.error('PostMessageProvider.disconnect() is not implemented.');
+  }
+  /**
+   * @summary `true` when this provider supports subscriptions
+   */
+
+
+  get hasSubscriptions() {
+    // FIXME This should see if the extension's state's provider has subscriptions
+    return true;
+  }
+  /**
+   * @summary Whether the node is connected or not.
+   * @return {boolean} true if connected
+   */
+
+
+  get isConnected() {
+    return this.#isConnected;
+  }
+
+  listProviders() {
+    return sendRequest('pub(rpc.listProviders)', undefined);
+  }
+  /**
+   * @summary Listens on events after having subscribed using the [[subscribe]] function.
+   * @param  {ProviderInterfaceEmitted} type Event
+   * @param  {ProviderInterfaceEmitCb}  sub  Callback
+   * @return unsubscribe function
+   */
+
+
+  on(type, sub) {
+    this.#eventemitter.on(type, sub);
+    return () => {
+      this.#eventemitter.removeListener(type, sub);
+    };
+  } // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+
+  async send(method, params, _, subscription) {
+    if (subscription) {
+      const {
+        callback,
+        type
+      } = subscription;
+      const id = await sendRequest('pub(rpc.subscribe)', {
+        method,
+        params,
+        type
+      }, res => {
+        subscription.callback(null, res);
+      });
+      this.#subscriptions[`${type}::${id}`] = callback;
+      return id;
+    }
+
+    return sendRequest('pub(rpc.send)', {
+      method,
+      params
+    });
+  }
+  /**
+   * @summary Spawn a provider on the extension background.
+   */
+
+
+  async startProvider(key) {
+    // Disconnect from the previous provider
+    this.#isConnected = false;
+    this.#eventemitter.emit('disconnected');
+    const meta = await sendRequest('pub(rpc.startProvider)', key); // eslint-disable-next-line @typescript-eslint/no-floating-promises
+
+    sendRequest('pub(rpc.subscribeConnected)', null, connected => {
+      this.#isConnected = connected;
+
+      if (connected) {
+        this.#eventemitter.emit('connected');
+      } else {
+        this.#eventemitter.emit('disconnected');
+      }
+
+      return true;
+    });
+    return meta;
+  }
+
+  subscribe(type, method, params, callback) {
+    return this.send(method, params, false, {
+      callback,
+      type
+    });
+  }
+  /**
+   * @summary Allows unsubscribing to subscriptions made with [[subscribe]].
+   */
+
+
+  async unsubscribe(type, method, id) {
+    const subscription = `${type}::${id}`; // FIXME This now could happen with re-subscriptions. The issue is that with a re-sub
+    // the assigned id now does not match what the API user originally received. It has
+    // a slight complication in solving - since we cannot rely on the send id, but rather
+    // need to find the actual subscription id to map it
+
+    if (isUndefined(this.#subscriptions[subscription])) {
+      l.debug(() => `Unable to find active subscription=${subscription}`);
+      return false;
+    }
+
+    delete this.#subscriptions[subscription];
+    return this.send(method, [id]);
+  }
+
+}

package/build/page/Signer.d.ts

@@ -0,0 +1,8 @@
+import type { Signer as SignerInterface, SignerResult } from '@polkadot/api/types';
+import type { SignerPayloadJSON, SignerPayloadRaw } from '@polkadot/types/types';
+import type { SendRequest } from './types';
+export default class Signer implements SignerInterface {
+    constructor(_sendRequest: SendRequest);
+    signPayload(payload: SignerPayloadJSON): Promise<SignerResult>;
+    signRaw(payload: SignerPayloadRaw): Promise<SignerResult>;
+}

package/build/page/Signer.js

@@ -0,0 +1,35 @@
+// Copyright 2019-2022 @subwallet/extension-base authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+// External to class, this.# is not private enough (yet)
+let sendRequest;
+let nextId = 0;
+export default class Signer {
+  constructor(_sendRequest) {
+    sendRequest = _sendRequest;
+  }
+
+  async signPayload(payload) {
+    const id = ++nextId;
+    const result = await sendRequest('pub(extrinsic.sign)', payload); // we add an internal id (number) - should have a mapping from the
+    // extension id (string) -> internal id (number) if we wish to provide
+    // updated via the update functionality (noop at this point)
+
+    return { ...result,
+      id
+    };
+  }
+
+  async signRaw(payload) {
+    const id = ++nextId;
+    const result = await sendRequest('pub(bytes.sign)', payload);
+    return { ...result,
+      id
+    };
+  } // NOTE We don't listen to updates at all, if we do we can interpret the
+  // resuklt as provided by the API here
+  // public update (id: number, status: Hash | SubmittableResult): void {
+  //   // ignore
+  // }
+
+
+}

package/build/page/index.d.ts

@@ -0,0 +1,16 @@
+import type { MessageTypes, MessageTypesWithNoSubscriptions, MessageTypesWithNullRequest, MessageTypesWithSubscriptions, RequestTypes, ResponseTypes, SubscriptionMessageTypes, TransportResponseMessage } from '../background/types';
+import Injected from './Injected';
+export interface Handler {
+    resolve: (data?: any) => void;
+    reject: (error: Error) => void;
+    subscriber?: (data: any) => void;
+}
+export declare type Handlers = Record<string, Handler>;
+export declare function sendMessage<TMessageType extends MessageTypesWithNullRequest>(message: TMessageType): Promise<ResponseTypes[TMessageType]>;
+export declare function sendMessage<TMessageType extends MessageTypesWithNoSubscriptions>(message: TMessageType, request: RequestTypes[TMessageType]): Promise<ResponseTypes[TMessageType]>;
+export declare function sendMessage<TMessageType extends MessageTypesWithSubscriptions>(message: TMessageType, request: RequestTypes[TMessageType], subscriber: (data: SubscriptionMessageTypes[TMessageType]) => void): Promise<ResponseTypes[TMessageType]>;
+export declare function enable(origin: string): Promise<Injected>;
+export declare function redirectIfPhishing(): Promise<boolean>;
+export declare function handleResponse<TMessageType extends MessageTypes>(data: TransportResponseMessage<TMessageType> & {
+    subscription?: string;
+}): void;