@dynamic-labs-sdk/stellar 0.0.0 → 1.16.1

package/README.md

@@ -0,0 +1,21 @@
+# @dynamic-labs-sdk/stellar
+
+This package contains the Stellar integration for the Dynamic SDK. It enables support for Stellar external wallets including Freighter, Lobstr, and OneKey.
+
+## Installation
+
+```sh
+pnpm add @dynamic-labs-sdk/stellar
+```
+
+## Usage
+
+```ts
+import { addStellarExtension } from '@dynamic-labs-sdk/stellar';
+import { createDynamicClient } from '@dynamic-labs-sdk/client';
+
+const dynamicClient = createDynamicClient({
+  environmentId: '123',
+});
+addStellarExtension(dynamicClient);
+```

package/dist/StellarNetworkProvider.types.d.ts

@@ -0,0 +1,8 @@
+import type { BaseNetworkProvider } from '@dynamic-labs-sdk/client/core';
+export type StellarNetworkProvider = BaseNetworkProvider<'STELLAR'>;
+declare global {
+    interface NetworkProviderMap {
+        STELLAR: StellarNetworkProvider;
+    }
+}
+//# sourceMappingURL=StellarNetworkProvider.types.d.ts.map

package/dist/StellarNetworkProvider.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StellarNetworkProvider.types.d.ts","sourceRoot":"","sources":["../src/StellarNetworkProvider.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAEzE,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;AAEpE,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,kBAAkB;QAC1B,OAAO,EAAE,sBAAsB,CAAC;KACjC;CACF"}

package/dist/StellarProvider.types.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Interface for Stellar wallet providers.
+ *
+ * This interface is designed to work with Stellar wallets that implement
+ * common wallet APIs. Major Stellar wallets include:
+ * Freighter, Lobstr, and OneKey.
+ *
+ * ## Core Features
+ * - **Connection Management**: Connect, disconnect, and account retrieval
+ * - **Network Support**: Network information and switching capabilities
+ * - **Transaction Signing**: Support for transaction and message signing
+ *
+ * @example
+ * ```typescript
+ * // Connect to wallet
+ * const publicKey = await provider.connect();
+ *
+ * // Sign a transaction
+ * const signedXdr = await provider.sign({ transactionXdr, options });
+ *
+ * // Sign a message
+ * const signature = await provider.signMessage({ message: "Hello Stellar" });
+ * ```
+ */
+export type IStellarProvider = {
+    /**
+     * Close the wallet connection.
+     * Optional: some wallets (e.g. Lobstr) expose no teardown API.
+     */
+    close?(): void;
+    /** Connect to the wallet and get the public key */
+    connect(): Promise<string>;
+    /**
+     * Disconnect from the wallet.
+     * Optional: some wallets (e.g. Lobstr) expose no disconnect API.
+     */
+    disconnect?(): Promise<void>;
+    /** Get the current network */
+    getNetwork(): Promise<string>;
+    /** Check if the wallet is unlocked */
+    isUnlocked(): Promise<boolean>;
+    /**
+     * Subscribe to wallet events.
+     * Optional: some wallets (e.g. Lobstr) expose no event subscription API.
+     */
+    on?(args: {
+        callback: StellarEventCallback;
+        event: StellarProviderEvent;
+    }): void;
+    /** Sign a Stellar transaction XDR */
+    sign(args: {
+        options?: StellarSignTransactionOptions;
+        transactionXdr: string;
+    }): Promise<string>;
+    /** Sign an arbitrary message */
+    signMessage(args: {
+        message: string;
+    }): Promise<string>;
+};
+/**
+ * Stellar provider event types
+ */
+export type StellarProviderEvent = 'accountChanged' | 'networkChanged';
+/**
+ * Stellar event callback type
+ */
+export type StellarEventCallback = (data: unknown) => void;
+/**
+ * Options for signing a Stellar transaction
+ */
+export type StellarSignTransactionOptions = {
+    /** Account public key (for multi-account wallets) */
+    accountToSign?: string;
+    /** Network to use ('PUBLIC' or 'TESTNET' or custom passphrase) */
+    network?: string;
+    /** Network passphrase */
+    networkPassphrase?: string;
+};
+/**
+ * Stellar network names
+ */
+export type StellarNetworkName = 'FUTURENET' | 'PUBLIC' | 'TESTNET';
+//# sourceMappingURL=StellarProvider.types.d.ts.map

package/dist/StellarProvider.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StellarProvider.types.d.ts","sourceRoot":"","sources":["../src/StellarProvider.types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;OAGG;IACH,KAAK,CAAC,IAAI,IAAI,CAAC;IACf,mDAAmD;IACnD,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,8BAA8B;IAC9B,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,sCAAsC;IACtC,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B;;;OAGG;IACH,EAAE,CAAC,CAAC,IAAI,EAAE;QACR,QAAQ,EAAE,oBAAoB,CAAC;QAC/B,KAAK,EAAE,oBAAoB,CAAC;KAC7B,GAAG,IAAI,CAAC;IACT,qCAAqC;IACrC,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,CAAC,EAAE,6BAA6B,CAAC;QACxC,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACpB,gCAAgC;IAChC,WAAW,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACzD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kEAAkE;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC"}

package/dist/StellarWalletAccount.types.d.ts

@@ -0,0 +1,8 @@
+import type { BaseWalletAccount } from '@dynamic-labs-sdk/client/core';
+export type StellarWalletAccount = BaseWalletAccount<'STELLAR'>;
+declare global {
+    interface WalletAccountMap {
+        STELLAR: StellarWalletAccount;
+    }
+}
+//# sourceMappingURL=StellarWalletAccount.types.d.ts.map

package/dist/StellarWalletAccount.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StellarWalletAccount.types.d.ts","sourceRoot":"","sources":["../src/StellarWalletAccount.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAEvE,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;AAEhE,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,gBAAgB;QACxB,OAAO,EAAE,oBAAoB,CAAC;KAC/B;CACF"}

package/dist/StellarWalletProvider.types.d.ts

@@ -0,0 +1,12 @@
+import type { WalletProvider } from '@dynamic-labs-sdk/client/core';
+import type { StellarWalletAccount } from './StellarWalletAccount.types';
+export type StellarWalletProvider = WalletProvider & {
+    chain: 'STELLAR';
+    signTransaction: (args: {
+        transactionXdr: string;
+        walletAccount: StellarWalletAccount;
+    }) => Promise<{
+        signedXdr: string;
+    }>;
+};
+//# sourceMappingURL=StellarWalletProvider.types.d.ts.map

package/dist/StellarWalletProvider.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StellarWalletProvider.types.d.ts","sourceRoot":"","sources":["../src/StellarWalletProvider.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAEpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEzE,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,KAAK,EAAE,SAAS,CAAC;IACjB,eAAe,EAAE,CAAC,IAAI,EAAE;QACtB,cAAc,EAAE,MAAM,CAAC;QACvB,aAAa,EAAE,oBAAoB,CAAC;KACrC,KAAK,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACtC,CAAC"}

package/dist/addStellarExtension/addStellarExtension.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Adds the Stellar extension to the Dynamic client.
+ *
+ * This is a convenience function that adds support for Stellar wallets,
+ * including Freighter, Lobstr, and OneKey.
+ *
+ * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @notInstrumented
+ */
+export declare const addStellarExtension: (client?: import("@dynamic-labs-sdk/client").DynamicClient) => void;
+//# sourceMappingURL=addStellarExtension.d.ts.map

package/dist/addStellarExtension/addStellarExtension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addStellarExtension.d.ts","sourceRoot":"","sources":["../../src/addStellarExtension/addStellarExtension.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,iEAAkC,IAEjE,CAAC"}

package/dist/addStellarExtension/index.d.ts

@@ -0,0 +1,2 @@
+export { addStellarExtension } from './addStellarExtension';
+//# sourceMappingURL=index.d.ts.map

package/dist/addStellarExtension/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/addStellarExtension/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/errors/FetchStellarBalanceError/FetchStellarBalanceError.d.ts

@@ -0,0 +1,9 @@
+import { BaseError } from '@dynamic-labs-sdk/client';
+export declare class FetchStellarBalanceError extends BaseError {
+    readonly address: string;
+    constructor(params: {
+        address: string;
+        cause?: Error | null;
+    });
+}
+//# sourceMappingURL=FetchStellarBalanceError.d.ts.map

package/dist/errors/FetchStellarBalanceError/FetchStellarBalanceError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchStellarBalanceError.d.ts","sourceRoot":"","sources":["../../../src/errors/FetchStellarBalanceError/FetchStellarBalanceError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,qBAAa,wBAAyB,SAAQ,SAAS;IACrD,SAAgB,OAAO,EAAE,MAAM,CAAC;gBAEpB,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE;CAW9D"}

package/dist/errors/FetchStellarBalanceError/index.d.ts

@@ -0,0 +1,2 @@
+export { FetchStellarBalanceError } from './FetchStellarBalanceError';
+//# sourceMappingURL=index.d.ts.map

package/dist/errors/FetchStellarBalanceError/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/errors/FetchStellarBalanceError/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/errors/NotOneKeyProviderError/NotOneKeyProviderError.d.ts

@@ -0,0 +1,5 @@
+import { BaseError } from '@dynamic-labs-sdk/client';
+export declare class NotOneKeyProviderError extends BaseError {
+    constructor();
+}
+//# sourceMappingURL=NotOneKeyProviderError.d.ts.map

package/dist/errors/NotOneKeyProviderError/NotOneKeyProviderError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotOneKeyProviderError.d.ts","sourceRoot":"","sources":["../../../src/errors/NotOneKeyProviderError/NotOneKeyProviderError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,qBAAa,sBAAuB,SAAQ,SAAS;;CAUpD"}

package/dist/errors/NotOneKeyProviderError/index.d.ts

@@ -0,0 +1,2 @@
+export { NotOneKeyProviderError } from './NotOneKeyProviderError';
+//# sourceMappingURL=index.d.ts.map

package/dist/errors/NotOneKeyProviderError/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/errors/NotOneKeyProviderError/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/errors/NotStellarProviderError/NotStellarProviderError.d.ts

@@ -0,0 +1,8 @@
+import { BaseError } from '@dynamic-labs-sdk/client';
+export declare class NotStellarProviderError extends BaseError {
+    readonly providerKey: string;
+    constructor(params: {
+        providerKey: string;
+    });
+}
+//# sourceMappingURL=NotStellarProviderError.d.ts.map

package/dist/errors/NotStellarProviderError/NotStellarProviderError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotStellarProviderError.d.ts","sourceRoot":"","sources":["../../../src/errors/NotStellarProviderError/NotStellarProviderError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,qBAAa,uBAAwB,SAAQ,SAAS;IACpD,SAAgB,WAAW,EAAE,MAAM,CAAC;gBAExB,MAAM,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE;CAW5C"}

package/dist/errors/NotStellarProviderError/index.d.ts

@@ -0,0 +1,2 @@
+export { NotStellarProviderError } from './NotStellarProviderError';
+//# sourceMappingURL=index.d.ts.map

package/dist/errors/NotStellarProviderError/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/errors/NotStellarProviderError/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/exports/index.d.ts

@@ -0,0 +1,7 @@
+export type { IStellarProvider, StellarProviderEvent, StellarEventCallback, StellarSignTransactionOptions, StellarNetworkName, } from '../StellarProvider.types';
+export type { StellarWalletAccount } from '../StellarWalletAccount.types';
+export { NotStellarProviderError } from '../errors/NotStellarProviderError';
+export { isStellarWalletAccount } from '../isStellarWalletAccount';
+export { addStellarExtension } from '../addStellarExtension';
+export { signTransaction } from '../signTransaction';
+//# sourceMappingURL=index.d.ts.map

package/dist/exports/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/exports/index.ts"],"names":[],"mappings":"AAQA,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,6BAA6B,EAC7B,kBAAkB,GACnB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC"}