@galacticcouncil/xc-cfg 2.9.0-pr379-bc66401 → 2.9.0

package/build/bridges/omni/constants.d.ts

@@ -0,0 +1,43 @@
+/** Omni bridge (NEAR One) mainnet api. */
+export declare const OMNI_BRIDGE_API = "https://mainnet.api.bridge.nearone.org/api/v3";
+/** NEAR MPC signer withdraw accounts derive under, Ed25519 domain. */
+export declare const OMNI_MPC_SIGNER = "v1.signer";
+export declare const OMNI_MPC_DOMAIN = 1;
+/**
+ * NEAR account a failed publish of a deposit refunds to.
+ *
+ * - The depositor has no NEAR account; the DAO pays them back by hand
+ * - Registered on every connector token
+ */
+export declare const OMNI_REFUND_TO = "hydration.sputnik-dao.near";
+/** Omni's name of a UTXO chain. */
+export type OmniUtxoChain = 'zcash';
+/**
+ * Our withdraw leg of a connector: Hydration → the UTXO chain.
+ *
+ * - The emitter settles over ntt to a NEAR account derived from the address
+ * - The withdraw contract signs that account's withdrawal to the address
+ */
+export interface OmniWithdrawal {
+    /** `UtxoEmitter` on Hydration. */
+    emitter: string;
+    /** `UtxoWithdraw` on NEAR, the derivation predecessor. */
+    contract: string;
+    /** Connector's `min_withdraw_amount`, smallest unit. */
+    minWithdraw: bigint;
+    /** Miner fee the withdraw contract fixes, smallest unit. */
+    minerFee: bigint;
+}
+export interface OmniConnector {
+    /** Omni's name of the chain. */
+    chain: OmniUtxoChain;
+    /** Connector contract on NEAR. */
+    account: string;
+    /** NEAR token a deposit is minted as. */
+    token: string;
+    /** Smallest unit; a smaller deposit is neither minted nor refunded. */
+    minDeposit: bigint;
+    withdrawal: OmniWithdrawal;
+}
+/** Mainnet connectors, by chain key; `minDeposit` mirrors `min_deposit_amount`. */
+export declare const OMNI_CONNECTORS: Record<string, OmniConnector>;

package/build/bridges/omni/index.d.ts

@@ -0,0 +1,2 @@
+export * from './constants';
+export * from './msg';

package/build/bridges/omni/msg.d.ts

@@ -0,0 +1,14 @@
+import { AnyChain } from '@galacticcouncil/xc-core';
+/**
+ * `msg` of the `ft_transfer_call` Omni's connector makes into a NEAR ntt
+ * manager.
+ *
+ * - Omni derives the deposit address from this exact string
+ * - The manager takes the recipient as 32 bytes, an ss58 one derived first
+ * - `refund_to` takes a failed publish's refund instead of the connector
+ *
+ * @param destination - chain the manager publishes to
+ * @param address - recipient on the destination
+ * @param refundTo - NEAR account a failed publish refunds
+ */
+export declare function getDepositMsg(destination: AnyChain, address: string, refundTo: string): Promise<string>;

package/build/bridges/omni/msg.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/builders/ContractBuilder.d.ts

@@ -1,4 +1,5 @@
 import { Erc20 } from './contracts/Erc20';
+import { Omni } from './contracts/Omni';
 import { PolkadotXcm } from './contracts/PolkadotXcm';
 import { Wormhole } from './contracts/Wormhole';
 export declare function ContractBuilder(): {
@@ -9,6 +10,7 @@ export declare function ContractBuilder(): {
     Basejump: () => {
         bridgeViaWormhole: () => import("@galacticcouncil/xc-core").ContractConfigBuilder;
     };
+    Omni: typeof Omni;
     PolkadotXcm: typeof PolkadotXcm;
     Snowbridge: () => {
         v2SendMessage: () => import("@galacticcouncil/xc-core").ContractConfigBuilder;

package/build/builders/DepositBuilder.d.ts

@@ -0,0 +1,4 @@
+import { Omni } from './deposits/Omni';
+export declare function DepositBuilder(): {
+    Omni: typeof Omni;
+};

package/build/builders/FeeAmountBuilder.d.ts

@@ -1,4 +1,4 @@
-import { AnyParachain, FeeAmountConfigBuilder, Parachain } from '@galacticcouncil/xc-core';
+import { AnyParachain, FeeAmountConfigBuilder, NearChain, Parachain } from '@galacticcouncil/xc-core';
 type SendFeeOpts = {
     hub: Parachain;
 };
@@ -30,8 +30,20 @@ declare function Wormhole(): {
 declare function Basejump(): {
     quoteFee: () => FeeAmountConfigBuilder;
 };
+declare function Omni(): {
+    /**
+     * Cut of a withdrawal to a UTXO chain, out of what lands.
+     *
+     * - Emitter fee, kept on the source for the bots' NEAR gas
+     * - Omni's bridge fee and the miner fee, taken on the way out
+     *
+     * @param hub - NEAR chain the transfer settles on
+     */
+    withdrawFee: (hub: NearChain) => FeeAmountConfigBuilder;
+};
 export declare function FeeAmountBuilder(): {
     Basejump: typeof Basejump;
+    Omni: typeof Omni;
     XcmPaymentApi: typeof XcmPaymentApi;
     Snowbridge: typeof Snowbridge;
     Wormhole: typeof Wormhole;

package/build/builders/contracts/Omni/UtxoEmitter.d.ts

@@ -0,0 +1,4 @@
+import { ContractConfigBuilder, NearChain } from '@galacticcouncil/xc-core';
+export declare const UtxoEmitter: () => {
+    send: (hub: NearChain) => ContractConfigBuilder;
+};

package/build/builders/contracts/Omni/index.d.ts

@@ -0,0 +1,5 @@
+export declare function Omni(): {
+    UtxoEmitter: () => {
+        send: (hub: import("@galacticcouncil/xc-core").NearChain) => import("@galacticcouncil/xc-core").ContractConfigBuilder;
+    };
+};

package/build/builders/deposits/Omni/Ntt.d.ts

@@ -0,0 +1,4 @@
+import { DepositConfigBuilder, NearChain } from '@galacticcouncil/xc-core';
+export declare const Ntt: () => {
+    transfer: (hub: NearChain) => DepositConfigBuilder;
+};

package/build/builders/deposits/Omni/index.d.ts

@@ -0,0 +1,5 @@
+export declare function Omni(): {
+    Ntt: () => {
+        transfer: (hub: import("@galacticcouncil/xc-core").NearChain) => import("@galacticcouncil/xc-core").DepositConfigBuilder;
+    };
+};

package/build/builders/index.d.ts

@@ -1,4 +1,5 @@
 export * from './ContractBuilder';
+export * from './DepositBuilder';
 export * from './ExtrinsicBuilder';
 export * from './FeeAmountBuilder';
 export * from './FeeAssetBuilder';

package/build/clients/index.d.ts

@@ -1,4 +1,5 @@
 export * from './base';
 export * from './chain';
 export * from './ntt';
+export * from './omni';
 export * from './wormhole';

package/build/clients/omni/OmniClient.d.ts

@@ -0,0 +1,72 @@
+import { AnyChain, NearChain } from '@galacticcouncil/xc-core';
+import { OmniConnector } from '../../bridges/omni';
+/** Connector's `get_config` view, raw. */
+export interface OmniConnectorConfig {
+    min_deposit_amount: string;
+    min_withdraw_amount: string;
+    refund_timelock_sec: number;
+    withdraw_bridge_fee: {
+        fee_min: string;
+        fee_rate: number;
+    };
+}
+/** Order Omni derives the deposit address from. */
+export interface OmniDepositOrder {
+    /** NEAR account the deposit is delivered to. */
+    recipient: string;
+    /** `ft_transfer_call` msg, byte for byte. */
+    msg: string;
+    /** Source chain address a refused deposit is refunded to. */
+    refundAddress: string;
+}
+/**
+ * Omni connector of a UTXO chain, over the mainnet api and the NEAR hub.
+ *
+ * - Registers orders with `skip_tx`, leaving no public NEAR record
+ * - Returns an address only once the connector's own view derives it
+ * - Caches deposit addresses and withdraw accounts; a failed one is retried
+ */
+export declare class OmniClient {
+    readonly source: AnyChain;
+    readonly hub: NearChain;
+    readonly connector: OmniConnector;
+    private readonly timeoutMs;
+    private readonly addresses;
+    private readonly accounts;
+    /**
+     * @param source - UTXO chain deposits are paid on
+     * @param hub - NEAR chain the connector is read from
+     * @param timeoutMs - per request timeout
+     */
+    constructor(source: AnyChain, hub: NearChain, timeoutMs?: number);
+    /** Live connector config. */
+    getConfig(): Promise<OmniConnectorConfig>;
+    /**
+     * Deposit address of the order.
+     *
+     * @param order - recipient, msg and refund address
+     */
+    getDepositAddress(order: OmniDepositOrder): Promise<string>;
+    /**
+     * NEAR account a withdrawal to `address` settles to.
+     *
+     * - The withdraw contract's `path_of`, then the MPC signer's key under it
+     * - Implicit: the account id is the key's hex
+     * - One address, one account, permanently
+     *
+     * @param address - destination on the UTXO chain, already valid
+     */
+    getWithdrawAccount(address: string): Promise<string>;
+    /**
+     * What Omni takes from a withdrawal on its way out, smallest unit.
+     *
+     * - Bridge fee, the connector's own formula: `max(amount × rate, min)`
+     * - Miner fee the withdraw contract fixes
+     *
+     * @param amount - landing on NEAR, smallest unit
+     */
+    getWithdrawFee(amount: bigint): Promise<bigint>;
+    private view;
+    private register;
+    private resolve;
+}

package/build/clients/omni/OmniClient.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/clients/omni/index.d.ts

@@ -0,0 +1,12 @@
+import { AnyChain, NearChain } from '@galacticcouncil/xc-core';
+import { OmniClient } from './OmniClient';
+export * from './OmniClient';
+/**
+ * Omni connector of a UTXO chain.
+ *
+ * - One client per chain, so an order's address is registered once
+ *
+ * @param source - UTXO chain deposits are paid on
+ * @param hub - NEAR chain the connector is read from
+ */
+export declare function omniClient(source: AnyChain, hub: NearChain): OmniClient;

package/build/configs/polkadot/hydration/templates.d.ts

@@ -1,4 +1,4 @@
-import { AnyChain, AnyParachain, Asset, AssetRoute, Parachain } from '@galacticcouncil/xc-core';
+import { AnyChain, AnyParachain, Asset, AssetRoute, NearChain, Parachain } from '@galacticcouncil/xc-core';
 import { XcmTransferType } from '../../../builders';
 export declare const GLMR_MIN_DEST_FEE = 1;
 export declare const HUB_EXT_USDT_DEST_FEE = 0.02;
@@ -15,6 +15,14 @@ export declare function toParaErc20Template(asset: Asset, destination: AnyParach
  * signer takes the `contract` and signs plain evm transactions.
  */
 export declare function viaNttTemplate(assetIn: Asset, assetOut: Asset, to: AnyChain): AssetRoute;
+/**
+ * Withdrawal to a UTXO chain through Omni, over the NEAR hub.
+ *
+ * - One call: the emitter settles to the NEAR account derived from the
+ *   address; bots redeem and withdraw from there
+ * - Emitter, bridge and miner fees come out of what lands
+ */
+export declare function viaOmniTemplate(asset: Asset, to: AnyChain, hub: NearChain): AssetRoute;
 /**
  * Executor-delivered variant, offered alongside the self-redeem route above
  * for the same pair - the sender pays for delivery instead of signing a

package/build/configs/zcash/index.d.ts

@@ -0,0 +1,2 @@
+import { ChainRoutes } from '@galacticcouncil/xc-core';
+export declare const zcashChainsConfig: ChainRoutes[];

package/build/configs/zcash/zcash.d.ts

@@ -0,0 +1,2 @@
+import { ChainRoutes } from '@galacticcouncil/xc-core';
+export declare const zcashConfig: ChainRoutes;

package/build/configs/zcash/zcash.spec.d.ts

@@ -0,0 +1 @@
+export {};