@sodax/wallet-sdk-core 0.0.1-rc.1

package/dist/index.d.ts

@@ -0,0 +1,291 @@
+import { ChainId, IEvmWalletProvider, EvmRawTransaction, EvmRawTransactionReceipt, ISuiWalletProvider, SuiTransaction, SuiExecutionResult, SuiPaginatedCoins, IIconWalletProvider, IcxCallTransaction, IconTransactionResult, InjectiveEoaAddress, IInjectiveWalletProvider, JsonObject, InjectiveRawTransaction, InjectiveCoin, InjectiveExecuteResponse, ISolanaWalletProvider, SolanaRpcResponseAndContext, SolanaSignatureResult, TransactionSignature, SolanaRawTransactionInstruction, SolanaSerializedTransaction, SolanaBase58PublicKey, Hex as Hex$1, XDR, IStellarWalletProvider, StellarRawTransactionReceipt } from '@sodax/types';
+import { Chain, PublicClient, WalletClient, Transport, Account, Hash as Hash$1, Address } from 'viem';
+import { SuiClient } from '@mysten/sui/client';
+import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
+import { Transaction } from '@mysten/sui/transactions';
+import { WalletWithFeatures, SuiWalletFeatures, WalletAccount } from '@mysten/wallet-standard';
+import { IconService, Wallet } from 'icon-sdk-js';
+import { MsgBroadcaster } from '@injectivelabs/wallet-core';
+import { PublicKey, Connection, Commitment, RpcResponseAndContext, TokenAmount } from '@solana/web3.js';
+import { SignerWalletAdapterProps } from '@solana/wallet-adapter-base';
+import { Keypair } from '@stellar/stellar-sdk';
+
+declare function getEvmViemChain(id: ChainId): Chain;
+declare class EvmWalletProvider implements IEvmWalletProvider {
+    private readonly walletClient;
+    readonly publicClient: PublicClient;
+    constructor(config: EvmWalletConfig);
+    sendTransaction(evmRawTx: EvmRawTransaction): Promise<Hash$1>;
+    waitForTransactionReceipt(txHash: Hash$1): Promise<EvmRawTransactionReceipt>;
+    getWalletAddress(): Promise<Address>;
+}
+/**
+ * EVM Wallet Configuration Types
+ */
+type PrivateKeyEvmWalletConfig = {
+    privateKey: `0x${string}`;
+    chainId: ChainId;
+    rpcUrl?: `http${string}`;
+};
+type BrowserExtensionEvmWalletConfig = {
+    walletClient: WalletClient<Transport, Chain, Account>;
+    publicClient: PublicClient;
+};
+type EvmWalletConfig = PrivateKeyEvmWalletConfig | BrowserExtensionEvmWalletConfig;
+/**
+ * EVM Type Guards
+ */
+declare function isPrivateKeyEvmWalletConfig(config: EvmWalletConfig): config is PrivateKeyEvmWalletConfig;
+declare function isBrowserExtensionEvmWalletConfig(config: EvmWalletConfig): config is BrowserExtensionEvmWalletConfig;
+
+type PrivateKeySuiWalletConfig = {
+    rpcUrl: string;
+    mnemonics: string;
+};
+type BrowserExtensionSuiWalletConfig = {
+    client: SuiClient;
+    wallet: WalletWithFeatures<Partial<SuiWalletFeatures>>;
+    account: WalletAccount;
+};
+type SuiWalletConfig = PrivateKeySuiWalletConfig | BrowserExtensionSuiWalletConfig;
+type PkSuiWallet = {
+    keyPair: Ed25519Keypair;
+};
+type BrowserExtensionSuiWallet = {
+    wallet: WalletWithFeatures<Partial<SuiWalletFeatures>>;
+    account: WalletAccount;
+};
+type SuiWallet = PkSuiWallet | BrowserExtensionSuiWallet;
+declare function isPkSuiWallet(wallet: SuiWallet): wallet is PkSuiWallet;
+declare function isBrowserExtensionSuiWallet(wallet: SuiWallet): wallet is BrowserExtensionSuiWallet;
+declare function isSuiWallet(wallet: SuiWallet): wallet is SuiWallet;
+declare class SuiWalletProvider implements ISuiWalletProvider {
+    private readonly client;
+    private readonly wallet;
+    constructor(walletConfig: SuiWalletConfig);
+    signAndExecuteTxn(txn: SuiTransaction): Promise<string>;
+    viewContract(tx: Transaction, packageId: string, module: string, functionName: string, args: unknown[], typeArgs?: string[]): Promise<SuiExecutionResult>;
+    getCoins(address: string, token: string): Promise<SuiPaginatedCoins>;
+    private getSuiAddress;
+    getWalletAddress(): Promise<string>;
+}
+
+declare class IconWalletProvider implements IIconWalletProvider {
+    private readonly wallet;
+    readonly iconService: IconService;
+    constructor(wallet: IconWalletConfig);
+    sendTransaction(tx: IcxCallTransaction): Promise<Hash>;
+    waitForTransactionReceipt(txHash: Hash): Promise<IconTransactionResult>;
+    getWalletAddress(): Promise<IconEoaAddress>;
+}
+/**
+ * Icon Types
+ */
+type IconJsonRpcVersion = '2.0';
+type Hex = `0x${string}`;
+type Hash = `0x${string}`;
+type IconAddress = `hx${string}` | `cx${string}`;
+type IconEoaAddress = `hx${string}`;
+type PrivateKeyIconWalletConfig = {
+    privateKey: `0x${string}`;
+    rpcUrl: `http${string}`;
+};
+type BrowserExtensionIconWalletConfig = {
+    walletAddress?: IconEoaAddress;
+    rpcUrl: `http${string}`;
+};
+type IconWalletConfig = PrivateKeyIconWalletConfig | BrowserExtensionIconWalletConfig;
+type IconPkWallet = {
+    type: 'PRIVATE_KEY';
+    wallet: Wallet;
+};
+type IconBrowserExtensionWallet = {
+    type: 'BROWSER_EXTENSION';
+    wallet?: IconEoaAddress;
+};
+type IconWallet = IconPkWallet | IconBrowserExtensionWallet;
+type HanaWalletRequestEvent = 'REQUEST_HAS_ACCOUNT' | 'REQUEST_HAS_ADDRESS' | 'REQUEST_ADDRESS' | 'REQUEST_JSON' | 'REQUEST_SIGNING' | 'REQUEST_JSON-RPC';
+type HanaWalletResponseEvent = 'RESPONSE_HAS_ACCOUNT' | 'RESPONSE_HAS_ADDRESS' | 'RESPONSE_ADDRESS' | 'RESPONSE_JSON-RPC' | 'RESPONSE_SIGNING' | 'CANCEL_SIGNING' | 'CANCEL_JSON-RPC';
+type ResponseAddressType = {
+    type: 'RESPONSE_ADDRESS';
+    payload: IconAddress;
+};
+type ResponseSigningType = {
+    type: 'RESPONSE_SIGNING';
+    payload: string;
+};
+type RelayRequestDetail = {
+    type: HanaWalletRequestEvent;
+    payload?: {
+        jsonrpc: IconJsonRpcVersion;
+        method: string;
+        params: unknown;
+        id: number | undefined;
+    };
+};
+type RelayRequestSigning = {
+    type: 'REQUEST_SIGNING';
+    payload: {
+        from: IconAddress;
+        hash: string;
+    };
+};
+type JsonRpcPayloadResponse = {
+    id: number;
+    result: string;
+};
+/**
+ * Icon Type Guards
+ */
+declare function isIconPkWallet(wallet: IconWallet): wallet is IconPkWallet;
+declare function isIconBrowserExtensionWallet(wallet: IconWallet): wallet is IconBrowserExtensionWallet;
+declare function isPrivateKeyIconWalletConfig(config: IconWalletConfig): config is PrivateKeyIconWalletConfig;
+declare function isBrowserExtensionIconWalletConfig(config: IconWalletConfig): config is BrowserExtensionIconWalletConfig;
+declare function isIconAddress(value: unknown): value is IconAddress;
+declare function isIconEoaAddress(value: unknown): value is IconEoaAddress;
+declare function isResponseAddressType(value: unknown): value is ResponseAddressType;
+declare function isResponseSigningType(value: unknown): value is ResponseSigningType;
+declare function isJsonRpcPayloadResponse(value: unknown): value is JsonRpcPayloadResponse;
+/**
+ * Methods to interact with Icon Browser Extension Wallet (e.g. Hana Wallet)
+ */
+declare function requestAddress(): Promise<IconAddress>;
+declare function requestSigning(from: IconAddress, hash: string): Promise<string>;
+declare function requestJsonRpc(rawTransaction: unknown, id?: number): Promise<JsonRpcPayloadResponse>;
+/**
+ * Icon Utils
+ */
+declare function BigNumberToBigInt(bigNumber: BigNumber): bigint;
+
+/**
+ * Injective Wallet Configuration Types
+ */
+type BrowserExtensionInjectiveWalletConfig = {
+    msgBroadcaster: MsgBroadcaster;
+    walletAddress: InjectiveEoaAddress | undefined;
+};
+type InjectiveWalletConfig = BrowserExtensionInjectiveWalletConfig;
+/**
+ * Injective Type Guards
+ */
+declare function isBrowserExtensionInjectiveWalletConfig(config: InjectiveWalletConfig): config is BrowserExtensionInjectiveWalletConfig;
+declare class InjectiveWalletProvider implements IInjectiveWalletProvider {
+    private msgBroadcaster;
+    walletAddress: InjectiveEoaAddress | undefined;
+    constructor(config: InjectiveWalletConfig);
+    getRawTransaction(chainId: string, _: string, senderAddress: string, contractAddress: string, msg: JsonObject, memo?: string): Promise<InjectiveRawTransaction>;
+    getWalletAddress(): Promise<InjectiveEoaAddress>;
+    execute(senderAddress: string, contractAddress: string, msg: JsonObject, funds?: InjectiveCoin[]): Promise<InjectiveExecuteResponse>;
+}
+
+interface WalletContextState {
+    publicKey: PublicKey | null;
+    signTransaction: SignerWalletAdapterProps['signTransaction'] | undefined;
+}
+type PrivateKeySolanaWalletConfig = {
+    privateKey: Uint8Array;
+    endpoint: string;
+};
+type BrowserExtensionSolanaWalletConfig = {
+    wallet: WalletContextState;
+    connection: Connection;
+};
+type SolanaWalletConfig = PrivateKeySolanaWalletConfig | BrowserExtensionSolanaWalletConfig;
+declare class SolanaWalletProvider implements ISolanaWalletProvider {
+    private readonly wallet;
+    readonly connection: Connection;
+    private readonly isAdapterMode;
+    constructor(walletConfig: SolanaWalletConfig);
+    waitForConfirmation(signature: string, commitment?: Commitment): Promise<SolanaRpcResponseAndContext<SolanaSignatureResult>>;
+    /**
+     * Send a raw transaction to the Solana network.
+     * @param rawTransaction - The raw transaction to send.
+     * @returns The transaction signature.
+     */
+    sendTransaction(rawTransaction: Uint8Array | Array<number>): Promise<TransactionSignature>;
+    /**
+     * Send a raw transaction to the Solana network and wait for confirmation.
+     * @param rawTransaction - The raw transaction to send.
+     * @param commitment - The commitment level to use. Defaults to 'finalized'.
+     * @returns The transaction signature.
+     */
+    sendTransactionWithConfirmation(rawTransaction: Uint8Array | Array<number>, commitment?: Commitment): Promise<TransactionSignature>;
+    /**
+     * Build a v0 versioned transaction.
+     * @param instructions - The instructions to include in the transaction.
+     * @returns The v0 transaction.
+     */
+    buildV0Txn(rawInstructions: SolanaRawTransactionInstruction[]): Promise<SolanaSerializedTransaction>;
+    private buildV0TxnWithAdapter;
+    private buildV0TxnWithKeypair;
+    getWalletBase58PublicKey(): SolanaBase58PublicKey;
+    getWalletAddress(): Promise<string>;
+    getAssociatedTokenAddress(mint: SolanaBase58PublicKey): Promise<SolanaBase58PublicKey>;
+    getBalance(publicKey: SolanaBase58PublicKey): Promise<number>;
+    getTokenAccountBalance(publicKey: SolanaBase58PublicKey): Promise<RpcResponseAndContext<TokenAmount>>;
+    private buildTransactionInstruction;
+}
+
+interface StellarWalletsKit {
+    getAddress(): Promise<{
+        address: string;
+    }>;
+    signTransaction(tx: XDR, options: {
+        networkPassphrase: string;
+    }): Promise<{
+        signedTxXdr: XDR;
+    }>;
+}
+type StellarNetwork = 'TESTNET' | 'PUBLIC';
+declare const STELLAR_ERROR_CODES: {
+    readonly INVALID_CONFIG: "INVALID_CONFIG";
+    readonly SIGN_TX_ERROR: "SIGN_TX_ERROR";
+    readonly TX_RECEIPT_TIMEOUT: "TX_RECEIPT_TIMEOUT";
+    readonly SEND_TX_ERROR: "SEND_TX_ERROR";
+    readonly INVALID_NETWORK: "INVALID_NETWORK";
+    readonly INVALID_PRIVATE_KEY: "INVALID_PRIVATE_KEY";
+};
+type StellarAddress = string;
+type PrivateKeyStellarWalletConfig = {
+    type: 'PRIVATE_KEY';
+    privateKey: Hex$1;
+    network: StellarNetwork;
+    rpcUrl?: string;
+};
+type BrowserExtensionStellarWalletConfig = {
+    type: 'BROWSER_EXTENSION';
+    walletsKit: StellarWalletsKit;
+    network: StellarNetwork;
+    rpcUrl?: string;
+};
+type StellarWalletConfig = PrivateKeyStellarWalletConfig | BrowserExtensionStellarWalletConfig;
+type StellarPkWallet = {
+    type: 'PRIVATE_KEY';
+    keypair: Keypair;
+};
+type StellarBrowserExtensionWallet = {
+    type: 'BROWSER_EXTENSION';
+    walletsKit: StellarWalletsKit;
+};
+type StellarWallet = StellarPkWallet | StellarBrowserExtensionWallet;
+declare class StellarWalletError extends Error {
+    readonly code: keyof typeof STELLAR_ERROR_CODES;
+    constructor(message: string, code: keyof typeof STELLAR_ERROR_CODES);
+}
+declare function isPrivateKeyStellarWalletConfig(config: StellarWalletConfig): config is PrivateKeyStellarWalletConfig;
+declare function isBrowserExtensionStellarWalletConfig(config: StellarWalletConfig): config is BrowserExtensionStellarWalletConfig;
+declare function isStellarPkWallet(wallet: StellarWallet): wallet is StellarPkWallet;
+declare function isStellarBrowserExtensionWallet(wallet: StellarWallet): wallet is StellarBrowserExtensionWallet;
+declare function isValidStellarNetwork(network: string): network is StellarNetwork;
+declare function isValidStellarPrivateKey(privateKey: string): boolean;
+declare class StellarWalletProvider implements IStellarWalletProvider {
+    private readonly wallet;
+    private readonly server;
+    private readonly networkPassphrase;
+    constructor(config: StellarWalletConfig);
+    getWalletAddress(): Promise<string>;
+    signTransaction(tx: XDR): Promise<XDR>;
+    waitForTransactionReceipt(txHash: string): Promise<StellarRawTransactionReceipt>;
+}
+
+export { BigNumberToBigInt, type BrowserExtensionEvmWalletConfig, type BrowserExtensionIconWalletConfig, type BrowserExtensionInjectiveWalletConfig, type BrowserExtensionSolanaWalletConfig, type BrowserExtensionStellarWalletConfig, type BrowserExtensionSuiWallet, type BrowserExtensionSuiWalletConfig, type EvmWalletConfig, EvmWalletProvider, type HanaWalletRequestEvent, type HanaWalletResponseEvent, type Hash, type Hex, type IconAddress, type IconBrowserExtensionWallet, type IconEoaAddress, type IconJsonRpcVersion, type IconPkWallet, type IconWallet, type IconWalletConfig, IconWalletProvider, type InjectiveWalletConfig, InjectiveWalletProvider, type JsonRpcPayloadResponse, type PkSuiWallet, type PrivateKeyEvmWalletConfig, type PrivateKeyIconWalletConfig, type PrivateKeySolanaWalletConfig, type PrivateKeyStellarWalletConfig, type PrivateKeySuiWalletConfig, type RelayRequestDetail, type RelayRequestSigning, type ResponseAddressType, type ResponseSigningType, type SolanaWalletConfig, SolanaWalletProvider, type StellarAddress, type StellarBrowserExtensionWallet, type StellarNetwork, type StellarPkWallet, type StellarWallet, type StellarWalletConfig, StellarWalletError, StellarWalletProvider, type SuiWallet, type SuiWalletConfig, SuiWalletProvider, getEvmViemChain, isBrowserExtensionEvmWalletConfig, isBrowserExtensionIconWalletConfig, isBrowserExtensionInjectiveWalletConfig, isBrowserExtensionStellarWalletConfig, isBrowserExtensionSuiWallet, isIconAddress, isIconBrowserExtensionWallet, isIconEoaAddress, isIconPkWallet, isJsonRpcPayloadResponse, isPkSuiWallet, isPrivateKeyEvmWalletConfig, isPrivateKeyIconWalletConfig, isPrivateKeyStellarWalletConfig, isResponseAddressType, isResponseSigningType, isStellarBrowserExtensionWallet, isStellarPkWallet, isSuiWallet, isValidStellarNetwork, isValidStellarPrivateKey, requestAddress, requestJsonRpc, requestSigning };