@ar.io/sdk 3.10.0-alpha.1 → 3.10.0

package/lib/esm/common/turbo.js

@@ -1,129 +0,0 @@
-/**
- * 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 { SignatureConfig } from '@dha-team/arbundles';
-import { v4 as uuidv4 } from 'uuid';
-import { mARIOToken } from '../types/token.js';
-import { toB64Url } from '../utils/base64.js';
-import { createAxiosInstance } from '../utils/http-client.js';
-import { urlWithSearchParams } from '../utils/url.js';
-import { Logger } from './logger.js';
-export async function signedRequestHeadersFromSigner({ signer, nonce = uuidv4(), }) {
-    await signer.setPublicKey?.();
-    const signature = await signer.sign(Uint8Array.from(Buffer.from(nonce)));
-    let publicKey;
-    switch (signer.signatureType) {
-        case SignatureConfig.ARWEAVE:
-            publicKey = toB64Url(signer.publicKey);
-            break;
-        case SignatureConfig.ETHEREUM:
-            publicKey = '0x' + signer.publicKey.toString('hex');
-            break;
-        // TODO: solana sig support
-        // case SignatureConfig.SOLANA:
-        // case SignatureConfig.ED25519:
-        default:
-            throw new Error(`Unsupported signer type for signing requests: ${signer.signatureType}`);
-    }
-    return {
-        'x-public-key': publicKey,
-        'x-nonce': nonce,
-        'x-signature': toB64Url(Buffer.from(signature)),
-        'x-signature-type': signer.signatureType,
-    };
-}
-export class TurboArNSPaymentProvider {
-    paymentUrl;
-    axios;
-    logger;
-    signer;
-    constructor({ paymentUrl = 'https://payment.ardrive.io', axios = createAxiosInstance(), logger = Logger.default, signer, }) {
-        this.paymentUrl = paymentUrl;
-        this.axios = axios;
-        this.logger = logger;
-        this.signer = signer;
-    }
-    async getArNSPriceDetails({ intent, name, quantity, type, years, }) {
-        const url = urlWithSearchParams({
-            baseUrl: `${this.paymentUrl}/v1/arns/price/${intent}/${name}`,
-            params: {
-                increaseQty: quantity,
-                type,
-                years,
-            },
-        });
-        const { data, status } = await this.axios.get(url);
-        this.logger.debug('getArNSPriceDetails', {
-            intent,
-            name,
-            quantity,
-            type,
-            years,
-            data,
-            status,
-        });
-        if (status !== 200) {
-            throw new Error('Failed to get ArNS purchase price ' + JSON.stringify(data));
-        }
-        if (!data.winc || !data.mARIO) {
-            throw new Error('Invalid response from Turbo ' + JSON.stringify(data));
-        }
-        return {
-            winc: data.winc,
-            mARIO: new mARIOToken(+data.mARIO),
-        };
-    }
-    async getPrice(params) {
-        const { winc } = await this.getArNSPriceDetails(params);
-        return +winc;
-    }
-    async initiateArNSPurchase({ intent, name, quantity, type, processId, years, }) {
-        if (!this.signer) {
-            throw new Error('Signer required for initiating ArNS purchase with Turbo');
-        }
-        const url = urlWithSearchParams({
-            baseUrl: `${this.paymentUrl}/v1/arns/purchase/${intent}/${name}`,
-            params: {
-                increaseQty: quantity,
-                processId,
-                type,
-                years,
-            },
-        });
-        const headers = await signedRequestHeadersFromSigner({
-            signer: this.signer,
-        });
-        const { data, status } = await this.axios.post(url, null, {
-            headers,
-        });
-        this.logger.debug('Initiated ArNS purchase', {
-            intent,
-            name,
-            quantity,
-            processId,
-            type,
-            years,
-            data,
-            status,
-        });
-        if (status !== 200) {
-            throw new Error('Failed to initiate ArNS purchase ' + JSON.stringify(data));
-        }
-        return {
-            id: data.arioWriteResult.id,
-            result: data.purchaseReceipt,
-        };
-    }
-}

package/lib/esm/utils/url.js

@@ -1,24 +0,0 @@
-/**
- * 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.
- */
-export const urlWithSearchParams = ({ baseUrl, params, }) => {
-    const urlObj = new URL(baseUrl);
-    Object.entries(params).forEach(([key, value]) => {
-        if (value === undefined || value === null)
-            return;
-        urlObj.searchParams.set(key, value.toString());
-    });
-    return urlObj.toString();
-};

package/lib/esm/utils/url.test.js

@@ -1,19 +0,0 @@
-import assert from 'node:assert';
-import { test } from 'node:test';
-import { urlWithSearchParams } from './url.js';
-test('urlWithSearchParams prunes undefined values but keeps other falsey values', () => {
-    const result = urlWithSearchParams({
-        baseUrl: 'https://example.com',
-        params: {
-            number: 1,
-            string: 'string',
-            boolean: true,
-            empty: '',
-            zero: 0,
-            false: false,
-            null: null,
-            undef: undefined,
-        },
-    });
-    assert.strictEqual(result, 'https://example.com/?number=1&string=string&boolean=true&empty=&zero=0&false=false');
-});

package/lib/types/common/turbo.d.ts

@@ -1,47 +0,0 @@
-import { AxiosInstance, RawAxiosRequestHeaders } from 'axios';
-import { AoMessageResult, TransactionId, TurboArNSSigner, WriteOptions } from '../types/common.js';
-import { AoTokenCostParams } from '../types/io.js';
-import { mARIOToken } from '../types/token.js';
-import { ILogger } from './logger.js';
-export interface TurboConfig {
-    paymentUrl?: string;
-    logger?: ILogger;
-    axios?: AxiosInstance;
-    signer?: TurboArNSSigner;
-}
-export declare function signedRequestHeadersFromSigner({ signer, nonce, }: {
-    signer: TurboArNSSigner;
-    nonce?: string;
-}): Promise<RawAxiosRequestHeaders>;
-export type ArNSPurchaseReceipt = AoTokenCostParams & {
-    wincQty: string;
-    mARIOQty: string;
-    usdArRate: number;
-    createdDate: string;
-};
-export interface ArNSPaymentProvider {
-    /** Returns the cost of the action in the Payment Provider's native currency (winc for Turbo) */
-    getPrice(params: AoTokenCostParams): Promise<number>;
-    getArNSPriceDetails(params: AoTokenCostParams): Promise<{
-        winc: string;
-        mARIO: mARIOToken;
-    }>;
-    initiateArNSPurchase(params: AoTokenCostParams & {
-        processId?: TransactionId;
-    }, options: WriteOptions): Promise<AoMessageResult<ArNSPurchaseReceipt>>;
-}
-export declare class TurboArNSPaymentProvider implements ArNSPaymentProvider {
-    private readonly paymentUrl;
-    private readonly axios;
-    private readonly logger;
-    private readonly signer?;
-    constructor({ paymentUrl, axios, logger, signer, }: TurboConfig);
-    getArNSPriceDetails({ intent, name, quantity, type, years, }: AoTokenCostParams): Promise<{
-        winc: string;
-        mARIO: mARIOToken;
-    }>;
-    getPrice(params: AoTokenCostParams): Promise<number>;
-    initiateArNSPurchase({ intent, name, quantity, type, processId, years, }: AoTokenCostParams & {
-        processId?: TransactionId;
-    }): Promise<AoMessageResult<ArNSPurchaseReceipt>>;
-}

package/lib/types/utils/url.d.ts

@@ -1,19 +0,0 @@
-/**
- * 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.
- */
-export declare const urlWithSearchParams: ({ baseUrl, params, }: {
-    baseUrl: string;
-    params: Record<string, string | number | boolean | null | undefined>;
-}) => string;