@keetanetwork/anchor 0.0.3 → 0.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@keetanetwork/anchor",
-	"version": "0.0.3",
+	"version": "0.0.5",
 	"description": "KeetaNetwork Network Anchor",
 	"main": "client/index.js",
 	"scripts": {
@@ -20,6 +20,7 @@
 	"author": "LFG Payments, Inc",
 	"license": "SEE LICENSE IN LICENSE",
 	"type": "module",
+	"sideEffects": false,
 	"devDependencies": {
 		"@keetanetwork/eslint-config-typescript": "1.4.7",
 		"@keetanetwork/keetanet-node": "0.14.2",
@@ -32,8 +33,9 @@
 		"vitest": "3.2.4"
 	},
 	"dependencies": {
-		"@keetanetwork/currency-info": "1.1.1",
+		"@keetanetwork/currency-info": "1.2.5",
 		"@keetanetwork/keetanet-client": "0.14.2",
+		"decimal.js": "10.6.0",
 		"typia": "9.5.0"
 	},
 	"engines": {

package/services/fx/client.d.ts

@@ -0,0 +1,137 @@
+import { lib as KeetaNetLib } from '@keetanetwork/keetanet-client';
+import { getDefaultResolver } from '../../config.js';
+import type { UserClient as KeetaNetUserClient } from '@keetanetwork/keetanet-client';
+import type { Logger } from '../../lib/log/index.ts';
+import type Resolver from '../../lib/resolver.ts';
+import type { ServiceMetadata } from '../../lib/resolver.ts';
+import type { BrandedString } from '../../lib/utils/brand.ts';
+import type { ConversionInput, ConversionInputCanonical, KeetaFXAnchorEstimate, KeetaFXAnchorExchange, KeetaFXAnchorQuote, KeetaNetTokenPublicKeyString } from './common.ts';
+/**
+ * An opaque type that represents a provider ID.
+ */
+type ProviderID = BrandedString<'FXProviderID'>;
+type AccountOptions = {
+    /**
+     * The account to use for signing requests. If not provided, the
+     * account associated with the provided client will be used. If there
+     * is no account associated with the client, an error occurs.
+     */
+    signer?: InstanceType<typeof KeetaNetLib.Account>;
+    /**
+     * Account to perform changes on. If not provided, the account
+     * associated with the provided client will be used. If there is no
+     * account associated with the client, an error occurs.
+     */
+    account?: InstanceType<typeof KeetaNetLib.Account>;
+};
+/**
+ * The configuration options for the FX Anchor client.
+ */
+export type KeetaFXAnchorClientConfig = {
+    /**
+     * The ID of the client. This is used to identify the client in logs.
+     * If not provided, a random ID will be generated.
+     */
+    id?: string;
+    /**
+     * The logger to use for logging messages. If not provided, no logging
+     * will be done.
+     */
+    logger?: Logger;
+    /**
+     * The resolver to use for resolving FX Anchor services. If not
+     * provided, a default resolver will be created using the provided
+     * client and network (if the network is also not provided and the
+     * client is not a UserClient, an error occurs).
+     */
+    resolver?: Resolver;
+    /**
+     * The account to use for signing requests. If not provided, the
+     * account associated with the provided client will be used. If there
+     * is no account associated with the client, an error occurs.
+     */
+    signer?: InstanceType<typeof KeetaNetLib.Account>;
+    /**
+     * Account to perform changes on. If not provided, the account
+     * associated with the provided client will be used. If there is no
+     * account associated with the client, an error occurs.
+     */
+    account?: InstanceType<typeof KeetaNetLib.Account>;
+} & Omit<NonNullable<Parameters<typeof getDefaultResolver>[1]>, 'client'> & AccountOptions;
+type KeetaFXAnchorOperations = {
+    [operation in keyof NonNullable<ServiceMetadata['services']['fx']>[string]['operations']]: (params?: {
+        [key: string]: string;
+    }) => URL;
+};
+type KeetaFXServiceInfo = {
+    operations: {
+        [operation in keyof KeetaFXAnchorOperations]: Promise<KeetaFXAnchorOperations[operation]>;
+    };
+    from: NonNullable<ServiceMetadata['services']['fx']>[string]['from'];
+};
+interface KeetaFXAnchorBaseConfig {
+    client: KeetaNetUserClient;
+    logger?: Logger | undefined;
+}
+declare class KeetaFXAnchorBase {
+    protected readonly logger?: Logger | undefined;
+    protected readonly client: KeetaNetUserClient;
+    constructor(config: KeetaFXAnchorBaseConfig);
+}
+declare class KeetaFXAnchorProviderBase extends KeetaFXAnchorBase {
+    readonly serviceInfo: KeetaFXServiceInfo;
+    readonly providerID: ProviderID;
+    readonly conversion: ConversionInputCanonical;
+    private readonly parent;
+    constructor(serviceInfo: KeetaFXServiceInfo, providerID: ProviderID, conversion: ConversionInputCanonical, parent: KeetaFXAnchorClient);
+    getEstimate(): Promise<KeetaFXAnchorEstimate>;
+    /**
+     * Get a quote from the provider.  If an estimate is provided, it will
+     * be used to validate the quote is within the tolerance range.
+     *
+     * @param estimate An optional estimate to validate the quote against
+     * @param tolerance The tolerance, in percentage points, to allow the
+     *                  quote to vary from the estimate.  For example, a
+     *                  tolerance of 1.0 allows the quote to be 100% more
+     *                  or less than the estimate.  The default is 0.10
+     *                  (10%).
+     * @returns A promise that resolves to the quote response
+     */
+    getQuote(estimate?: KeetaFXAnchorEstimate, tolerance?: number): Promise<KeetaFXAnchorQuote>;
+    createExchange(quote: KeetaFXAnchorQuote, block?: InstanceType<typeof KeetaNetLib.Block>): Promise<KeetaFXAnchorExchange>;
+    getExchangeStatus(exchangeID: string): Promise<KeetaFXAnchorExchange>;
+}
+declare class KeetaFXAnchorExchangeWithProvider {
+    private readonly provider;
+    readonly exchange: KeetaFXAnchorExchange;
+    constructor(provider: KeetaFXAnchorProviderBase, exchange: KeetaFXAnchorExchange);
+    getExchangeStatus(): Promise<KeetaFXAnchorExchange>;
+}
+declare class KeetaFXAnchorQuoteWithProvider {
+    private readonly provider;
+    readonly quote: KeetaFXAnchorQuote;
+    constructor(provider: KeetaFXAnchorProviderBase, quote: KeetaFXAnchorQuote);
+    createExchange(block?: InstanceType<typeof KeetaNetLib.Block>): Promise<KeetaFXAnchorExchangeWithProvider>;
+}
+declare class KeetaFXAnchorEstimateWithProvider {
+    private readonly provider;
+    readonly estimate: KeetaFXAnchorEstimate;
+    constructor(provider: KeetaFXAnchorProviderBase, estimate: KeetaFXAnchorEstimate);
+    getQuote(tolerance?: number): Promise<KeetaFXAnchorQuoteWithProvider>;
+}
+declare class KeetaFXAnchorClient extends KeetaFXAnchorBase {
+    #private;
+    readonly resolver: Resolver;
+    readonly id: string;
+    constructor(client: KeetaNetUserClient, config?: KeetaFXAnchorClientConfig);
+    private canonicalizeConversionTokens;
+    private canonicalizeConversionInput;
+    listPossibleConversions(input: Partial<Pick<ConversionInput, 'from' | 'to'>>, options?: AccountOptions): Promise<{
+        conversions: KeetaNetTokenPublicKeyString[];
+    } | null>;
+    getBaseProvidersForConversion(request: ConversionInput, options?: AccountOptions): Promise<KeetaFXAnchorProviderBase[] | null>;
+    getEstimates(request: ConversionInput, options?: AccountOptions): Promise<KeetaFXAnchorEstimateWithProvider[] | null>;
+    getQuotes(request: ConversionInput, options?: AccountOptions): Promise<KeetaFXAnchorQuoteWithProvider[] | null>;
+}
+export default KeetaFXAnchorClient;
+//# sourceMappingURL=client.d.ts.map

package/services/fx/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/services/fx/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,IAAI,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAInE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,KAAK,EACX,UAAU,IAAI,kBAAkB,EAChC,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,QAAQ,MAAM,uBAAuB,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAyB,MAAM,uBAAuB,CAAC;AAIpF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,KAAK,EACX,eAAe,EACf,wBAAwB,EACxB,qBAAqB,EAErB,qBAAqB,EAErB,kBAAkB,EAElB,4BAA4B,EAC5B,MAAM,aAAa,CAAC;AAIrB;;GAEG;AACH,KAAK,UAAU,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;AAEhD,KAAK,cAAc,GAAG;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;IAClD;;;;OAIG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACvC;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;;OAIG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;IAClD;;;;OAIG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;CACnD,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,cAAc,CAAC;AAO3F,KAAK,uBAAuB,GAAG;KAC7B,SAAS,IAAI,MAAM,WAAW,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,KAAK,GAAG;CACvI,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACzB,UAAU,EAAE;SACV,SAAS,IAAI,MAAM,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;KACzF,CAAC;IACF,IAAI,EAAE,WAAW,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;CACrE,CAAA;AAuGD,UAAU,uBAAuB;IAChC,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,cAAM,iBAAiB;IACtB,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;gBAElC,MAAM,EAAE,uBAAuB;CAI3C;AAED,cAAM,yBAA0B,SAAQ,iBAAiB;IACxD,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;IACzC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,wBAAwB,CAAC;IAC9C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAsB;gBAEjC,WAAW,EAAE,kBAAkB,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,EAAE,mBAAmB;IAUhI,WAAW,IAAI,OAAO,CAAC,qBAAqB,CAAC;IA+BnD;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,EAAE,SAAS,GAAE,MAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAmChG,cAAc,CAAC,KAAK,EAAE,kBAAkB,EAAE,KAAK,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAsDzH,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAiC3E;AAMD,cAAM,iCAAiC;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IACrD,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAAA;gBAE5B,QAAQ,EAAE,yBAAyB,EAAE,QAAQ,EAAE,qBAAqB;IAK1E,iBAAiB,IAAI,OAAO,CAAC,qBAAqB,CAAC;CAIzD;AAED,cAAM,8BAA8B;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IACrD,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;gBAEvB,QAAQ,EAAE,yBAAyB,EAAE,KAAK,EAAE,kBAAkB;IAKpE,cAAc,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,iCAAiC,CAAC;CAIhH;AAED,cAAM,iCAAiC;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IACrD,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAAC;gBAE7B,QAAQ,EAAE,yBAAyB,EAAE,QAAQ,EAAE,qBAAqB;IAK1E,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,8BAA8B,CAAC;CAI3E;AAED,cAAM,mBAAoB,SAAQ,iBAAiB;;IAClD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;gBAIR,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAE,yBAA8B;YAwBhE,4BAA4B;YAmC5B,2BAA2B;IAoBnC,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC;QAAE,WAAW,EAAE,4BAA4B,EAAE,CAAA;KAAE,GAAG,IAAI,CAAC;IAyC5K,6BAA6B,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,yBAAyB,EAAE,GAAG,IAAI,CAAC;IAelI,YAAY,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,iCAAiC,EAAE,GAAG,IAAI,CAAC;IAyBzH,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,8BAA8B,EAAE,GAAG,IAAI,CAAC;CAwCzH;AAED,eAAe,mBAAmB,CAAC"}