@faremeter/rides 0.14.0 → 0.16.0

package/README.md

@@ -25,7 +25,7 @@ pnpm install @faremeter/rides
 
 ## Examples
 
-See the [basic example](https://github.com/faremeter/faremeter/blob/main/scripts/rides-example/basic.ts) in the faremeter repository.
+See the [basic example](https://github.com/faremeter/faremeter/blob/main/scripts/rides-example.ts) in the faremeter repository.
 
 ## Related Packages
 

package/dist/src/evm.d.ts

@@ -1,8 +1,8 @@
 import { type ContractInfo } from "@faremeter/info/evm";
-import { type PaymentHandler } from "@faremeter/types/client";
-import { type ChainInfo } from "@faremeter/types/evm";
+import { type WalletAdapter } from "./types.js";
+import { type Chain } from "viem";
 export declare function findNetworkAssetCombinations(networks: readonly string[], assets: readonly string[]): {
-    chain: ChainInfo;
+    chain: Chain;
     contractInfo: ContractInfo[];
 }[];
 export type CreateAdapterOptions = {
@@ -10,6 +10,6 @@ export type CreateAdapterOptions = {
     assets: readonly string[];
 };
 export declare function createAdapter(opts: CreateAdapterOptions): {
-    addLocalWallet: (input: unknown) => Promise<PaymentHandler[] | null>;
+    addLocalWallet: (input: unknown) => Promise<WalletAdapter[] | null>;
 } | undefined;
 //# sourceMappingURL=evm.d.ts.map

package/dist/src/evm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"evm.d.ts","sourceRoot":"","sources":["../../src/evm.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,YAAY,EAClB,MAAM,qBAAqB,CAAC;AAI7B,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,KAAK,SAAS,EAAc,MAAM,sBAAsB,CAAC;AASlE,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,SAAS,MAAM,EAAE,EAC3B,MAAM,EAAE,SAAS,MAAM,EAAE,GACxB;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,YAAY,EAAE,YAAY,EAAE,CAAA;CAAE,EAAE,CAyBtD;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF,wBAAgB,aAAa,CAAC,IAAI,EAAE,oBAAoB;4BAQtB,OAAO;cAwBxC"}
+{"version":3,"file":"evm.d.ts","sourceRoot":"","sources":["../../src/evm.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,YAAY,EAClB,MAAM,qBAAqB,CAAC;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,OAAO,EAA4B,KAAK,KAAK,EAAE,MAAM,MAAM,CAAC;AAa5D,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,SAAS,MAAM,EAAE,EAC3B,MAAM,EAAE,SAAS,MAAM,EAAE,GACxB;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,YAAY,EAAE,YAAY,EAAE,CAAA;CAAE,EAAE,CAyBlD;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF,wBAAgB,aAAa,CAAC,IAAI,EAAE,oBAAoB;4BAQtB,OAAO;cAiDxC"}

package/dist/src/evm.js

@@ -1,13 +1,19 @@
-import { lookupKnownAsset, } from "@faremeter/info/evm";
+import { lookupX402Network, lookupKnownAsset, } from "@faremeter/info/evm";
 import { createLocalWallet } from "@faremeter/wallet-evm";
 import { exact } from "@faremeter/payment-evm";
+import { getTokenBalance } from "@faremeter/payment-evm/erc20";
 import { isValidationError } from "@faremeter/types";
-import {} from "@faremeter/types/client";
+import {} from "./types.js";
 import { PrivateKey } from "@faremeter/types/evm";
+import { createPublicClient, http } from "viem";
 import * as chains from "viem/chains";
 const networkAliases = new Map(Object.entries({
     base: chains.base,
     "base-sepolia": chains.baseSepolia,
+    polygon: chains.polygon,
+    "polygon-amoy": chains.polygonAmoy,
+    monad: chains.monad,
+    "monad-testnet": chains.monadTestnet,
 }));
 export function findNetworkAssetCombinations(networks, assets) {
     const chains = networks
@@ -43,16 +49,40 @@ export function createAdapter(opts) {
                 // We don't know what this private key is.
                 return null;
             }
-            const handlers = [];
+            const res = [];
             for (const { chain, contractInfo } of chains) {
+                const publicClient = createPublicClient({
+                    chain,
+                    transport: http(),
+                });
                 for (const asset of contractInfo) {
                     const wallet = await createLocalWallet(chain, privateKey);
-                    handlers.push(exact.createPaymentHandler(wallet, {
-                        asset,
-                    }));
+                    res.push({
+                        x402Id: [
+                            {
+                                scheme: "exact",
+                                asset: asset.address,
+                                network: lookupX402Network(chain.id),
+                            },
+                        ],
+                        paymentHandler: exact.createPaymentHandler(wallet, {
+                            asset,
+                        }),
+                        getBalance: async () => {
+                            const balance = await getTokenBalance({
+                                account: wallet.address,
+                                asset: asset.address,
+                                client: publicClient,
+                            });
+                            return {
+                                ...balance,
+                                name: asset.contractName,
+                            };
+                        },
+                    });
                 }
             }
-            return handlers;
+            return res;
         },
     };
 }

package/dist/src/internal.d.ts

@@ -6,6 +6,7 @@ export interface CreatePayerArgs {
     fetch?: typeof globalThis.fetch;
     options?: {
         fetch?: WrapOpts;
+        disableBalanceChecks?: boolean;
     };
 }
 export declare function createPayer(args?: CreatePayerArgs): {

package/dist/src/internal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/internal.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAEL,KAAK,YAAY,EAEjB,KAAK,UAAU,EAEhB,MAAM,SAAS,CAAC;AAKjB,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;IAC1B,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAChC,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,QAAQ,CAAC;KAClB,CAAC;CACH;AAED,wBAAgB,WAAW,CAAC,IAAI,CAAC,EAAE,eAAe;4BAiChB,OAAO;mBA2B5B,WAAW,GAAG,GAAG,SACjB,WAAW,KACjB,OAAO,CAAC,QAAQ,CAAC;EAKvB;AAED,eAAO,MAAM,KAAK;4BApCgB,OAAO;mBA2B5B,WAAW,GAAG,GAAG,SACjB,WAAW,KACjB,OAAO,CAAC,QAAQ,CAAC;CAOU,CAAC"}
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/internal.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,KAAK,QAAQ,EAEd,MAAM,kBAAkB,CAAC;AAI1B,OAAO,EAEL,KAAK,YAAY,EAEjB,KAAK,UAAU,EAGhB,MAAM,SAAS,CAAC;AAKjB,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;IAC1B,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAChC,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,QAAQ,CAAC;QACjB,oBAAoB,CAAC,EAAE,OAAO,CAAC;KAChC,CAAC;CACH;AAMD,wBAAgB,WAAW,CAAC,IAAI,CAAC,EAAE,eAAe;4BAuEhB,OAAO;mBAiC5B,WAAW,GAAG,GAAG,SACjB,WAAW,KACjB,OAAO,CAAC,QAAQ,CAAC;EAKvB;AAED,eAAO,MAAM,KAAK;4BA1CgB,OAAO;mBAiC5B,WAAW,GAAG,GAAG,SACjB,WAAW,KACjB,OAAO,CAAC,QAAQ,CAAC;CAOU,CAAC"}

package/dist/src/internal.js

@@ -1,11 +1,17 @@
+import { x402PaymentId } from "@faremeter/types/x402";
+import {} from "@faremeter/types/client";
+import { wrap as wrapFetch, chooseFirstAvailable, } from "@faremeter/fetch";
 import {} from "@faremeter/types/client";
-import { wrap as wrapFetch } from "@faremeter/fetch";
 import { KnownNetworks, KnownAssets, } from "./types.js";
 import * as solana from "./solana.js";
 import * as evm from "./evm.js";
+function idKey({ network, scheme, asset }) {
+    return `${network}\0${scheme}\0${asset}`;
+}
 export function createPayer(args) {
     const { networks = KnownNetworks, assets = KnownAssets, fetch = globalThis.fetch, } = args ?? {};
     const paymentHandlers = [];
+    const balanceLookup = new Map();
     const adapters = [];
     for (const plugin of [solana, evm]) {
         const adapter = plugin.createAdapter({ networks, assets });
@@ -13,12 +19,37 @@ export function createPayer(args) {
             adapters.push(adapter);
         }
     }
+    const wrapFetchOptions = {
+        ...(args?.options?.fetch ?? {}),
+    };
+    if (!args?.options?.disableBalanceChecks) {
+        const finalChooser = args?.options?.fetch?.payerChooser ?? chooseFirstAvailable;
+        wrapFetchOptions.payerChooser = async function (execer) {
+            const viableOptions = [];
+            for (const e of execer) {
+                const req = e.requirements;
+                const getBalance = balanceLookup.get(idKey(req));
+                if (getBalance === undefined) {
+                    continue;
+                }
+                const balance = await getBalance();
+                // XXX - We need to do a better job of understanding decimals here.
+                if (balance.amount < BigInt(req.maxAmountRequired)) {
+                    // eslint-disable-next-line no-console
+                    console.log(`Not paying with ${balance.name} on ${req.network} using the ${req.scheme} scheme: balance is ${balance.amount} which is less than ${req.maxAmountRequired}`);
+                    continue;
+                }
+                viableOptions.push(e);
+            }
+            return finalChooser(viableOptions);
+        };
+    }
     const setupFetch = () => {
         if (paymentHandlers.length < 1) {
             throw new Error("no usable wallets have been attached to enable payment");
         }
         return wrapFetch(fetch, {
-            ...(args?.options?.fetch ?? {}),
+            ...wrapFetchOptions,
             handlers: paymentHandlers,
         });
     };
@@ -29,18 +60,23 @@ export function createPayer(args) {
                 throw new Error("undefined is not a valid local wallet");
             }
             _fetch = undefined;
-            const newHandlers = [];
+            const newWallets = [];
             for (const adapter of adapters) {
                 const res = await adapter.addLocalWallet(input);
                 if (res === null) {
                     continue;
                 }
-                newHandlers.push(...res);
+                newWallets.push(...res);
             }
-            if (newHandlers.length === 0) {
+            if (newWallets.length === 0) {
                 throw new Error("couldn't find any way to use provided local wallet information");
             }
-            paymentHandlers.push(...newHandlers);
+            paymentHandlers.push(...newWallets.map((x) => x.paymentHandler));
+            for (const wallet of newWallets) {
+                for (const id of wallet.x402Id) {
+                    balanceLookup.set(idKey(id), wallet.getBalance);
+                }
+            }
         },
         fetch: async (input, init) => {
             _fetch ??= setupFetch();

package/dist/src/solana.d.ts

@@ -1,9 +1,11 @@
-import { type KnownCluster } from "@faremeter/info/solana";
-import { type PaymentHandler } from "@faremeter/types/client";
-import { PublicKey, Keypair } from "@solana/web3.js";
+import { type WalletAdapter } from "./types.js";
+import { Keypair } from "@solana/web3.js";
 export declare function findNetworkMintCombinations(networks: readonly string[], assets: readonly string[]): {
-    cluster: KnownCluster;
-    mints: PublicKey[];
+    cluster: "testnet" | "devnet" | "mainnet-beta";
+    mints: {
+        address: string;
+        name: "USDC";
+    }[];
 }[];
 export declare const matchKeyPair: import("arktype/internal/match.ts").Match<unknown, [(In: Uint8Array<ArrayBufferLike>) => Keypair, (In: string) => Keypair, () => undefined]>;
 export declare function toKeypair(input: unknown): Promise<Keypair | undefined>;
@@ -12,6 +14,6 @@ export type CreateAdapterOptions = {
     assets: readonly string[];
 };
 export declare function createAdapter(opts: CreateAdapterOptions): {
-    addLocalWallet: (input: unknown) => Promise<PaymentHandler[] | null>;
+    addLocalWallet: (input: unknown) => Promise<WalletAdapter[] | null>;
 } | undefined;
 //# sourceMappingURL=solana.d.ts.map

package/dist/src/solana.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"solana.d.ts","sourceRoot":"","sources":["../../src/solana.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,KAAK,YAAY,EAElB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,OAAO,EAAE,SAAS,EAAE,OAAO,EAA6B,MAAM,iBAAiB,CAAC;AAUhF,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,SAAS,MAAM,EAAE,EAC3B,MAAM,EAAE,SAAS,MAAM,EAAE,GACxB;IAAE,OAAO,EAAE,YAAY,CAAC;IAAC,KAAK,EAAE,SAAS,EAAE,CAAA;CAAE,EAAE,CA0BjD;AAED,eAAO,MAAM,YAAY,8IAKvB,CAAC;AAEH,wBAAsB,SAAS,CAAC,KAAK,EAAE,OAAO,gCAe7C;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF,wBAAgB,aAAa,CAAC,IAAI,EAAE,oBAAoB;4BAQtB,OAAO;cAyBxC"}
+{"version":3,"file":"solana.d.ts","sourceRoot":"","sources":["../../src/solana.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,SAAS,CAAC;AAG7C,OAAO,EAAa,OAAO,EAA6B,MAAM,iBAAiB,CAAC;AAWhF,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,SAAS,MAAM,EAAE,EAC3B,MAAM,EAAE,SAAS,MAAM,EAAE;;;;;;IA2B1B;AAED,eAAO,MAAM,YAAY,8IAKvB,CAAC;AAEH,wBAAsB,SAAS,CAAC,KAAK,EAAE,OAAO,gCAe7C;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF,wBAAgB,aAAa,CAAC,IAAI,EAAE,oBAAoB;4BAQtB,OAAO;cAwDxC"}

package/dist/src/solana.js

@@ -1,10 +1,12 @@
 import { match } from "arktype";
-import { lookupKnownSPLToken, } from "@faremeter/info/solana";
+import { lookupX402Network, lookupKnownSPLToken, } from "@faremeter/info/solana";
 import { createLocalWallet } from "@faremeter/wallet-solana";
 import { exact } from "@faremeter/payment-solana";
-import {} from "@faremeter/types/client";
+import {} from "./types.js";
+import { getTokenBalance } from "@faremeter/payment-solana/splToken";
 import { isValidationError } from "@faremeter/types";
 import { PublicKey, Keypair, clusterApiUrl, Connection } from "@solana/web3.js";
+import { createSolanaRpc } from "@solana/kit";
 import { readLocalFile } from "./common.js";
 const networkAliases = new Map(Object.entries({
     solana: "mainnet-beta",
@@ -21,7 +23,7 @@ export function findNetworkMintCombinations(networks, assets) {
         const mints = assets
             .map((name) => lookupKnownSPLToken(cluster, name))
             .filter((x) => x !== undefined)
-            .map((x) => new PublicKey(x.address));
+            .map(({ address, name }) => ({ address, name }));
         if (mints.length === 0) {
             return [];
         }
@@ -63,15 +65,39 @@ export function createAdapter(opts) {
                 // We don't know what this private key is.
                 return null;
             }
-            const handlers = [];
+            const res = [];
             for (const { cluster, mints } of clusters) {
+                const rpcURL = clusterApiUrl(cluster);
+                const rpcClient = createSolanaRpc(rpcURL);
                 for (const mint of mints) {
                     const connection = new Connection(clusterApiUrl(cluster), "confirmed");
                     const wallet = await createLocalWallet(cluster, privateKey);
-                    handlers.push(exact.createPaymentHandler(wallet, mint, connection));
+                    res.push({
+                        x402Id: lookupX402Network(cluster).map((network) => ({
+                            scheme: "exact",
+                            asset: mint.address,
+                            network,
+                        })),
+                        paymentHandler: exact.createPaymentHandler(wallet, new PublicKey(mint.address), connection),
+                        getBalance: async () => {
+                            let balance = await getTokenBalance({
+                                account: privateKey.publicKey.toBase58(),
+                                asset: mint.address,
+                                rpcClient,
+                            });
+                            balance ??= {
+                                amount: 0n,
+                                decimals: 0,
+                            };
+                            return {
+                                ...balance,
+                                name: mint.name,
+                            };
+                        },
+                    });
                 }
             }
-            return handlers;
+            return res;
         },
     };
 }

package/dist/src/types.d.ts

@@ -1,9 +1,21 @@
+import { x402PaymentId } from "@faremeter/types/x402";
 import { type PaymentHandler } from "@faremeter/types/client";
-export declare const KnownNetworks: readonly ["base", "base-sepolia", "solana", "solana-devnet"];
+export declare const KnownNetworks: readonly ["base", "base-sepolia", "monad", "monad-testnet", "polygon", "polygon-amoy", "solana", "solana-devnet"];
 export type KnownNetwork = (typeof KnownNetworks)[number];
 export declare const KnownAssets: readonly ["USDC"];
 export type KnownAsset = (typeof KnownAssets)[number];
+export type Balance = {
+    name: string;
+    amount: bigint;
+    decimals: number;
+};
+export type GetBalance = () => Promise<Balance>;
+export interface WalletAdapter {
+    x402Id: x402PaymentId[];
+    paymentHandler: PaymentHandler;
+    getBalance: GetBalance;
+}
 export interface PayerAdapter {
-    addLocalWallet: (input: unknown) => Promise<PaymentHandler[] | null>;
+    addLocalWallet: (input: unknown) => Promise<WalletAdapter[] | null>;
 }
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,eAAO,MAAM,aAAa,8DAKhB,CAAC;AACX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D,eAAO,MAAM,WAAW,mBAAoB,CAAC;AAC7C,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtD,MAAM,WAAW,YAAY;IAC3B,cAAc,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,CAAC;CACtE"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,eAAO,MAAM,aAAa,mHAShB,CAAC;AACX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D,eAAO,MAAM,WAAW,mBAAoB,CAAC;AAC7C,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtD,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;AAEhD,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,cAAc,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,aAAa,EAAE,GAAG,IAAI,CAAC,CAAC;CACrE"}

package/dist/src/types.js

@@ -1,7 +1,12 @@
+import { x402PaymentId } from "@faremeter/types/x402";
 import {} from "@faremeter/types/client";
 export const KnownNetworks = [
     "base",
     "base-sepolia",
+    "monad",
+    "monad-testnet",
+    "polygon",
+    "polygon-amoy",
     "solana",
     "solana-devnet",
 ];