swaply-sdk-ts 0.0.1

package/eslint.config.ts

@@ -0,0 +1,139 @@
+import tsPlugin from '@typescript-eslint/eslint-plugin';
+import prettier from 'eslint-plugin-prettier';
+import simpleImportSort from 'eslint-plugin-simple-import-sort';
+import unicorn from 'eslint-plugin-unicorn';
+import unusedImports from 'eslint-plugin-unused-imports';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+    {
+        ignores: ['dist', 'node_modules', 'src/tests'],
+    },
+    {
+        files: ['**/*.{ts,tsx}'],
+        languageOptions: {
+            ecmaVersion: 2020,
+            sourceType: 'module',
+            parser: tseslint.parser,
+            parserOptions: {
+                project: './tsconfig.json',
+            },
+            globals: globals.browser,
+        },
+        plugins: {
+            '@typescript-eslint': tsPlugin,
+            prettier,
+            unicorn,
+            'simple-import-sort': simpleImportSort,
+            'unused-imports': unusedImports,
+        },
+        rules: {
+            ...tsPlugin.configs.recommended.rules,
+            ...unicorn.configs.recommended.rules,
+            'prettier/prettier': ['warn', { tabWidth: 4, singleQuote: true }],
+            'import/order': 'off',
+            'sort-imports': 'off',
+            'simple-import-sort/imports': [
+                'error',
+                {
+                    groups: [
+                        [String.raw`^\u0000`], // side effects
+                        ['^node:'],
+                        [String.raw`^@?(?!app|api|components|static|store|images)[\w-]`], // external
+                        ['^@components/', '^@app/', '^@api/', '^@store/', '^@/'], // internal
+                        ['^@static/', '^@images/'], // assets
+                        [
+                            String.raw`^\.\.(?!/?$)`,
+                            String.raw`^\./(?=.*/)`,
+                            String.raw`^\.(?!/?$)`,
+                            String.raw`^\./?$`,
+                        ], // local
+                        [String.raw`^.+\.s?css$`], // styles
+                    ],
+                },
+            ],
+            'simple-import-sort/exports': 'error',
+            'unused-imports/no-unused-imports': 'error',
+            'unused-imports/no-unused-vars': [
+                'warn',
+                {
+                    vars: 'all',
+                    varsIgnorePattern: '^_',
+                    args: 'after-used',
+                    argsIgnorePattern: '^_',
+                },
+            ],
+            '@typescript-eslint/naming-convention': [
+                'warn',
+                {
+                    selector: 'variable',
+                    format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+                    leadingUnderscore: 'allow',
+                },
+                {
+                    selector: 'function',
+                    format: ['camelCase', 'PascalCase'],
+                },
+            ],
+            semi: ['warn', 'always'],
+            'no-console': 'error',
+            'padding-line-between-statements': [
+                'warn',
+                { blankLine: 'always', prev: '*', next: 'return' },
+            ],
+            'spaced-comment': ['error', 'always', { markers: ['/'] }],
+            '@typescript-eslint/no-misused-new': 'error',
+            'consistent-return': 'off',
+            'guard-for-in': 'error',
+            'no-constructor-return': 'error',
+            'no-else-return': 'error',
+            'no-eval': 'error',
+            'no-extend-native': 'error',
+            'no-extra-bind': 'error',
+            'no-floating-decimal': 'error',
+            'no-implicit-globals': 'error',
+            'no-new': 'error',
+            'no-script-url': 'error',
+            'max-depth': ['error', 3],
+            'max-nested-callbacks': ['error', 3],
+            'new-cap': 'error',
+            'no-multi-assign': 'error',
+            'no-multiple-empty-lines': 'error',
+            'no-nested-ternary': 'error',
+            'no-trailing-spaces': 'error',
+            'no-underscore-dangle': 'error',
+            'no-whitespace-before-property': 'error',
+            'object-curly-spacing': ['error', 'always'],
+            'operator-assignment': ['error', 'always'],
+            'padded-blocks': ['error', 'never'],
+            'semi-spacing': 'error',
+            'semi-style': ['error', 'last'],
+            'space-before-blocks': 'error',
+            'space-in-parens': ['error', 'never'],
+            'space-unary-ops': 'error',
+            'switch-colon-spacing': 'error',
+            'array-bracket-spacing': ['error', 'never'],
+            'block-spacing': 'error',
+            camelcase: 'off',
+            'unicorn/prefer-switch': ['error', { minimumCases: 3 }],
+            'unicorn/filename-case': 'off',
+            'unicorn/prefer-query-selector': 'off',
+            'unicorn/prevent-abbreviations': 'off',
+            'unicorn/no-null': 'off',
+            'unicorn/consistent-function-scoping': 'off',
+            'unicorn/prefer-logical-operator-over-ternary': 'off',
+            'unicorn/no-static-only-class': 'off',
+            'unicorn/prefer-ternary': 'off',
+            'unicorn/prefer-global-this': 'off',
+            'unicorn/no-negated-condition': 'off',
+            'unicorn/prefer-spread': 'off',
+            '@typescript-eslint/no-unused-expressions': 'off',
+            '@typescript-eslint/no-explicit-any': 'off',
+            'unicorn/prefer-string-replace-all': 'off',
+            '@typescript-eslint/no-duplicate-enum-values': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
+            'react-hooks/exhaustive-deps': 'off',
+        },
+    },
+);

package/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "swaply-sdk-ts",
+    "version": "0.0.1",
+    "type": "module",
+    "module": "src/index.ts",
+    "dependencies": {
+        "axios": "^1.13.4",
+        "viem": "^2.45.0"
+    },
+    "devDependencies": {
+        "@eslint/js": "9.25.1",
+        "@types/bun": "latest",
+        "@types/node": "22.15.16",
+        "@types/react": "19.0.10",
+        "@types/react-dom": "19.0.4",
+        "@typescript-eslint/eslint-plugin": "8.31.0",
+        "@typescript-eslint/parser": "8.31.0",
+        "@vitejs/plugin-react": "4.3.4",
+        "eslint": "9.25.1",
+        "eslint-plugin-prettier": "5.2.6",
+        "eslint-plugin-simple-import-sort": "12.1.1",
+        "eslint-plugin-unicorn": "58.0.0",
+        "eslint-plugin-unused-imports": "4.1.4",
+        "typescript-eslint": "8.26.1"
+    },
+    "peerDependencies": {
+        "typescript": "^5.0.0"
+    }
+}

package/src/apiClient.ts

@@ -0,0 +1,123 @@
+import axios from 'axios';
+import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+import type {
+    Quote,
+    CreateIntentData,
+    IntentStatus,
+    PublicSwapWithAdditionalInfo,
+    PaginatedResponse,
+    Network,
+    Token,
+    SwapType,
+    SignedApproval,
+} from './types';
+
+export class SwaplyApiClient {
+    private client: AxiosInstance;
+    private apiUrl: string;
+
+    constructor(apiUrl: string, apiKey: string, config?: AxiosRequestConfig) {
+        this.apiUrl = apiUrl;
+        this.client = axios.create({
+            baseURL: apiUrl,
+            headers: {
+                'x-api-key': apiKey,
+            },
+            ...config,
+        });
+    }
+
+    async getQuote(
+        sourceChain: number,
+        sourceToken: string,
+        destChain: number,
+        destToken: string,
+        amount: number,
+        slippageBps: bigint,
+        swapType: SwapType,
+        retailUserId: string | null = null,
+    ): Promise<Quote> {
+        const response: AxiosResponse<Quote> = await this.client.post('/quotes/best', {
+            source_chain: sourceChain,
+            source_token: sourceToken,
+            dest_chain: destChain,
+            dest_token: destToken,
+            amount,
+            slippage_bps: slippageBps.toString(),
+            swap_type: swapType,
+            retail_user_id: retailUserId,
+        });
+        return response.data;
+    }
+
+    async createIntent(
+        quoteId: string,
+        userSourcePublicKey: string,
+        userSourceAddress: string,
+        userDestinationAddress: string,
+        refundAddress: string,
+    ): Promise<CreateIntentData> {
+        const response: AxiosResponse<CreateIntentData> = await this.client.post(
+            '/intents/create',
+            {
+                quote_id: quoteId,
+                user_source_public_key: userSourcePublicKey,
+                user_source_address: userSourceAddress,
+                user_destination_address: userDestinationAddress,
+                refund_address: refundAddress,
+            },
+        );
+        return response.data;
+    }
+
+    async addApproval(signedData: SignedApproval, intentId: string): Promise<void> {
+        await this.client.post(`/intents/${intentId}/approvals`, signedData);
+    }
+
+    async getIntentStatus(intentId: string): Promise<IntentStatus> {
+        const response: AxiosResponse<{ status: IntentStatus }> = await this.client.get(
+            `/intents/${intentId}/status`,
+        );
+        return response.data.status;
+    }
+
+    async listRetailUserHistory(
+        walletAddressOrRetailId: string,
+    ): Promise<PaginatedResponse<PublicSwapWithAdditionalInfo>> {
+        const response: AxiosResponse<PaginatedResponse<PublicSwapWithAdditionalInfo>> =
+            await this.client.get(`/history/${walletAddressOrRetailId}`);
+        return response.data;
+    }
+
+    async getSwapByIntentId(intentId: string): Promise<PublicSwapWithAdditionalInfo> {
+        const response: AxiosResponse<PublicSwapWithAdditionalInfo> = await this.client.get(
+            `/swaps/intents/${intentId}`,
+        );
+        return response.data;
+    }
+
+    async listNetworks(token?: string): Promise<Network[]> {
+        const endpoint = token ? `/networks?token=${token}` : '/networks';
+        const response: AxiosResponse<Network[]> = await this.client.get(endpoint);
+        return response.data;
+    }
+
+    async listTokens(
+        limit: number = 20,
+        offset: number = 0,
+        q?: string,
+        networkId?: number,
+    ): Promise<PaginatedResponse<Token>> {
+        let endpoint = `/tokens?limit=${limit}&offset=${offset}`;
+        if (q) {
+            endpoint += `&q=${q}`;
+        }
+        if (networkId) {
+            endpoint += `&network_id=${networkId}`;
+        }
+        const response: AxiosResponse<PaginatedResponse<Token>> = await this.client.get(endpoint);
+        return response.data;
+    }
+}
+
+export default SwaplyApiClient;

package/src/approvals.ts

@@ -0,0 +1,38 @@
+import { SwapType, type Permit2ApprovalToSign, type Quote } from './types';
+
+export const signPermit2Approval = async (
+    permit2Approval: Permit2ApprovalToSign,
+    quote: Quote,
+    userAddress: string,
+    signTypedData: (typedData: any) => Promise<string>,
+) => {
+    const permit2Data = permit2Approval.additional_data;
+    const domain = {
+        name: permit2Data.domain.name,
+        chainId: permit2Data.domain.chain_id,
+        verifyingContract: permit2Data.domain.verifying_contract,
+    };
+
+    const witness = permit2Data.witness;
+
+    const message = {
+        permitted: {
+            token: quote.source_token,
+            amount: BigInt(quote.source_amount_lots),
+        },
+        spender: permit2Approval.escrow_contract_address,
+        nonce: permit2Approval.nonce,
+        deadline: permit2Approval.deadline,
+        witness,
+    };
+
+    const signature = await signTypedData({
+        domain,
+        types: permit2Data.types,
+        primaryType: 'PermitWitnessTransferFrom',
+        message,
+        account: userAddress,
+    });
+
+    return signature;
+};

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './apiClient';
+export * from './approvals';
+export * from './types';

package/src/types.ts

@@ -0,0 +1,154 @@
+export enum SwapType {
+    Standard = 'Standard',
+    Optimized = 'Optimized',
+}
+
+export enum IntentStatus {
+    Initiated = 'Initiated',
+    ApprovalAdded = 'ApprovalAdded',
+    Accepted = 'Accepted',
+    Declined = 'Declined',
+    DeclinedDueToKytCheck = 'DeclinedDueToKytCheck',
+    UserDeposited = 'UserDeposited',
+    KycRequested = 'KycRequested',
+    Fulfilled = 'Fulfilled',
+    Expired = 'Expired',
+    RefundRequested = 'RefundRequested',
+    Refunded = 'Refunded',
+}
+
+export enum NetworkType {
+    EVM = 'EVM',
+    TRON = 'TRON',
+    BITCOIN = 'BITCOIN',
+    SOLANA = 'SOLANA',
+}
+
+export interface Quote {
+    id: string;
+    resolver_id: string;
+    source_chain: number;
+    source_token: string;
+    dest_chain: number;
+    dest_token: string;
+    intermediate_token: string | null;
+    intermediate_token_amount_min: string | null;
+    intermediate_token_amount_max: string | null;
+    intermediate_token_decimals: number | null;
+    source_amount_lots: string;
+    source_amount_decimals: number;
+    min_dest_amount_lots: string;
+    max_dest_amount_lots: string;
+    dest_amount_decimals: number;
+    slippage_bps: string;
+    expiry: number;
+    swap_type: SwapType;
+}
+
+export interface CreateIntentData {
+    intent_id: string;
+    deadline_secs: number;
+    secret_hash: `0x${string}`;
+    data: ApprovalToSign;
+}
+
+export interface ApprovalToSign {
+    approval_mechanism: string;
+    params_to_sign: Permit2ApprovalToSign | HtlcApprovalToSign | CosignApprovalToSign;
+}
+
+export interface SignedApproval {
+    type: 'Permit2' | 'Htlc' | 'Cosign';
+    signed_data: string | Record<string, string>;
+}
+
+export interface Permit2ApprovalToSign {
+    escrow_contract_address: string;
+    permit2_contract_address: string;
+    resolver_deposit_address: string;
+    nonce: number;
+    deadline: number;
+    additional_data: {
+        domain: {
+            name: string;
+            chain_id: number;
+            verifying_contract: string;
+        };
+        types: Record<string, { name: string; typ: string }>;
+        witness: Record<string, unknown>;
+        witness_type_string: string;
+        witness_hash: `0x${string}`;
+    };
+}
+
+export interface HtlcApprovalToSign {
+    psbt: string;
+    inputs: number[];
+}
+
+export interface CosignApprovalToSign {
+    transaction: string;
+}
+
+export interface IntentStatusResponse {
+    status: IntentStatus;
+}
+
+export interface PublicSwapWithAdditionalInfo {
+    intent_id: string;
+    status: IntentStatus;
+    kyc_link: string | null;
+    swap_metadata: SwapMetadata | null;
+    source_amount_decimals: number;
+    source_amount_lots: string;
+    source_chain: number;
+    source_token: string;
+    dest_amount_decimals: number;
+    dest_chain: number;
+    dest_token: string;
+    min_dest_amount_lots: string;
+    max_dest_amount_lots: string;
+}
+
+export interface SwapMetadata {
+    id: string;
+    proxy_address: string;
+    user_deposit_tx: string | null;
+    fulfill_tx: string | null;
+    swap_tx: string | null;
+    created_at: Date;
+    user_deposited_at: Date | null;
+    kyc_requested_at: Date | null;
+    fulfilled_at: Date | null;
+    withdrawn_at: Date | null;
+    swapped_at: Date | null;
+    refunded_at: Date | null;
+}
+
+export interface PaginatedResponse<T> {
+    pagination: {
+        total: number;
+        limit: number;
+        offset: number;
+        pages: number;
+    };
+    data: T[];
+}
+
+export interface Network {
+    id: number;
+    name: string;
+    type: NetworkType;
+    supports_optimized_swap: boolean;
+    icon_url: string;
+    supports_custom_tokens: boolean;
+}
+
+export interface Token {
+    network_id: string;
+    name: string;
+    contract_address: string;
+    symbol: string;
+    icon_url: string;
+    wrapped_token_address: string | null;
+}

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+    "compilerOptions": {
+        // Enable latest features
+        "lib": ["ESNext", "DOM"],
+        "target": "ESNext",
+        "module": "ESNext",
+        "moduleDetection": "force",
+        "jsx": "react-jsx",
+        "allowJs": true,
+
+        // Bundler mode
+        "moduleResolution": "bundler",
+        "allowImportingTsExtensions": true,
+        "verbatimModuleSyntax": true,
+        "noEmit": true,
+
+        // Best practices
+        "strict": true,
+        "skipLibCheck": true,
+        "noFallthroughCasesInSwitch": true,
+
+        // Some stricter flags (disabled by default)
+        "noUnusedLocals": false,
+        "noUnusedParameters": false,
+        "noPropertyAccessFromIndexSignature": false,
+    },
+    "include": ["src", "eslint.config.ts"],
+}