@4mica/sdk 1.0.0 → 1.0.2

package/dist/abi/erc20.json

@@ -1,187 +0,0 @@
-{
-    "abi": [
-        {
-            "type": "function",
-            "name": "allowance",
-            "inputs": [
-                {
-                    "name": "owner",
-                    "type": "address",
-                    "internalType": "address"
-                },
-                {
-                    "name": "spender",
-                    "type": "address",
-                    "internalType": "address"
-                }
-            ],
-            "outputs": [
-                {
-                    "name": "",
-                    "type": "uint256",
-                    "internalType": "uint256"
-                }
-            ],
-            "stateMutability": "view"
-        },
-        {
-            "type": "function",
-            "name": "approve",
-            "inputs": [
-                {
-                    "name": "spender",
-                    "type": "address",
-                    "internalType": "address"
-                },
-                {
-                    "name": "value",
-                    "type": "uint256",
-                    "internalType": "uint256"
-                }
-            ],
-            "outputs": [
-                {
-                    "name": "",
-                    "type": "bool",
-                    "internalType": "bool"
-                }
-            ],
-            "stateMutability": "nonpayable"
-        },
-        {
-            "type": "function",
-            "name": "balanceOf",
-            "inputs": [
-                {
-                    "name": "account",
-                    "type": "address",
-                    "internalType": "address"
-                }
-            ],
-            "outputs": [
-                {
-                    "name": "",
-                    "type": "uint256",
-                    "internalType": "uint256"
-                }
-            ],
-            "stateMutability": "view"
-        },
-        {
-            "type": "function",
-            "name": "totalSupply",
-            "inputs": [],
-            "outputs": [
-                {
-                    "name": "",
-                    "type": "uint256",
-                    "internalType": "uint256"
-                }
-            ],
-            "stateMutability": "view"
-        },
-        {
-            "type": "function",
-            "name": "transfer",
-            "inputs": [
-                {
-                    "name": "to",
-                    "type": "address",
-                    "internalType": "address"
-                },
-                {
-                    "name": "value",
-                    "type": "uint256",
-                    "internalType": "uint256"
-                }
-            ],
-            "outputs": [
-                {
-                    "name": "",
-                    "type": "bool",
-                    "internalType": "bool"
-                }
-            ],
-            "stateMutability": "nonpayable"
-        },
-        {
-            "type": "function",
-            "name": "transferFrom",
-            "inputs": [
-                {
-                    "name": "from",
-                    "type": "address",
-                    "internalType": "address"
-                },
-                {
-                    "name": "to",
-                    "type": "address",
-                    "internalType": "address"
-                },
-                {
-                    "name": "value",
-                    "type": "uint256",
-                    "internalType": "uint256"
-                }
-            ],
-            "outputs": [
-                {
-                    "name": "",
-                    "type": "bool",
-                    "internalType": "bool"
-                }
-            ],
-            "stateMutability": "nonpayable"
-        },
-        {
-            "type": "event",
-            "name": "Approval",
-            "inputs": [
-                {
-                    "name": "owner",
-                    "type": "address",
-                    "indexed": true,
-                    "internalType": "address"
-                },
-                {
-                    "name": "spender",
-                    "type": "address",
-                    "indexed": true,
-                    "internalType": "address"
-                },
-                {
-                    "name": "value",
-                    "type": "uint256",
-                    "indexed": false,
-                    "internalType": "uint256"
-                }
-            ],
-            "anonymous": false
-        },
-        {
-            "type": "event",
-            "name": "Transfer",
-            "inputs": [
-                {
-                    "name": "from",
-                    "type": "address",
-                    "indexed": true,
-                    "internalType": "address"
-                },
-                {
-                    "name": "to",
-                    "type": "address",
-                    "indexed": true,
-                    "internalType": "address"
-                },
-                {
-                    "name": "value",
-                    "type": "uint256",
-                    "indexed": false,
-                    "internalType": "uint256"
-                }
-            ],
-            "anonymous": false
-        }
-    ]
-}

package/dist/client.d.ts

@@ -1,56 +0,0 @@
-import type { AuthTokens } from './auth';
-import { Config } from './config';
-import { ContractGateway } from './contract';
-import { AssetBalanceInfo, BLSCert, CollateralEventInfo, GuaranteeInfo, PaymentGuaranteeClaims, PaymentGuaranteeRequestClaims, PaymentSignature, PendingRemunerationInfo, RecipientPaymentInfo, SigningScheme, TabInfo, TabPaymentStatus, UserInfo } from './models';
-import { RpcProxy } from './rpc';
-import { CorePublicParameters, PaymentSigner } from './signing';
-export declare class Client {
-    readonly rpc: RpcProxy;
-    readonly params: CorePublicParameters;
-    readonly gateway: ContractGateway;
-    readonly guaranteeDomain: string;
-    readonly user: UserClient;
-    readonly recipient: RecipientClient;
-    readonly signer: PaymentSigner;
-    private authSession?;
-    private constructor();
-    static new(cfg: Config): Promise<Client>;
-    private static buildGateway;
-    aclose(): Promise<void>;
-    login(): Promise<AuthTokens>;
-}
-export declare class UserClient {
-    private client;
-    constructor(client: Client);
-    get guaranteeDomain(): string;
-    approveErc20(token: string, amount: number | bigint | string): Promise<import("viem").TransactionReceipt>;
-    deposit(amount: number | bigint | string, erc20Token?: string): Promise<import("viem").TransactionReceipt>;
-    getUser(): Promise<UserInfo[]>;
-    getTabPaymentStatus(tabId: number | bigint): Promise<TabPaymentStatus>;
-    signPayment(claims: PaymentGuaranteeRequestClaims, scheme?: SigningScheme): Promise<PaymentSignature>;
-    payTab(tabId: number | bigint, reqId: number | bigint, amount: number | bigint | string, recipientAddress: string, erc20Token?: string): Promise<import("viem").TransactionReceipt>;
-    requestWithdrawal(amount: number | bigint | string, erc20Token?: string): Promise<import("viem").TransactionReceipt>;
-    cancelWithdrawal(erc20Token?: string): Promise<import("viem").TransactionReceipt>;
-    finalizeWithdrawal(erc20Token?: string): Promise<import("viem").TransactionReceipt>;
-}
-export declare class RecipientClient {
-    private client;
-    constructor(client: Client);
-    private get recipientAddress();
-    get guaranteeDomain(): string;
-    createTab(userAddress: string, recipientAddress: string, erc20Token: string | undefined | null, ttl?: number | null): Promise<bigint>;
-    getTabPaymentStatus(tabId: number | bigint): Promise<TabPaymentStatus>;
-    issuePaymentGuarantee(claims: PaymentGuaranteeRequestClaims, signature: string, scheme: SigningScheme): Promise<BLSCert>;
-    verifyPaymentGuarantee(cert: BLSCert): PaymentGuaranteeClaims;
-    remunerate(cert: BLSCert): Promise<import("viem").TransactionReceipt>;
-    listSettledTabs(): Promise<TabInfo[]>;
-    listPendingRemunerations(): Promise<PendingRemunerationInfo[]>;
-    getTab(tabId: number | bigint): Promise<TabInfo | null>;
-    listRecipientTabs(settlementStatuses?: string[]): Promise<TabInfo[]>;
-    getTabGuarantees(tabId: number | bigint): Promise<GuaranteeInfo[]>;
-    getLatestGuarantee(tabId: number | bigint): Promise<GuaranteeInfo | null>;
-    getGuarantee(tabId: number | bigint, reqId: number | bigint): Promise<GuaranteeInfo | null>;
-    listRecipientPayments(): Promise<RecipientPaymentInfo[]>;
-    getCollateralEventsForTab(tabId: number | bigint): Promise<CollateralEventInfo[]>;
-    getUserAssetBalance(userAddress: string, assetAddress: string): Promise<AssetBalanceInfo | null>;
-}

package/dist/client.js

@@ -1,258 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RecipientClient = exports.UserClient = exports.Client = void 0;
-const bls_1 = require("./bls");
-const auth_1 = require("./auth");
-const contract_1 = require("./contract");
-const errors_1 = require("./errors");
-const guarantee_1 = require("./guarantee");
-const models_1 = require("./models");
-const rpc_1 = require("./rpc");
-const signing_1 = require("./signing");
-const utils_1 = require("./utils");
-const isNumericLike = (value) => typeof value === 'number' || typeof value === 'bigint' || typeof value === 'string';
-function tabStatusFromRpc(status) {
-    const paid = status.paid !== undefined ? status.paid : (status.paidAmount ?? 0);
-    const remunerated = status.remunerated ?? status.paidOut ?? false;
-    const asset = status.asset ?? status.assetAddress ?? '';
-    return {
-        paid: (0, utils_1.parseU256)(paid),
-        remunerated: Boolean(remunerated),
-        asset,
-    };
-}
-class Client {
-    rpc;
-    params;
-    gateway;
-    guaranteeDomain;
-    user;
-    recipient;
-    signer;
-    authSession;
-    constructor(rpc, params, gateway, guaranteeDomain, signer, authSession) {
-        this.rpc = rpc;
-        this.params = params;
-        this.gateway = gateway;
-        this.guaranteeDomain = guaranteeDomain;
-        this.signer = signer;
-        this.authSession = authSession;
-        this.user = new UserClient(this);
-        this.recipient = new RecipientClient(this);
-    }
-    static async new(cfg) {
-        const rpc = new rpc_1.RpcProxy(cfg.rpcUrl, cfg.adminApiKey);
-        const params = await rpc.getPublicParams();
-        const gateway = await Client.buildGateway(cfg, params);
-        const guaranteeDomain = await gateway.getGuaranteeDomain();
-        const signer = new signing_1.PaymentSigner(cfg.signer);
-        const authEnabled = cfg.authUrl !== undefined || cfg.authRefreshMarginSecs !== undefined;
-        const authSession = cfg.bearerToken || !authEnabled
-            ? undefined
-            : new auth_1.AuthSession({
-                authUrl: cfg.authUrl ?? cfg.rpcUrl,
-                signer: cfg.signer,
-                refreshMarginSecs: cfg.authRefreshMarginSecs ?? 60,
-            });
-        if (cfg.bearerToken) {
-            rpc.withBearerToken(cfg.bearerToken);
-        }
-        else if (authSession) {
-            rpc.withTokenProvider(() => authSession.accessToken());
-        }
-        return new Client(rpc, params, gateway, guaranteeDomain, signer, authSession);
-    }
-    static async buildGateway(cfg, params) {
-        const ethRpcUrl = cfg.ethereumHttpRpcUrl ?? params.ethereumHttpRpcUrl;
-        const contractAddress = cfg.contractAddress ?? params.contractAddress;
-        return contract_1.ContractGateway.create(ethRpcUrl, cfg.signer, contractAddress, params.chainId);
-    }
-    async aclose() {
-        await this.rpc.aclose();
-    }
-    async login() {
-        if (!this.authSession) {
-            throw new errors_1.AuthMissingConfigError('auth is not enabled');
-        }
-        return this.authSession.login();
-    }
-}
-exports.Client = Client;
-class UserClient {
-    client;
-    constructor(client) {
-        this.client = client;
-    }
-    get guaranteeDomain() {
-        return this.client.guaranteeDomain;
-    }
-    async approveErc20(token, amount) {
-        return this.client.gateway.approveErc20(token, amount);
-    }
-    async deposit(amount, erc20Token) {
-        return this.client.gateway.deposit(amount, erc20Token);
-    }
-    async getUser() {
-        const assets = await this.client.gateway.getUserAssets();
-        return assets.map((a) => ({
-            asset: a.asset,
-            collateral: (0, utils_1.parseU256)(a.collateral),
-            withdrawalRequestAmount: (0, utils_1.parseU256)(a.withdrawalRequestAmount),
-            withdrawalRequestTimestamp: Number(a.withdrawalRequestTimestamp),
-        }));
-    }
-    async getTabPaymentStatus(tabId) {
-        const status = await this.client.gateway.getPaymentStatus(tabId);
-        return tabStatusFromRpc(status);
-    }
-    async signPayment(claims, scheme = models_1.SigningScheme.EIP712) {
-        return this.client.signer.signRequest(this.client.params, claims, scheme);
-    }
-    async payTab(tabId, reqId, amount, recipientAddress, erc20Token) {
-        if (erc20Token) {
-            return this.client.gateway.payTabErc20(tabId, amount, erc20Token, recipientAddress);
-        }
-        return this.client.gateway.payTabEth(tabId, reqId, amount, recipientAddress);
-    }
-    async requestWithdrawal(amount, erc20Token) {
-        return this.client.gateway.requestWithdrawal(amount, erc20Token);
-    }
-    async cancelWithdrawal(erc20Token) {
-        return this.client.gateway.cancelWithdrawal(erc20Token);
-    }
-    async finalizeWithdrawal(erc20Token) {
-        return this.client.gateway.finalizeWithdrawal(erc20Token);
-    }
-}
-exports.UserClient = UserClient;
-class RecipientClient {
-    client;
-    constructor(client) {
-        this.client = client;
-    }
-    get recipientAddress() {
-        return (0, utils_1.normalizeAddress)(this.client.signer.signer.address);
-    }
-    get guaranteeDomain() {
-        return this.client.guaranteeDomain;
-    }
-    async createTab(userAddress, recipientAddress, erc20Token, ttl) {
-        const body = {
-            user_address: (0, utils_1.normalizeAddress)(userAddress),
-            recipient_address: (0, utils_1.normalizeAddress)(recipientAddress),
-            erc20_token: erc20Token ? (0, utils_1.normalizeAddress)(erc20Token) : null,
-            ttl: ttl ?? null,
-        };
-        const result = await this.client.rpc.createPaymentTab(body);
-        const record = result;
-        const tabIdRaw = record.id ?? record.tabId ?? record.tab_id;
-        const tabId = isNumericLike(tabIdRaw) ? tabIdRaw : 0;
-        return (0, utils_1.parseU256)(tabId);
-    }
-    async getTabPaymentStatus(tabId) {
-        const status = await this.client.gateway.getPaymentStatus(tabId);
-        return tabStatusFromRpc(status);
-    }
-    async issuePaymentGuarantee(claims, signature, scheme) {
-        const payload = {
-            claims: {
-                version: 'v1',
-                user_address: claims.userAddress,
-                recipient_address: claims.recipientAddress,
-                tab_id: (0, utils_1.serializeU256)(claims.tabId),
-                req_id: (0, utils_1.serializeU256)(claims.reqId),
-                amount: (0, utils_1.serializeU256)(claims.amount),
-                asset_address: claims.assetAddress,
-                timestamp: Number(claims.timestamp),
-            },
-            signature,
-            scheme,
-        };
-        const cert = await this.client.rpc.issueGuarantee(payload);
-        const record = cert;
-        const certClaims = typeof record.claims === 'string' ? record.claims : '';
-        const signatureOut = typeof record.signature === 'string' ? record.signature : '';
-        return { claims: certClaims, signature: signatureOut };
-    }
-    verifyPaymentGuarantee(cert) {
-        const claims = (0, guarantee_1.decodeGuaranteeClaims)(cert.claims);
-        const domainHex = this.guaranteeDomain.startsWith('0x')
-            ? this.guaranteeDomain.slice(2)
-            : Buffer.from(this.guaranteeDomain).toString('hex');
-        const claimsHex = Buffer.from(claims.domain).toString('hex');
-        if (claimsHex !== domainHex) {
-            throw new errors_1.VerificationError('guarantee domain mismatch');
-        }
-        return claims;
-    }
-    async remunerate(cert) {
-        this.verifyPaymentGuarantee(cert);
-        const describeValue = (value) => {
-            if (value === null)
-                return 'null';
-            if (value === undefined)
-                return 'undefined';
-            if (Array.isArray(value))
-                return `array(len=${value.length})`;
-            if (typeof value === 'object') {
-                const keys = Object.keys(value);
-                return `object(keys=${keys.slice(0, 6).join(',')}${keys.length > 6 ? ',...' : ''})`;
-            }
-            return typeof value;
-        };
-        if (process.env.DEBUG_CERTS === '1') {
-            const preview = typeof cert.signature === 'string' ? cert.signature.slice(0, 12) : '';
-            console.log(`  debug remunerate: signature=${describeValue(cert.signature)} ${preview}`);
-        }
-        if (typeof cert.claims !== 'string') {
-            throw new errors_1.VerificationError(`certificate.claims must be a hex string, got ${describeValue(cert.claims)}`);
-        }
-        if (typeof cert.signature !== 'string') {
-            throw new errors_1.VerificationError(`certificate.signature must be a hex string, got ${describeValue(cert.signature)}`);
-        }
-        const sigWords = await (0, bls_1.signatureToWordsAsync)(cert.signature);
-        const claimsBytes = Buffer.from(cert.claims.replace(/^0x/, ''), 'hex');
-        return this.client.gateway.remunerate(claimsBytes, sigWords);
-    }
-    async listSettledTabs() {
-        const tabs = await this.client.rpc.listSettledTabs(this.recipientAddress);
-        return tabs.map((t) => models_1.TabInfo.fromRpc(t));
-    }
-    async listPendingRemunerations() {
-        const items = await this.client.rpc.listPendingRemunerations(this.recipientAddress);
-        return items.map((item) => models_1.PendingRemunerationInfo.fromRpc(item));
-    }
-    async getTab(tabId) {
-        const result = await this.client.rpc.getTab(tabId);
-        return result ? models_1.TabInfo.fromRpc(result) : null;
-    }
-    async listRecipientTabs(settlementStatuses) {
-        const tabs = await this.client.rpc.listRecipientTabs(this.recipientAddress, settlementStatuses);
-        return tabs.map((t) => models_1.TabInfo.fromRpc(t));
-    }
-    async getTabGuarantees(tabId) {
-        const guarantees = await this.client.rpc.getTabGuarantees(tabId);
-        return guarantees.map((g) => models_1.GuaranteeInfo.fromRpc(g));
-    }
-    async getLatestGuarantee(tabId) {
-        const result = await this.client.rpc.getLatestGuarantee(tabId);
-        return result ? models_1.GuaranteeInfo.fromRpc(result) : null;
-    }
-    async getGuarantee(tabId, reqId) {
-        const result = await this.client.rpc.getGuarantee(tabId, reqId);
-        return result ? models_1.GuaranteeInfo.fromRpc(result) : null;
-    }
-    async listRecipientPayments() {
-        const payments = await this.client.rpc.listRecipientPayments(this.recipientAddress);
-        return payments.map((p) => models_1.RecipientPaymentInfo.fromRpc(p));
-    }
-    async getCollateralEventsForTab(tabId) {
-        const events = await this.client.rpc.getCollateralEventsForTab(tabId);
-        return events.map((ev) => models_1.CollateralEventInfo.fromRpc(ev));
-    }
-    async getUserAssetBalance(userAddress, assetAddress) {
-        const balance = await this.client.rpc.getUserAssetBalance(userAddress, assetAddress);
-        return balance ? models_1.AssetBalanceInfo.fromRpc(balance) : null;
-    }
-}
-exports.RecipientClient = RecipientClient;