@requestnetwork/types 0.43.1-next.2033 → 0.43.1-next.2035

package/dist/currency-types.d.ts

@@ -1,3 +1,4 @@
+import * as RequestLogicTypes from './request-logic-types';
 /**
  * List of supported EVM chains
  */
@@ -20,4 +21,135 @@ export type ChainName = EvmChainName | BtcChainName | NearChainName | Declarativ
  * Virtual machin chains, where payment proxy contracts can be deployed
  */
 export type VMChainName = EvmChainName | NearChainName;
+/**
+ * Common types used in token configuration files
+ */
+type TokenAddress = string;
+type TokenDefinition = {
+    name: string;
+    symbol: string;
+    decimals: number;
+    id?: string;
+};
+export type TokenMap = Record<TokenAddress, TokenDefinition>;
+/**
+ * Common types used in chain configuration files
+ */
+export type Chain = {
+    chainId: number | string;
+    testnet?: boolean;
+    currencies?: TokenMap;
+};
+/**
+ * A native blockchain token (ETH, MATIC, ETH-rinkeby...)
+ */
+export type NativeCurrency = {
+    symbol: string;
+    decimals: number;
+    network: ChainName;
+};
+type NamedCurrency = {
+    name: string;
+};
+export type NamedNativeCurrency = NativeCurrency & NamedCurrency;
+/** Native Currency types */
+export type NativeCurrencyType = RequestLogicTypes.CURRENCY.BTC | RequestLogicTypes.CURRENCY.ETH;
+/**
+ * A Fiat currency (EUR, USD...)
+ */
+export type ISO4217Currency = {
+    symbol: string;
+    decimals: number;
+};
+/**
+ * An ERC20 token (DAI, USDT...)
+ */
+export type ERC20Currency = {
+    symbol: string;
+    decimals: number;
+    network: EvmChainName | NearChainName | DeclarativeChainName;
+    address: string;
+};
+/**
+ * An ERC777 SuperToken (DAIx, USDCx...)
+ */
+export type ERC777Currency = {
+    symbol: string;
+    decimals: number;
+    network: EvmChainName;
+    address: string;
+};
+/**
+ * The minimum properties of a native Currency
+ */
+export type NativeCurrencyInput = {
+    type: RequestLogicTypes.CURRENCY.ETH | RequestLogicTypes.CURRENCY.BTC;
+} & NativeCurrency;
+/**
+ * The minimum properties of an ISO4217 Currency
+ */
+export type ISO4217CurrencyInput = {
+    type: RequestLogicTypes.CURRENCY.ISO4217;
+} & ISO4217Currency;
+/**
+ * The minimum properties of an ERC20 Currency
+ */
+export type ERC20CurrencyInput = {
+    type: RequestLogicTypes.CURRENCY.ERC20;
+} & ERC20Currency;
+/**
+ * The minimum properties of an ERC777 Currency
+ */
+export type ERC777CurrencyInput = {
+    type: RequestLogicTypes.CURRENCY.ERC777;
+} & ERC777Currency;
+/**
+ * The minimum properties of a Currency
+ */
+export type CurrencyInput = NativeCurrencyInput | ISO4217CurrencyInput | ERC20CurrencyInput | ERC777CurrencyInput;
+/**
+ * The description of Currency, its core properties and some computed properties.
+ * `meta` enables applications to add any metadata they need to a Currency
+ */
+export type CurrencyDefinition<TMeta = unknown> = CurrencyInput & {
+    id: string;
+    hash: string;
+    meta: TMeta;
+};
+/**
+ * Alias for ICurrency for clarity in the context
+ */
+export type StorageCurrency = RequestLogicTypes.ICurrency;
+/**
+ * A Currency manager handles a list of currencies and provides utility to retrieve and change format
+ */
+export interface ICurrencyManager<TMeta = unknown> {
+    from(symbolOrAddress: string, network?: string): CurrencyDefinition<TMeta> | undefined;
+    fromAddress(address: string, network?: string): CurrencyDefinition<TMeta> | undefined;
+    fromSymbol(symbol: string, network?: string): CurrencyDefinition<TMeta> | undefined;
+    fromHash(hash: string, network?: string): CurrencyDefinition<TMeta> | undefined;
+    fromStorageCurrency(currency: StorageCurrency): CurrencyDefinition<TMeta> | undefined;
+    getNativeCurrency(type: NativeCurrencyType, network: string): CurrencyDefinition<TMeta> | undefined;
+    getConversionPath(from: Pick<CurrencyDefinition, 'hash'>, to: Pick<CurrencyDefinition, 'hash'>, network: string): string[] | null;
+    supportsConversion(currency: Pick<CurrencyDefinition, 'hash'>, network: string): boolean;
+    validateAddress(address: string, currency: CurrencyInput | StorageCurrency): boolean;
+    validateCurrency(currency: StorageCurrency): boolean;
+}
+/**
+ * A mapping from old to new name for a given currency.
+ *
+ * Format  { "chainName": {"TOKEN": ["NEW_TOKEN","NEW_CHAIN"]}}
+ */
+export type LegacyTokenMap = Record<string, Record<string, [string, ChainName]>>;
+/**
+ * currencyFrom => currencyTo => cost
+ */
+export type CurrencyPairs = Record<string, Record<string, number>>;
+/**
+ * Aggregators maps define pairs of currencies for which an onchain oracle exists, by network.
+ *
+ * Network => currencyFrom => currencyTo => cost
+ */
+export type AggregatorsMap<T extends ChainName = ChainName> = Partial<Record<T, CurrencyPairs>>;
+export {};
 //# sourceMappingURL=currency-types.d.ts.map

package/dist/currency-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"currency-types.d.ts","sourceRoot":"","sources":["../src/currency-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,cAAc,GACd,kBAAkB,GAClB,WAAW,GACX,MAAM,GACN,KAAK,GACL,SAAS,GACT,MAAM,GACN,MAAM,GACN,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,gBAAgB,GAChB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,UAAU,GACV,SAAS,GACT,SAAS,GACT,SAAS,GACT,OAAO,GACP,OAAO,GACP,WAAW,GACX,MAAM,GACN,kBAAkB,GAClB,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,gBAAgB,GAAG,MAAM,GAAG,cAAc,CAAC;AAElF,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,oBAAoB,CAAC;AAE3F;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,aAAa,CAAC"}
+{"version":3,"file":"currency-types.d.ts","sourceRoot":"","sources":["../src/currency-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,iBAAiB,MAAM,uBAAuB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,cAAc,GACd,kBAAkB,GAClB,WAAW,GACX,MAAM,GACN,KAAK,GACL,SAAS,GACT,MAAM,GACN,MAAM,GACN,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,gBAAgB,GAChB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,UAAU,GACV,SAAS,GACT,SAAS,GACT,SAAS,GACT,OAAO,GACP,OAAO,GACP,WAAW,GACX,MAAM,GACN,kBAAkB,GAClB,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,gBAAgB,GAAG,MAAM,GAAG,cAAc,CAAC;AAElF,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,oBAAoB,CAAC;AAE3F;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,aAAa,CAAC;AAEvD;;GAEG;AACH,KAAK,YAAY,GAAG,MAAM,CAAC;AAC3B,KAAK,eAAe,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACvF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,QAAQ,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,SAAS,CAAC;CACpB,CAAC;AACF,KAAK,aAAa,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AACtC,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,aAAa,CAAC;AAEjE,4BAA4B;AAC5B,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,GAAG,GAAG,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC;AAEjG;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,YAAY,GAAG,aAAa,GAAG,oBAAoB,CAAC;IAC7D,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,YAAY,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,GAAG,GAAG,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC;CACvE,GAAG,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC;CAC1C,GAAG,eAAe,CAAC;AAEpB;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC;CACxC,GAAG,aAAa,CAAC;AAElB;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC;CACzC,GAAG,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,mBAAmB,GACnB,oBAAoB,GACpB,kBAAkB,GAClB,mBAAmB,CAAC;AAExB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,KAAK,GAAG,OAAO,IAAI,aAAa,GAAG;IAChE,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,iBAAiB,CAAC,SAAS,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,KAAK,GAAG,OAAO;IAC/C,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IACvF,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IACtF,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IACpF,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAChF,mBAAmB,CAAC,QAAQ,EAAE,eAAe,GAAG,kBAAkB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IACtF,iBAAiB,CACf,IAAI,EAAE,kBAAkB,EACxB,OAAO,EAAE,MAAM,GACd,kBAAkB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IACzC,iBAAiB,CACf,IAAI,EAAE,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,EACtC,EAAE,EAAE,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,EACpC,OAAO,EAAE,MAAM,GACd,MAAM,EAAE,GAAG,IAAI,CAAC;IACnB,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;IACzF,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,GAAG,eAAe,GAAG,OAAO,CAAC;IACrF,gBAAgB,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@requestnetwork/types",
-  "version": "0.43.1-next.2033+422fff49",
+  "version": "0.43.1-next.2035+cb6dee00",
   "publishConfig": {
     "access": "public"
   },
@@ -45,5 +45,5 @@
     "typed-emitter": "2.1.0",
     "typescript": "5.1.3"
   },
-  "gitHead": "422fff4952840071d758d1bfe4a037fb6410dd5d"
+  "gitHead": "cb6dee00dcae850e9cd5ceb805c868538897315b"
 }