@ardrive/turbo-sdk 2.0.0 → 2.1.0-alpha.2

package/lib/esm/common/token/ario.js

@@ -13,123 +13,23 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { createAssociatedTokenAccountIdempotentInstruction, createTransferCheckedInstruction, getAssociatedTokenAddressSync, } from '@solana/spl-token';
-import { Connection, PublicKey, Transaction, TransactionInstruction, } from '@solana/web3.js';
 import { BigNumber } from 'bignumber.js';
-import bs58 from 'bs58';
-import { defaultProdGatewayUrls, sleep } from '../../utils/common.js';
-import { Logger } from '../logger.js';
-import { memoProgramId } from './solana.js';
+import { defaultProdGatewayUrls } from '../../utils/common.js';
+import { SplToken } from './spl.js';
 const ARIO_SPL_MINT_ADDRESS = 'DcNnMuFxwhgV4WY1HVSaSEgr92bv2b1vUvEKiNxWqHdF';
 const DEVNET_ARIO_SPL_MINT_ADDRESS = '6vTw5CysRXQ4ybbHkDUiisHWVsBeMtUzYvJqs2iqHyaN';
 const ARIO_TOKEN_DECIMALS = 6;
-export class ARIOToken {
-    constructor({ gatewayUrl = defaultProdGatewayUrls.solana, logger = Logger.default, pollingOptions = {
-        maxAttempts: 10,
-        pollingIntervalMs: 2_500,
-        initialBackoffMs: 500,
-    }, } = {}) {
-        this.gatewayUrl = gatewayUrl;
-        this.connection = new Connection(gatewayUrl, 'confirmed');
-        this.pollingOptions = pollingOptions;
-        this.logger = logger;
-        if (gatewayUrl.includes('devnet')) {
-            this.mintAddress = DEVNET_ARIO_SPL_MINT_ADDRESS;
-        }
-        else {
-            this.mintAddress = ARIO_SPL_MINT_ADDRESS;
-        }
-    }
-    async createAndSubmitTx({ target, signer, tokenAmount, turboCreditDestinationAddress, }) {
-        const ownerPublicKey = new PublicKey(bs58.encode(Uint8Array.from(await signer.getPublicKey())));
-        const recipient = new PublicKey(target);
-        const mint = new PublicKey(this.mintAddress);
-        const fromAta = getAssociatedTokenAddressSync(mint, ownerPublicKey);
-        const toAta = getAssociatedTokenAddressSync(mint, recipient);
-        const tx = new Transaction({
-            feePayer: ownerPublicKey,
-            ...(await this.connection.getLatestBlockhash()),
-        });
-        tx.add(createAssociatedTokenAccountIdempotentInstruction(ownerPublicKey, toAta, recipient, mint));
-        tx.add(createTransferCheckedInstruction(fromAta, mint, toAta, ownerPublicKey, BigInt(new BigNumber(tokenAmount).toFixed(0)), ARIO_TOKEN_DECIMALS));
-        if (turboCreditDestinationAddress !== undefined) {
-            tx.add(new TransactionInstruction({
-                programId: new PublicKey(memoProgramId),
-                keys: [],
-                data: Buffer.from('turboCreditDestinationAddress=' + turboCreditDestinationAddress),
-            }));
-        }
-        const serializedTx = tx.serializeMessage();
-        const signature = await signer.signData(Uint8Array.from(serializedTx));
-        tx.addSignature(ownerPublicKey, Buffer.from(signature));
-        const txId = bs58.encode(signature);
-        await this.submitTx(tx, txId);
-        this.logger.debug('Submitted ARIO SPL transfer transaction...', {
-            id: txId,
-            target,
-            tokenAmount,
-            fromAta: fromAta.toBase58(),
-            toAta: toAta.toBase58(),
-            mint: mint.toBase58(),
-        });
-        return { id: txId, target, reward: '0' };
-    }
-    async submitTx(tx, id) {
-        this.logger.debug('Submitting ARIO fund transaction...', { id });
-        await this.connection.sendRawTransaction(tx.serialize(), {
-            maxRetries: this.pollingOptions.maxAttempts,
-        });
-        if (tx.recentBlockhash === undefined ||
-            tx.lastValidBlockHeight === undefined) {
-            throw new Error('Failed to submit Transaction -- missing blockhash or lastValidBlockHeight from transaction creation. Solana Gateway Url:' +
-                this.gatewayUrl);
-        }
-        await this.connection.confirmTransaction({
-            signature: id,
-            blockhash: tx.recentBlockhash,
-            lastValidBlockHeight: tx.lastValidBlockHeight,
-        }, 'finalized');
-    }
-    async pollTxAvailability({ txId }) {
-        const { maxAttempts, pollingIntervalMs, initialBackoffMs } = this.pollingOptions;
-        this.logger.debug('Polling for ARIO SPL transaction...', {
-            txId,
-            pollingOptions: this.pollingOptions,
-            gatewayUrl: this.gatewayUrl,
+export class ARIOToken extends SplToken {
+    constructor({ gatewayUrl = defaultProdGatewayUrls.ario, ...config } = {}) {
+        super({
+            ...config,
+            gatewayUrl,
+            tokenName: 'ARIO',
+            decimals: ARIO_TOKEN_DECIMALS,
+            mintAddress: gatewayUrl.includes('devnet')
+                ? DEVNET_ARIO_SPL_MINT_ADDRESS
+                : ARIO_SPL_MINT_ADDRESS,
         });
-        await sleep(initialBackoffMs);
-        let attempts = 0;
-        while (attempts < maxAttempts) {
-            let status;
-            attempts++;
-            try {
-                const statuses = await this.connection.getSignatureStatuses([txId], {
-                    searchTransactionHistory: true,
-                });
-                status = {
-                    context: statuses.context,
-                    value: statuses.value[0],
-                };
-            }
-            catch (err) {
-                this.logger.debug('Failed to poll ARIO SPL transaction...', { err });
-            }
-            if (status && status.value && status.value.err !== null) {
-                throw new Error(`Transaction failed: ${status.value.err}`);
-            }
-            if (status && status.value && status.value.slot !== null) {
-                this.logger.debug('Transaction found!', { txId, status });
-                return;
-            }
-            this.logger.debug('ARIO SPL transaction not found, polling...', {
-                txId,
-                attempts,
-                maxAttempts,
-                pollingIntervalMs,
-            });
-            await sleep(pollingIntervalMs);
-        }
-        throw new Error('Transaction not found after polling, transaction id: ' + txId);
     }
 }
 export const mARIOToTokenAmount = (mARIO) => mARIO;

package/lib/esm/common/token/index.js

@@ -5,6 +5,7 @@ import { BaseEthToken } from './baseEth.js';
 import { ETHToTokenAmount, EthereumToken } from './ethereum.js';
 import { POLToTokenAmount, PolygonToken } from './polygon.js';
 import { SOLToTokenAmount, SolanaToken } from './solana.js';
+import { SolanaUsdcToken } from './solanaUsdc.js';
 import { USDCToTokenAmount, USDCToken } from './usdc.js';
 export const defaultTokenMap = {
     arweave: (config) => new ArweaveToken(config),
@@ -17,6 +18,7 @@ export const defaultTokenMap = {
     usdc: (config) => new USDCToken({ network: 'ethereum', ...config }),
     'base-usdc': (config) => new USDCToken({ network: 'base', ...config }),
     'polygon-usdc': (config) => new USDCToken({ network: 'polygon', ...config }),
+    'solana-usdc': (config) => new SolanaUsdcToken(config),
 };
 const ethExponent = 18;
 const usdcExponent = 6;
@@ -32,6 +34,7 @@ export const exponentMap = {
     usdc: usdcExponent,
     'base-usdc': usdcExponent,
     'polygon-usdc': usdcExponent,
+    'solana-usdc': usdcExponent,
 };
 export const tokenToBaseMap = {
     arweave: (a) => ARToTokenAmount(a),
@@ -44,6 +47,7 @@ export const tokenToBaseMap = {
     usdc: (a) => USDCToTokenAmount(a),
     'base-usdc': (a) => USDCToTokenAmount(a),
     'polygon-usdc': (a) => USDCToTokenAmount(a),
+    'solana-usdc': (a) => USDCToTokenAmount(a),
 };
 export function isTokenType(token) {
     return tokenTypes.includes(token);
@@ -54,3 +58,5 @@ export * from './solana.js';
 export * from './ethereum.js';
 export * from './baseEth.js';
 export * from './polygon.js';
+export * from './spl.js';
+export * from './solanaUsdc.js';

package/lib/esm/common/token/solanaUsdc.js

@@ -0,0 +1,25 @@
+import { defaultProdGatewayUrls } from '../../utils/common.js';
+import { SplToken } from './spl.js';
+/** Circle's USDC mints on Solana. Both are 6-decimal SPL Token mints. */
+export const SOLANA_USDC_MINT_ADDRESS = 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v';
+export const DEVNET_SOLANA_USDC_MINT_ADDRESS = '4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU';
+const USDC_TOKEN_DECIMALS = 6;
+/**
+ * USDC (SPL) on Solana. Signed with the ordinary Solana signer — the payer's
+ * USDC lives in an associated token account derived from the same keypair, so
+ * no extra wallet or approval step is involved.
+ */
+export class SolanaUsdcToken extends SplToken {
+    constructor({ gatewayUrl = defaultProdGatewayUrls['solana-usdc'], mintAddress, ...config } = {}) {
+        super({
+            ...config,
+            gatewayUrl,
+            tokenName: 'USDC',
+            decimals: USDC_TOKEN_DECIMALS,
+            mintAddress: mintAddress ??
+                (gatewayUrl.includes('devnet')
+                    ? DEVNET_SOLANA_USDC_MINT_ADDRESS
+                    : SOLANA_USDC_MINT_ADDRESS),
+        });
+    }
+}

package/lib/esm/common/token/spl.js

@@ -0,0 +1,179 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { createAssociatedTokenAccountIdempotentInstruction, createTransferCheckedInstruction, getAssociatedTokenAddressSync, } from '@solana/spl-token';
+import { Connection, PublicKey, Transaction, TransactionInstruction, } from '@solana/web3.js';
+import { BigNumber } from 'bignumber.js';
+import bs58 from 'bs58';
+import { isSolanaWalletAdapter, } from '../../types.js';
+import { defaultProdGatewayUrls, sleep } from '../../utils/common.js';
+import { Logger } from '../logger.js';
+import { memoProgramId } from './solana.js';
+/**
+ * Funding by an **SPL token transfer on Solana**: an idempotent
+ * create-associated-token-account, a `transferChecked` to the recipient's ATA,
+ * and an optional `turboCreditDestinationAddress=` memo when the credit should
+ * land on a different Turbo account than the payer.
+ *
+ * This is the generic shape of what `ARIOToken` has always done — ARIO is an SPL
+ * token — so a second SPL token (USDC) is a mint and a decimals value, not a
+ * second implementation. The payment service verifies both with one class too
+ * (`SolanaSplGateway`).
+ *
+ * Two constraints worth knowing before pointing this at a third token:
+ *  - The associated token accounts are derived for the CLASSIC SPL Token
+ *    program (Tokenkeg), which is what ARIO and USDC use. A Token-2022 mint
+ *    derives a different ATA, so it would need its own program id threading
+ *    through `getAssociatedTokenAddressSync`. It fails loudly on-chain rather
+ *    than silently paying the wrong account.
+ *  - `decimals` must match the mint's own. `transferChecked` carries the value
+ *    and the chain rejects a mismatch, so a wrong value fails the transaction
+ *    instead of transferring a wrong amount.
+ */
+export class SplToken {
+    constructor({ mintAddress, decimals, tokenName = 'SPL', gatewayUrl = defaultProdGatewayUrls.solana, logger = Logger.default, pollingOptions = {
+        maxAttempts: 10,
+        pollingIntervalMs: 2_500,
+        initialBackoffMs: 500,
+    }, }) {
+        this.gatewayUrl = gatewayUrl;
+        this.connection = new Connection(gatewayUrl, 'confirmed');
+        this.pollingOptions = pollingOptions;
+        this.logger = logger;
+        this.mintAddress = mintAddress;
+        this.decimals = decimals;
+        this.tokenName = tokenName;
+    }
+    async createAndSubmitTx({ target, signer, tokenAmount, turboCreditDestinationAddress, }) {
+        const ownerPublicKey = new PublicKey(bs58.encode(Uint8Array.from(await signer.getPublicKey())));
+        const recipient = new PublicKey(target);
+        const mint = new PublicKey(this.mintAddress);
+        const fromAta = getAssociatedTokenAddressSync(mint, ownerPublicKey);
+        const toAta = getAssociatedTokenAddressSync(mint, recipient);
+        const tx = new Transaction({
+            feePayer: ownerPublicKey,
+            ...(await this.connection.getLatestBlockhash()),
+        });
+        tx.add(createAssociatedTokenAccountIdempotentInstruction(ownerPublicKey, toAta, recipient, mint));
+        tx.add(createTransferCheckedInstruction(fromAta, mint, toAta, ownerPublicKey, BigInt(new BigNumber(tokenAmount).toFixed(0)), this.decimals));
+        if (turboCreditDestinationAddress !== undefined) {
+            tx.add(new TransactionInstruction({
+                programId: new PublicKey(memoProgramId),
+                keys: [],
+                data: Buffer.from('turboCreditDestinationAddress=' + turboCreditDestinationAddress),
+            }));
+        }
+        const { signedTx, signature } = signer.walletAdapter !== undefined &&
+            isSolanaWalletAdapter(signer.walletAdapter)
+            ? await this.signWithWallet(tx, signer.walletAdapter)
+            : await this.signWithKey(tx, ownerPublicKey, signer);
+        const txId = bs58.encode(signature);
+        await this.submitTx(signedTx, txId);
+        this.logger.debug(`Submitted ${this.tokenName} SPL transfer transaction...`, {
+            id: txId,
+            target,
+            tokenAmount,
+            fromAta: fromAta.toBase58(),
+            toAta: toAta.toBase58(),
+            mint: mint.toBase58(),
+        });
+        return { id: txId, target, reward: '0' };
+    }
+    /** Sign the message bytes directly: a private-key signer holds the key. */
+    async signWithKey(tx, ownerPublicKey, signer) {
+        const signature = await signer.signData(Uint8Array.from(tx.serializeMessage()));
+        tx.addSignature(ownerPublicKey, Buffer.from(signature));
+        return { signedTx: tx, signature };
+    }
+    /**
+     * Have a browser wallet sign the transaction itself, as the SOL path does.
+     *
+     * A wallet signs through `signTransaction`, not `signMessage`: it refuses, or
+     * cannot display, a serialized transaction handed to it as a message. It may
+     * also add instructions of its own before signing (compute budget, guards),
+     * so the transaction submitted is the one it returns, never ours with its
+     * signature attached. Deserializing drops `lastValidBlockHeight`, so that is
+     * carried over for confirmation.
+     */
+    async signWithWallet(tx, walletAdapter) {
+        const signedTx = await walletAdapter.signTransaction(tx);
+        const signature = signedTx.signature;
+        if (signature === null) {
+            throw new Error(`Wallet returned an unsigned ${this.tokenName} transfer transaction`);
+        }
+        signedTx.recentBlockhash ??= tx.recentBlockhash;
+        signedTx.lastValidBlockHeight ??= tx.lastValidBlockHeight;
+        return { signedTx, signature: Uint8Array.from(signature) };
+    }
+    async submitTx(tx, id) {
+        this.logger.debug(`Submitting ${this.tokenName} fund transaction...`, {
+            id,
+        });
+        await this.connection.sendRawTransaction(tx.serialize(), {
+            maxRetries: this.pollingOptions.maxAttempts,
+        });
+        if (tx.recentBlockhash === undefined ||
+            tx.lastValidBlockHeight === undefined) {
+            throw new Error('Failed to submit Transaction -- missing blockhash or lastValidBlockHeight from transaction creation. Solana Gateway Url:' +
+                this.gatewayUrl);
+        }
+        await this.connection.confirmTransaction({
+            signature: id,
+            blockhash: tx.recentBlockhash,
+            lastValidBlockHeight: tx.lastValidBlockHeight,
+        }, 'finalized');
+    }
+    async pollTxAvailability({ txId }) {
+        const { maxAttempts, pollingIntervalMs, initialBackoffMs } = this.pollingOptions;
+        this.logger.debug(`Polling for ${this.tokenName} SPL transaction...`, {
+            txId,
+            pollingOptions: this.pollingOptions,
+            gatewayUrl: this.gatewayUrl,
+        });
+        await sleep(initialBackoffMs);
+        let attempts = 0;
+        while (attempts < maxAttempts) {
+            let status;
+            attempts++;
+            try {
+                const statuses = await this.connection.getSignatureStatuses([txId], {
+                    searchTransactionHistory: true,
+                });
+                status = {
+                    context: statuses.context,
+                    value: statuses.value[0],
+                };
+            }
+            catch (err) {
+                this.logger.debug(`Failed to poll ${this.tokenName} SPL transaction...`, { err });
+            }
+            if (status && status.value && status.value.err !== null) {
+                throw new Error(`Transaction failed: ${status.value.err}`);
+            }
+            if (status && status.value && status.value.slot !== null) {
+                this.logger.debug('Transaction found!', { txId, status });
+                return;
+            }
+            this.logger.debug(`${this.tokenName} SPL transaction not found, polling...`, {
+                txId,
+                attempts,
+                maxAttempts,
+                pollingIntervalMs,
+            });
+            await sleep(pollingIntervalMs);
+        }
+        throw new Error('Transaction not found after polling, transaction id: ' + txId);
+    }
+}

package/lib/esm/common/upload.js

@@ -245,6 +245,7 @@ export class TurboAuthenticatedBaseUploadService extends TurboUnauthenticatedUpl
             'solana',
             'base-eth',
             'base-usdc',
+            'solana-usdc',
         ];
         this.signer = signer;
         this.paymentService = paymentService;

package/lib/esm/types.js

@@ -25,7 +25,19 @@ export const tokenTypes = [
     'usdc',
     'base-usdc',
     'polygon-usdc',
+    // USDC (SPL) on Solana — signed with the Solana signer, not an EVM one.
+    'solana-usdc',
 ];
+/**
+ * Tokens paid from a Solana wallet: SOL natively, and ARIO and USDC as SPL
+ * transfers signed by the same ed25519 key. A private key for any of these
+ * builds a Solana signer, so a Solana wallet adapter must as well.
+ */
+export const supportedSolanaSignerTokens = new Set([
+    'solana',
+    'ario',
+    'solana-usdc',
+]);
 export const supportedEvmSignerTokens = new Set([
     'ethereum',
     'base-eth',

package/lib/esm/utils/common.js

@@ -38,6 +38,7 @@ export const tokenToDevGatewayMap = {
     usdc: ethTestnetRpc,
     'base-usdc': baseTestnetRpc,
     'polygon-usdc': polygonTestnetRpc,
+    'solana-usdc': 'https://api.devnet.solana.com',
 };
 export const defaultProdGatewayUrls = {
     arweave: 'https://turbo-gateway.com',
@@ -50,6 +51,7 @@ export const defaultProdGatewayUrls = {
     usdc: 'https://cloudflare-eth.com/',
     'base-usdc': baseMainnetRpc,
     'polygon-usdc': 'https://polygon-rpc.com/',
+    'solana-usdc': 'https://api.mainnet-beta.solana.com',
 };
 export function createTurboSigner({ signer: clientProvidedSigner, privateKey: clientProvidedPrivateKey, token = 'arweave', }) {
     if (clientProvidedSigner !== undefined) {
@@ -71,6 +73,7 @@ export function createTurboSigner({ signer: clientProvidedSigner, privateKey: cl
     switch (token) {
         case 'solana':
         case 'ario':
+        case 'solana-usdc':
             return new HexSolanaSigner(clientProvidedPrivateKey);
         case 'ethereum':
         case 'pol':
@@ -116,6 +119,7 @@ export function isValidUserAddress(address, type) {
             return isValidArweaveBase64URL(address);
         case 'ario':
         case 'solana':
+        case 'solana-usdc':
             return isValidSolanaAddress(address);
         case 'ethereum':
         case 'base-eth':

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '2.0.0';
+export const version = '2.1.0-alpha.2';

package/lib/types/common/factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../src/common/factory.ts"],"names":[],"mappings":"AAqBA,OAAO,EACL,oBAAoB,EAEpB,+BAA+B,EAC/B,4CAA4C,EAC5C,wCAAwC,EACxC,iCAAiC,EAKlC,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EACL,gCAAgC,EAEjC,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE1D,OAAO,EACL,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,YAAY,CAAC;AAGpB,8BAAsB,gBAAgB;IACpC,SAAS,CAAC,MAAM,CAAC,MAAM,SAAkB;IAGzC,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ;IAIlC,MAAM,CAAC,eAAe,CAAC,EACrB,oBAAyB,EACzB,mBAAwB,EACxB,KAAK,GACN,GAAE,iCAAsC;IAqBzC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,EAC3B,kBAAkB,EAClB,cAAc,EACd,qBAAqB,EACrB,MAAM,EACN,KAAK,GACN,EAAE,oBAAoB,GAAG,2BAA2B;IAErD,SAAS,CAAC,QAAQ,CAAC,6BAA6B,CAC9C,MAAM,EAAE,4CAA4C,GAAG;QACrD,cAAc,EAAE,gCAAgC,CAAC;KAClD,GACA,wCAAwC;IAE3C,SAAS,CAAC,qBAAqB,CAAC,EAC9B,UAAU,EACV,MAAM,EAAE,cAAc,EACtB,oBAAyB,EACzB,mBAAwB,EACxB,KAAK,EACL,UAAU,EACV,QAAQ,EACR,UAAU,EACV,MAAM,EACN,aAAa,GACd,EAAE,+BAA+B,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE;IA0FvD,OAAO,CAAC,iBAAiB;CAuB1B"}
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../src/common/factory.ts"],"names":[],"mappings":"AAqBA,OAAO,EACL,oBAAoB,EAEpB,+BAA+B,EAC/B,4CAA4C,EAC5C,wCAAwC,EACxC,iCAAiC,EAMlC,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EACL,gCAAgC,EAEjC,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE1D,OAAO,EACL,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,YAAY,CAAC;AAGpB,8BAAsB,gBAAgB;IACpC,SAAS,CAAC,MAAM,CAAC,MAAM,SAAkB;IAGzC,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ;IAIlC,MAAM,CAAC,eAAe,CAAC,EACrB,oBAAyB,EACzB,mBAAwB,EACxB,KAAK,GACN,GAAE,iCAAsC;IAqBzC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,EAC3B,kBAAkB,EAClB,cAAc,EACd,qBAAqB,EACrB,MAAM,EACN,KAAK,GACN,EAAE,oBAAoB,GAAG,2BAA2B;IAErD,SAAS,CAAC,QAAQ,CAAC,6BAA6B,CAC9C,MAAM,EAAE,4CAA4C,GAAG;QACrD,cAAc,EAAE,gCAAgC,CAAC;KAClD,GACA,wCAAwC;IAE3C,SAAS,CAAC,qBAAqB,CAAC,EAC9B,UAAU,EACV,MAAM,EAAE,cAAc,EACtB,oBAAyB,EACzB,mBAAwB,EACxB,KAAK,EACL,UAAU,EACV,QAAQ,EACR,UAAU,EACV,MAAM,EACN,aAAa,GACd,EAAE,+BAA+B,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE;IA0FvD,OAAO,CAAC,iBAAiB;CAuB1B"}

package/lib/types/common/signer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../../src/common/signer.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAkB/D,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,sBAAsB,EACtB,SAAS,EACT,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,EAChB,WAAW,EACX,0BAA0B,EAC1B,yBAAyB,EACzB,WAAW,EACX,eAAe,EACf,aAAa,EAGd,MAAM,aAAa,CAAC;AAUrB;;GAEG;AACH,8BAAsB,2BACpB,YAAW,mBAAmB;IAEvB,MAAM,EAAE,WAAW,CAAC;IACpB,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;IAEhD,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC;IAC9B,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC;gBAEf,EACV,MAAM,EACN,MAAuB,EACvB,KAAK,EACL,aAAa,GACd,EAAE,yBAAyB;IAO5B,QAAQ,CAAC,YAAY,CAAC,EACpB,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,OAAO,GACR,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAE5E,OAAO,CAAC,oBAAoB;IAkCf,4BAA4B,CAGvC,KAAK,GAAE,MAAwC,EAM/C,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,yBAAyB,CAAC;IAexB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAI/B,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC;IAOvD,gGAAgG;IACnF,eAAe,CAAC,EAC3B,MAAM,EACN,MAAM,EACN,UAAU,EACV,6BAA6B,GAC9B,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAuF9B,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;CAgBnE;AAED;;;;;;;;;GASG;AACH,wBAAsB,cAAc,CAClC,eAAe,EAAE,cAAc,GAC9B,OAAO,CAAC,eAAe,CAAC,CAsC1B"}
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../../src/common/signer.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAkB/D,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,sBAAsB,EACtB,SAAS,EACT,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,EAChB,WAAW,EACX,0BAA0B,EAC1B,yBAAyB,EACzB,WAAW,EACX,eAAe,EACf,aAAa,EAGd,MAAM,aAAa,CAAC;AAUrB;;GAEG;AACH,8BAAsB,2BACpB,YAAW,mBAAmB;IAEvB,MAAM,EAAE,WAAW,CAAC;IACpB,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;IAEhD,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC;IAC9B,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC;gBAEf,EACV,MAAM,EACN,MAAuB,EACvB,KAAK,EACL,aAAa,GACd,EAAE,yBAAyB;IAO5B,QAAQ,CAAC,YAAY,CAAC,EACpB,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,OAAO,GACR,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAE5E,OAAO,CAAC,oBAAoB;IAsCf,4BAA4B,CAGvC,KAAK,GAAE,MAAwC,EAM/C,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,yBAAyB,CAAC;IAexB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAI/B,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC;IAOvD,gGAAgG;IACnF,eAAe,CAAC,EAC3B,MAAM,EACN,MAAM,EACN,UAAU,EACV,6BAA6B,GAC9B,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAuF9B,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;CAgBnE;AAED;;;;;;;;;GASG;AACH,wBAAsB,cAAc,CAClC,eAAe,EAAE,cAAc,GAC9B,OAAO,CAAC,eAAe,CAAC,CAsC1B"}

package/lib/types/common/token/ario.d.ts

@@ -1,26 +1,23 @@
-import { Connection } from '@solana/web3.js';
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 import { BigNumber } from 'bignumber.js';
-import { AoProcessConfig, TokenConfig, TokenCreateTxParams, TokenPollingOptions, TokenTools, TurboLogger } from '../../types.js';
-export declare class ARIOToken implements TokenTools {
-    protected logger: TurboLogger;
-    protected connection: Connection;
-    protected gatewayUrl: string;
-    private pollingOptions;
-    private mintAddress;
-    constructor({ gatewayUrl, logger, pollingOptions, }?: {
-        gatewayUrl?: string;
-        logger?: TurboLogger;
-        pollingOptions?: TokenPollingOptions;
-    } & Partial<AoProcessConfig> & TokenConfig);
-    createAndSubmitTx({ target, signer, tokenAmount, turboCreditDestinationAddress, }: TokenCreateTxParams): Promise<{
-        id: string;
-        target: string;
-        reward: string;
-    }>;
-    private submitTx;
-    pollTxAvailability({ txId }: {
-        txId: string;
-    }): Promise<void>;
+import { AoProcessConfig, TokenConfig } from '../../types.js';
+import { SplToken } from './spl.js';
+export declare class ARIOToken extends SplToken {
+    constructor({ gatewayUrl, ...config }?: Partial<AoProcessConfig> & TokenConfig);
 }
 export declare const mARIOToTokenAmount: (mARIO: BigNumber.Value) => BigNumber.Value;
 export declare const ARIOToTokenAmount: (ario: BigNumber.Value) => string;

package/lib/types/common/token/ario.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ario.d.ts","sourceRoot":"","sources":["../../../../src/common/token/ario.ts"],"names":[],"mappings":"AAoBA,OAAO,EACL,UAAU,EAMX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC,OAAO,EACL,eAAe,EACf,WAAW,EACX,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EACV,WAAW,EACZ,MAAM,gBAAgB,CAAC;AAUxB,qBAAa,SAAU,YAAW,UAAU;IAC1C,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC;IAE9B,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;IACjC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,cAAc,CAAsB;IAC5C,OAAO,CAAC,WAAW,CAAS;gBAEhB,EACV,UAA0C,EAC1C,MAAuB,EACvB,cAIC,GACF,GAAE;QACD,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,cAAc,CAAC,EAAE,mBAAmB,CAAC;KACtC,GAAG,OAAO,CAAC,eAAe,CAAC,GAC1B,WAAgB;IAcL,iBAAiB,CAAC,EAC7B,MAAM,EACN,MAAM,EACN,WAAW,EACX,6BAA6B,GAC9B,EAAE,mBAAmB,GAAG,OAAO,CAAC;QAC/B,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;YAkEY,QAAQ;IA2BT,kBAAkB,CAAC,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAqD3E;AAED,eAAO,MAAM,kBAAkB,UAAW,SAAS,CAAC,KAAK,oBAAU,CAAC;AACpE,eAAO,MAAM,iBAAiB,SAAU,SAAS,CAAC,KAAK,WACb,CAAC"}
+{"version":3,"file":"ario.d.ts","sourceRoot":"","sources":["../../../../src/common/token/ario.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE9D,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAOpC,qBAAa,SAAU,SAAQ,QAAQ;gBACzB,EACV,UAAwC,EACxC,GAAG,MAAM,EACV,GAAE,OAAO,CAAC,eAAe,CAAC,GAAG,WAAgB;CAW/C;AAED,eAAO,MAAM,kBAAkB,UAAW,SAAS,CAAC,KAAK,oBAAU,CAAC;AACpE,eAAO,MAAM,iBAAiB,SAAU,SAAS,CAAC,KAAK,WACb,CAAC"}

package/lib/types/common/token/index.d.ts

@@ -25,4 +25,6 @@ export * from './solana.js';
 export * from './ethereum.js';
 export * from './baseEth.js';
 export * from './polygon.js';
+export * from './spl.js';
+export * from './solanaUsdc.js';
 //# sourceMappingURL=index.d.ts.map

package/lib/types/common/token/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/token/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAEL,YAAY,EACZ,SAAS,EAEV,MAAM,gBAAgB,CAAC;AASxB,eAAO,MAAM,eAAe,EAAE,YAcpB,CAAC;AAMX,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAWxC,CAAC;AAEX,eAAO,MAAM,cAAc,EAAE,MAAM,CACjC,SAAS,EACT,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,KAAK,SAAS,CAAC,KAAK,CAY/B,CAAC;AAEX,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,SAAS,CAE7D;AAED,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/token/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAEL,YAAY,EACZ,SAAS,EAEV,MAAM,gBAAgB,CAAC;AAUxB,eAAO,MAAM,eAAe,EAAE,YAepB,CAAC;AAMX,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAYxC,CAAC;AAEX,eAAO,MAAM,cAAc,EAAE,MAAM,CACjC,SAAS,EACT,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,KAAK,SAAS,CAAC,KAAK,CAa/B,CAAC;AAEX,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,SAAS,CAE7D;AAED,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC"}

package/lib/types/common/token/solanaUsdc.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { TokenConfig } from '../../types.js';
+import { SplToken } from './spl.js';
+/** Circle's USDC mints on Solana. Both are 6-decimal SPL Token mints. */
+export declare const SOLANA_USDC_MINT_ADDRESS = "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v";
+export declare const DEVNET_SOLANA_USDC_MINT_ADDRESS = "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU";
+export type SolanaUsdcTokenConfig = TokenConfig & {
+    /**
+     * The USDC mint to pay with. PREFER SETTING THIS EXPLICITLY when `gatewayUrl`
+     * is a custom RPC: the default below infers the cluster from the URL, which
+     * is only a heuristic — a paid devnet endpoint whose hostname doesn't contain
+     * "devnet" would otherwise select the MAINNET mint, and the payment would
+     * never be credited (it can't move mainnet value from a devnet wallet, but it
+     * does fail confusingly).
+     */
+    mintAddress?: string;
+};
+/**
+ * USDC (SPL) on Solana. Signed with the ordinary Solana signer — the payer's
+ * USDC lives in an associated token account derived from the same keypair, so
+ * no extra wallet or approval step is involved.
+ */
+export declare class SolanaUsdcToken extends SplToken {
+    constructor({ gatewayUrl, mintAddress, ...config }?: SolanaUsdcTokenConfig);
+}
+//# sourceMappingURL=solanaUsdc.d.ts.map

package/lib/types/common/token/solanaUsdc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"solanaUsdc.d.ts","sourceRoot":"","sources":["../../../../src/common/token/solanaUsdc.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,yEAAyE;AACzE,eAAO,MAAM,wBAAwB,iDACW,CAAC;AACjD,eAAO,MAAM,+BAA+B,iDACI,CAAC;AAGjD,MAAM,MAAM,qBAAqB,GAAG,WAAW,GAAG;IAChD;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;gBAC/B,EACV,UAAkD,EAClD,WAAW,EACX,GAAG,MAAM,EACV,GAAE,qBAA0B;CAa9B"}

package/lib/types/common/token/spl.d.ts

@@ -0,0 +1,64 @@
+import { Connection } from '@solana/web3.js';
+import { AoProcessConfig, TokenConfig, TokenCreateTxParams, TokenPollingOptions, TokenTools, TurboLogger } from '../../types.js';
+/**
+ * Funding by an **SPL token transfer on Solana**: an idempotent
+ * create-associated-token-account, a `transferChecked` to the recipient's ATA,
+ * and an optional `turboCreditDestinationAddress=` memo when the credit should
+ * land on a different Turbo account than the payer.
+ *
+ * This is the generic shape of what `ARIOToken` has always done — ARIO is an SPL
+ * token — so a second SPL token (USDC) is a mint and a decimals value, not a
+ * second implementation. The payment service verifies both with one class too
+ * (`SolanaSplGateway`).
+ *
+ * Two constraints worth knowing before pointing this at a third token:
+ *  - The associated token accounts are derived for the CLASSIC SPL Token
+ *    program (Tokenkeg), which is what ARIO and USDC use. A Token-2022 mint
+ *    derives a different ATA, so it would need its own program id threading
+ *    through `getAssociatedTokenAddressSync`. It fails loudly on-chain rather
+ *    than silently paying the wrong account.
+ *  - `decimals` must match the mint's own. `transferChecked` carries the value
+ *    and the chain rejects a mismatch, so a wrong value fails the transaction
+ *    instead of transferring a wrong amount.
+ */
+export declare class SplToken implements TokenTools {
+    protected logger: TurboLogger;
+    protected connection: Connection;
+    protected gatewayUrl: string;
+    protected pollingOptions: TokenPollingOptions;
+    protected mintAddress: string;
+    protected decimals: number;
+    /** Token name, used in log messages only. */
+    protected tokenName: string;
+    constructor({ mintAddress, decimals, tokenName, gatewayUrl, logger, pollingOptions, }: {
+        mintAddress: string;
+        decimals: number;
+        tokenName?: string;
+        gatewayUrl?: string;
+        logger?: TurboLogger;
+        pollingOptions?: TokenPollingOptions;
+    } & Partial<AoProcessConfig> & TokenConfig);
+    createAndSubmitTx({ target, signer, tokenAmount, turboCreditDestinationAddress, }: TokenCreateTxParams): Promise<{
+        id: string;
+        target: string;
+        reward: string;
+    }>;
+    /** Sign the message bytes directly: a private-key signer holds the key. */
+    private signWithKey;
+    /**
+     * Have a browser wallet sign the transaction itself, as the SOL path does.
+     *
+     * A wallet signs through `signTransaction`, not `signMessage`: it refuses, or
+     * cannot display, a serialized transaction handed to it as a message. It may
+     * also add instructions of its own before signing (compute budget, guards),
+     * so the transaction submitted is the one it returns, never ours with its
+     * signature attached. Deserializing drops `lastValidBlockHeight`, so that is
+     * carried over for confirmation.
+     */
+    private signWithWallet;
+    private submitTx;
+    pollTxAvailability({ txId }: {
+        txId: string;
+    }): Promise<void>;
+}
+//# sourceMappingURL=spl.d.ts.map

package/lib/types/common/token/spl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spl.d.ts","sourceRoot":"","sources":["../../../../src/common/token/spl.ts"],"names":[],"mappings":"AAoBA,OAAO,EACL,UAAU,EAMX,MAAM,iBAAiB,CAAC;AAIzB,OAAO,EACL,eAAe,EAEf,WAAW,EACX,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EACV,WAAW,EAEZ,MAAM,gBAAgB,CAAC;AAKxB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,QAAS,YAAW,UAAU;IACzC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC;IAE9B,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;IACjC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,cAAc,EAAE,mBAAmB,CAAC;IAC9C,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC3B,6CAA6C;IAC7C,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;gBAEhB,EACV,WAAW,EACX,QAAQ,EACR,SAAiB,EACjB,UAA0C,EAC1C,MAAuB,EACvB,cAIC,GACF,EAAE;QACD,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,cAAc,CAAC,EAAE,mBAAmB,CAAC;KACtC,GAAG,OAAO,CAAC,eAAe,CAAC,GAC1B,WAAW;IAUA,iBAAiB,CAAC,EAC7B,MAAM,EACN,MAAM,EACN,WAAW,EACX,6BAA6B,GAC9B,EAAE,mBAAmB,GAAG,OAAO,CAAC;QAC/B,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAuEF,2EAA2E;YAC7D,WAAW;IAYzB;;;;;;;;;OASG;YACW,cAAc;YAgBd,QAAQ;IA6BT,kBAAkB,CAAC,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CA2D3E"}