@ember-finance/sdk 2.11.0-pre.1 → 2.11.0-pre.3

package/dist/src/api/v2/models/coin-placement.d.ts

@@ -15,12 +15,30 @@
  * @interface CoinPlacement
  */
 export interface CoinPlacement {
+    /**
+     * Stable identity for this placement, for a client to key a list on. A protocol can list the same coin at several venues — the same pair at two fee tiers, or the two tranches of one market — so protocol and label together do not identify a row. Survives a re-sync.
+     * @type {string}
+     * @memberof CoinPlacement
+     */
+    id: string;
     /**
      * Adapter id, e.g. \"bluefin-spot\"
      * @type {string}
      * @memberof CoinPlacement
      */
     protocol: string;
+    /**
+     * The protocol\'s display name, e.g. \"Current Finance\". Absent when the protocol is not in our catalogue yet — render `protocol` then.
+     * @type {string}
+     * @memberof CoinPlacement
+     */
+    protocolName?: string;
+    /**
+     * Icon for the protocol. Absent when the protocol is not in our catalogue yet.
+     * @type {string}
+     * @memberof CoinPlacement
+     */
+    protocolLogoUrl?: string;
     /**
      * Chain identifier as catalogued, e.g. \"sui-mainnet\".
      * @type {string}

package/dist/src/placements/adapters/evm-protocols.d.ts

@@ -1,2 +1 @@
-export declare const royco: import("../types.js").ProtocolAdapter;
 export declare const openCover: import("../types.js").ProtocolAdapter;

package/dist/src/placements/adapters/evm-protocols.js

@@ -1,15 +1,8 @@
 import { createEvmVenueAdapter } from "./factory.js";
-// EVM protocols whose position IS the token the account holds.
+// EVM protocols whose position IS the token the account holds, one for one, so
+// the amount is that token's `balanceOf(account)`.
 //
-// A Royco wrapped vault and an OpenCover cover vault both hand the depositor a
-// share token, so the amount is its `balanceOf(account)` and neither needs
-// protocol-specific logic. Their venues are hand-maintained rows: neither
-// exposes a registry we can sweep without credentials.
-//
-// Pendle is not here — its PT/YT/LP are not 1:1 with the receipt coin, so it
-// needs its own conversion. See ./pendle.ts.
-//
-// They stay separate registrations so pointers, failures and reporting are
-// attributed per protocol.
-export const royco = createEvmVenueAdapter("royco");
+// Neither Pendle nor Royco qualifies. Pendle's PT/YT/LP are not 1:1 with the
+// receipt coin, and a Royco tranche vault issues 18-decimal shares that convert
+// through its own claims struct. See ./pendle.ts and ./royco.ts.
 export const openCover = createEvmVenueAdapter("opencover");

package/dist/src/placements/adapters/index.d.ts

@@ -2,7 +2,8 @@ export * from "./factory.js";
 export { alphalend } from "./alphalend.js";
 export { bluefinSpot } from "./bluefin-spot.js";
 export { current } from "./current.js";
-export { openCover, royco } from "./evm-protocols.js";
+export { openCover } from "./evm-protocols.js";
+export { royco } from "./royco.js";
 export { navi } from "./navi.js";
 export { createPendleAdapter, pendle } from "./pendle.js";
 export { suilend } from "./suilend.js";

package/dist/src/placements/adapters/index.js

@@ -2,7 +2,8 @@ import { registerAdapter } from "../registry.js";
 import { alphalend } from "./alphalend.js";
 import { bluefinSpot } from "./bluefin-spot.js";
 import { current } from "./current.js";
-import { openCover, royco } from "./evm-protocols.js";
+import { openCover } from "./evm-protocols.js";
+import { royco } from "./royco.js";
 import { navi } from "./navi.js";
 import { pendle } from "./pendle.js";
 import { suilend } from "./suilend.js";
@@ -10,7 +11,8 @@ export * from "./factory.js";
 export { alphalend } from "./alphalend.js";
 export { bluefinSpot } from "./bluefin-spot.js";
 export { current } from "./current.js";
-export { openCover, royco } from "./evm-protocols.js";
+export { openCover } from "./evm-protocols.js";
+export { royco } from "./royco.js";
 export { navi } from "./navi.js";
 export { createPendleAdapter, pendle } from "./pendle.js";
 export { suilend } from "./suilend.js";

package/dist/src/placements/adapters/royco.d.ts

@@ -0,0 +1,2 @@
+import { ProtocolAdapter } from "../types.js";
+export declare const royco: ProtocolAdapter;

package/dist/src/placements/adapters/royco.js

@@ -0,0 +1,49 @@
+import { asContractAddress, decodeUint256, encodeBalanceOf } from "../evm.js";
+/** `convertToAssets(uint256)` */
+const CONVERT_TO_ASSETS = "0x07a2d13a";
+const WORD = 64;
+/**
+ * What `account` holds at one Royco tranche vault, in base units of `ref.coin`.
+ */
+async function trancheAssets(ref, account, ctx) {
+    if (!ctx.evm)
+        throw new Error("no evm reader configured");
+    const chainId = ref.chain.chainId;
+    if (chainId === undefined) {
+        throw new Error(`royco placement ${ref.venue} has no chainId`);
+    }
+    const vault = asContractAddress(ref.shareToken ?? ref.venue);
+    const shares = decodeUint256(await ctx.evm.call(chainId, vault, encodeBalanceOf(account), ref.rpcUrl));
+    if (shares === 0n)
+        return undefined;
+    // A tranche vault is not ERC-4626 despite the selector: convertToAssets
+    // returns AssetClaims { stAssets, jtAssets, nav }. The first two are the
+    // position in the deposit token's own decimals and are what the holder can
+    // claim; nav is a USD figure on a different scale. Taking one word — the
+    // obvious reading of a 4626 — reports a fraction of the position.
+    const raw = await ctx.evm.call(chainId, vault, `${CONVERT_TO_ASSETS}${shares.toString(16).padStart(WORD, "0")}`, ref.rpcUrl);
+    const body = raw.startsWith("0x") ? raw.slice(2) : raw;
+    if (body.length < WORD * 3) {
+        throw new Error(`royco: convertToAssets returned ${body.length / 2} bytes for ${ref.venue}`);
+    }
+    const stAssets = BigInt(`0x${body.slice(0, WORD)}`);
+    const jtAssets = BigInt(`0x${body.slice(WORD, WORD * 2)}`);
+    return stAssets + jtAssets;
+}
+export const royco = {
+    id: "royco",
+    chain: "evm",
+    async discover(coin, ctx) {
+        return ctx.pointers.placements("royco", coin);
+    },
+    async read(refs, account, ctx) {
+        const readAt = new Date().toISOString();
+        const resolved = await Promise.all(refs.map(async (ref) => {
+            const amount = await trancheAssets(ref, account, ctx);
+            if (amount === undefined)
+                return undefined;
+            return { ...ref, amount: amount.toString(), readAt };
+        }));
+        return resolved.filter((p) => p !== undefined);
+    }
+};

package/dist/src/placements/pointers.js

@@ -66,6 +66,7 @@ export function httpPointerSource(options = {}) {
             // ever runs on its own chain, so a server that named it again could
             // only ever disagree.
             return (body.placements ?? []).map(placement => ({
+                id: placement.id,
                 protocol: placement.protocol,
                 chain: {
                     type: coin.chain.type,

package/dist/src/placements/types.d.ts

@@ -23,6 +23,13 @@ export interface ReceiptCoin {
 export type PointerOrigin = "Registry" | "Manual";
 /** Somewhere a receipt coin is listed. Carries no amount. */
 export interface PlacementRef {
+    /**
+     * Stable identity for this placement — the right thing to key a list on.
+     * A protocol can list the same coin at several venues (the same pair at two
+     * fee tiers, the two tranches of one market), so protocol and label
+     * together do not identify a row.
+     */
+    id?: string;
     protocol: ProtocolId;
     chain: ChainRef;
     /** Pool, market or vault address. */

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@ember-finance/sdk",
     "description": "Ember Protocol SDK",
-    "version": "2.11.0-pre.1",
+    "version": "2.11.0-pre.3",
     "type": "module",
     "module": "./dist/index.js",
     "main": "./dist/index.js",