@polymarket/relayer-client 2.0.2 → 4.0.0

package/dist/client.d.ts

@@ -1,41 +0,0 @@
-import { Wallet } from "@ethersproject/wallet";
-import { JsonRpcSigner } from "@ethersproject/providers";
-import { WalletClient } from "viem";
-import { IAbstractSigner } from "@polymarket/abstract-signer";
-import { HttpClient } from "./http-helpers";
-import { AddressPayload, AuthArgs, IManualTransactionResponse, ManualOverrides, NoncePayload, ProxyTransaction, RelayerTransaction, RelayerTransactionResponse, RelayPayload, SafeTransaction } from "./types";
-import { AuthHandler } from "./auth";
-import { ContractConfig } from "./config";
-export declare class RelayClient {
-    readonly relayerUrl: string;
-    readonly chainId: number;
-    readonly contractConfig: ContractConfig;
-    readonly httpClient: HttpClient;
-    readonly signer?: IAbstractSigner;
-    readonly authHandler?: AuthHandler;
-    constructor(relayerUrl: string, chainId: number, signer?: Wallet | JsonRpcSigner | WalletClient, authArgs?: AuthArgs);
-    getRelayAddress(): Promise<AddressPayload>;
-    getNonce(signerAddress: string, signerType: string): Promise<NoncePayload>;
-    getRelayPayload(signerAddress: string, signerType: string): Promise<RelayPayload>;
-    getTransaction(transactionId: string): Promise<RelayerTransaction[]>;
-    getTransactions(): Promise<RelayerTransaction[]>;
-    executeProxyTransactions(txns: ProxyTransaction[], metadata?: string): Promise<RelayerTransactionResponse>;
-    executeSafeTransactions(txns: SafeTransaction[], metadata?: string): Promise<RelayerTransactionResponse>;
-    executeManualTransactions(txns: SafeTransaction[], overrides?: ManualOverrides): Promise<IManualTransactionResponse>;
-    deploySafe(): Promise<RelayerTransactionResponse>;
-    /**
-     * Periodically polls the transaction id until it reaches a desired state
-     * Returns the relayer transaction if it does each the desired state
-     * Returns undefined if the transaction hits the failed state
-     * Times out after maxPolls is reached
-     * @param transactionId
-     * @param states
-     * @param failState
-     * @param maxPolls
-     * @param pollFrequency
-     * @returns
-     */
-    pollUntilState(transactionId: string, states: string[], failState?: string, maxPolls?: number, pollFrequency?: number): Promise<RelayerTransaction | undefined>;
-    private submitTransaction;
-    private send;
-}

package/dist/client.js

@@ -1,178 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RelayClient = void 0;
-const tslib_1 = require("tslib");
-const browser_or_node_1 = tslib_1.__importDefault(require("browser-or-node"));
-const viem_1 = require("viem");
-const abstract_signer_1 = require("@polymarket/abstract-signer");
-const http_helpers_1 = require("./http-helpers");
-const types_1 = require("./types");
-const endpoints_1 = require("./endpoints");
-const builder_1 = require("./builder");
-const encode_1 = require("./encode");
-const auth_1 = require("./auth");
-const utils_1 = require("./utils");
-const manual_1 = require("./manual");
-const response_1 = require("./response");
-const config_1 = require("./config");
-class RelayClient {
-    relayerUrl;
-    chainId;
-    contractConfig;
-    httpClient;
-    signer;
-    authHandler;
-    constructor(relayerUrl, chainId, signer, authArgs) {
-        this.relayerUrl = relayerUrl.endsWith("/") ? relayerUrl.slice(0, -1) : relayerUrl;
-        this.chainId = chainId;
-        this.contractConfig = (0, config_1.getContractConfig)(chainId);
-        this.httpClient = new http_helpers_1.HttpClient();
-        if (signer != undefined) {
-            this.signer = (0, abstract_signer_1.createAbstractSigner)(chainId, signer);
-        }
-        if (authArgs !== undefined) {
-            this.authHandler = new auth_1.AuthHandler(this.httpClient, authArgs);
-        }
-    }
-    async getRelayAddress() {
-        return this.send(`${this.relayerUrl}${endpoints_1.GET_ADDRESS}`, http_helpers_1.GET);
-    }
-    async getNonce(signerAddress, signerType) {
-        return this.send(`${this.relayerUrl}${endpoints_1.GET_NONCE}?address=${signerAddress}&type=${signerType}`, http_helpers_1.GET);
-    }
-    async getRelayPayload(signerAddress, signerType) {
-        return this.send(`${this.relayerUrl}${endpoints_1.GET_RELAY_PAYLOAD}?address=${signerAddress}&type=${signerType}`, http_helpers_1.GET);
-    }
-    async getTransaction(transactionId) {
-        return this.send(`${this.relayerUrl}${endpoints_1.GET_TRANSACTION}?id=${transactionId}`, http_helpers_1.GET);
-    }
-    async getTransactions() {
-        return this.send(`${this.relayerUrl}${endpoints_1.GET_TRANSACTION}s`, http_helpers_1.GET);
-    }
-    async executeProxyTransactions(txns, metadata) {
-        if (this.signer == undefined) {
-            throw new Error("missing signer");
-        }
-        const start = Date.now();
-        const from = await this.signer.getAddress();
-        const rp = await this.getRelayPayload(from, types_1.TransactionType.PROXY);
-        const args = {
-            from: from,
-            gasPrice: "0",
-            data: (0, encode_1.encodeProxyTransactionData)(txns),
-            relay: rp.address,
-            nonce: rp.nonce,
-        };
-        const proxyContractConfig = this.contractConfig.ProxyContracts;
-        const request = await (0, builder_1.buildProxyTransactionRequest)(this.signer, args, proxyContractConfig, metadata);
-        console.log(`Client side proxy request creation took: ${(Date.now() - start) / 1000} seconds`);
-        const resp = await this.submitTransaction(request);
-        return new response_1.ClientRelayerTransactionResponse(resp.transactionID, resp.state, resp.transactionHash, this);
-    }
-    async executeSafeTransactions(txns, metadata) {
-        if (this.signer == undefined) {
-            throw new Error("missing signer");
-        }
-        const start = Date.now();
-        const from = await this.signer.getAddress();
-        const noncePayload = await this.getNonce(from, types_1.TransactionType.SAFE);
-        const args = {
-            transactions: txns,
-            from,
-            nonce: noncePayload.nonce,
-            chainId: this.chainId,
-        };
-        const safeContractConfig = this.contractConfig.SafeContracts;
-        const request = await (0, builder_1.buildSafeTransactionRequest)(this.signer, args, safeContractConfig, metadata);
-        console.log(`Client side safe request creation took: ${(Date.now() - start) / 1000} seconds`);
-        const resp = await this.submitTransaction(request);
-        return new response_1.ClientRelayerTransactionResponse(resp.transactionID, resp.state, resp.transactionHash, this);
-    }
-    async executeManualTransactions(txns, overrides) {
-        if (overrides == undefined) {
-            overrides = {};
-        }
-        if (this.signer == undefined) {
-            throw new Error("missing signer");
-        }
-        return (0, manual_1.executeManualTransactions)(this.signer, this.contractConfig.SafeContracts, txns, overrides);
-    }
-    async deploySafe() {
-        if (this.signer == undefined) {
-            throw new Error("missing signer");
-        }
-        const start = Date.now();
-        const from = await this.signer?.getAddress();
-        const args = {
-            from: from,
-            chainId: this.chainId,
-            paymentToken: viem_1.zeroAddress,
-            payment: "0",
-            paymentReceiver: viem_1.zeroAddress,
-        };
-        const safeContractConfig = this.contractConfig.SafeContracts;
-        const request = await (0, builder_1.buildSafeCreateTransactionRequest)(this.signer, safeContractConfig, args);
-        console.log(`Client side deploy request creation took: ${(Date.now() - start) / 1000} seconds`);
-        const resp = await this.submitTransaction(request);
-        return new response_1.ClientRelayerTransactionResponse(resp.transactionID, resp.state, resp.transactionHash, this);
-    }
-    /**
-     * Periodically polls the transaction id until it reaches a desired state
-     * Returns the relayer transaction if it does each the desired state
-     * Returns undefined if the transaction hits the failed state
-     * Times out after maxPolls is reached
-     * @param transactionId
-     * @param states
-     * @param failState
-     * @param maxPolls
-     * @param pollFrequency
-     * @returns
-     */
-    async pollUntilState(transactionId, states, failState, maxPolls, pollFrequency) {
-        console.log(`Waiting for transaction ${transactionId} matching states: ${states}...`);
-        const maxPollCount = maxPolls != undefined ? maxPolls : 10;
-        let pollFreq = 2000; // Default to polling every 2 seconds
-        if (pollFrequency != undefined) {
-            if (pollFrequency >= 1000) {
-                pollFreq = pollFrequency;
-            }
-        }
-        let pollCount = 0;
-        while (pollCount < maxPollCount) {
-            const txns = await this.getTransaction(transactionId);
-            if (txns.length > 0) {
-                const txn = txns[0];
-                if (states.includes(txn.state)) {
-                    return txn;
-                }
-                if (failState != undefined && txn.state == failState) {
-                    // Return undefined if txn reaches the fail state
-                    return undefined;
-                }
-            }
-            pollCount++;
-            await (0, utils_1.sleep)(pollFreq);
-        }
-        console.log(`Transaction not found or not in given states, timing out`);
-    }
-    async submitTransaction(req) {
-        return this.send(`${this.relayerUrl}${endpoints_1.SUBMIT_TRANSACTION}`, http_helpers_1.POST, undefined, req);
-    }
-    async send(endpoint, method, headers, data, params) {
-        // Explicitly inject the polymarket session cookies
-        // In prod environments, this will be unnecessary as the browser will have the needed cookies
-        // Needed only for local testing
-        if (!browser_or_node_1.default && this.authHandler !== undefined) {
-            const cookie = await this.authHandler.getPolymarketCookies();
-            if (headers != undefined) {
-                headers["Cookie"] = cookie;
-            }
-            else {
-                headers = { "Cookie": cookie };
-            }
-        }
-        const resp = await this.httpClient.send(endpoint, method, headers, data, params);
-        return resp.data;
-    }
-}
-exports.RelayClient = RelayClient;

package/dist/config/index.d.ts

@@ -1,13 +0,0 @@
-export interface ProxyContractConfig {
-    RelayHub: string;
-    ProxyFactory: string;
-}
-export interface SafeContractConfig {
-    SafeFactory: string;
-    SafeMultisend: string;
-}
-export interface ContractConfig {
-    ProxyContracts: ProxyContractConfig;
-    SafeContracts: SafeContractConfig;
-}
-export declare const getContractConfig: (chainId: number) => ContractConfig;

package/dist/config/index.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getContractConfig = void 0;
-;
-const AMOY = {
-    ProxyContracts: {
-        ProxyFactory: "",
-        RelayHub: ""
-    },
-    SafeContracts: {
-        SafeFactory: "",
-        SafeMultisend: "",
-    }
-};
-const POL = {
-    ProxyContracts: {
-        ProxyFactory: "0xaB45c5A4B0c941a2F231C04C3f49182e1A254052",
-        RelayHub: "0xD216153c06E857cD7f72665E0aF1d7D82172F494"
-    },
-    SafeContracts: {
-        SafeFactory: "0xaacFeEa03eb1561C4e67d661e40682Bd20E3541b",
-        SafeMultisend: "0xA238CBeb142c10Ef7Ad8442C6D1f9E89e07e7761",
-    }
-};
-const getContractConfig = (chainId) => {
-    switch (chainId) {
-        case 137:
-            return POL;
-        case 80002:
-            return AMOY;
-        default:
-            throw new Error("Invalid network");
-    }
-};
-exports.getContractConfig = getContractConfig;

package/dist/constants/index.d.ts

@@ -1,3 +0,0 @@
-export declare const PROXY_INIT_CODE_HASH = "0xd21df8dc65880a8606f09fe0ce3df9b8869287ab0b058be05aa9e8af6330a00b";
-export declare const SAFE_INIT_CODE_HASH = "0x2bce2127ff07fb632d16c8347c4ebf501f4841168bed00d9e6ef715ddb6fcecf";
-export declare const SAFE_FACTORY_NAME = "Polymarket Contract Proxy Factory";

package/dist/constants/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SAFE_FACTORY_NAME = exports.SAFE_INIT_CODE_HASH = exports.PROXY_INIT_CODE_HASH = void 0;
-exports.PROXY_INIT_CODE_HASH = "0xd21df8dc65880a8606f09fe0ce3df9b8869287ab0b058be05aa9e8af6330a00b";
-exports.SAFE_INIT_CODE_HASH = "0x2bce2127ff07fb632d16c8347c4ebf501f4841168bed00d9e6ef715ddb6fcecf";
-exports.SAFE_FACTORY_NAME = "Polymarket Contract Proxy Factory";

package/dist/encode/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./proxy";
-export * from "./safe";

package/dist/encode/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./proxy"), exports);
-tslib_1.__exportStar(require("./safe"), exports);

package/dist/encode/proxy.d.ts

@@ -1,2 +0,0 @@
-import { ProxyTransaction } from "../types";
-export declare function encodeProxyTransactionData(txns: ProxyTransaction[]): string;

package/dist/encode/proxy.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.encodeProxyTransactionData = encodeProxyTransactionData;
-const abis_1 = require("../abis");
-const viem_1 = require("viem");
-const proxy = (0, viem_1.prepareEncodeFunctionData)({
-    abi: abis_1.proxyWalletFactory,
-    functionName: 'proxy',
-});
-function encodeProxyTransactionData(txns) {
-    return (0, viem_1.encodeFunctionData)({
-        ...proxy,
-        args: [txns],
-    });
-}

package/dist/encode/safe.d.ts

@@ -1,2 +0,0 @@
-import { SafeTransaction } from "../types";
-export declare const createSafeMultisendTransaction: (txns: SafeTransaction[], safeMultisendAddress: string) => SafeTransaction;

package/dist/encode/safe.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSafeMultisendTransaction = void 0;
-const viem_1 = require("viem");
-const abis_1 = require("../abis");
-const types_1 = require("../types");
-const multisend = (0, viem_1.prepareEncodeFunctionData)({
-    abi: abis_1.multisendAbi,
-    functionName: "multiSend",
-});
-const createSafeMultisendTransaction = (txns, safeMultisendAddress) => {
-    const args = [
-        (0, viem_1.concatHex)(txns.map(tx => (0, viem_1.encodePacked)(["uint8", "address", "uint256", "uint256", "bytes"], [tx.operation, tx.to, BigInt(tx.value), BigInt((0, viem_1.size)(tx.data)), tx.data]))),
-    ];
-    const data = (0, viem_1.encodeFunctionData)({ ...multisend, args: args });
-    return {
-        to: safeMultisendAddress,
-        value: "0",
-        data: data,
-        operation: types_1.OperationType.DelegateCall,
-    };
-};
-exports.createSafeMultisendTransaction = createSafeMultisendTransaction;

package/dist/endpoints.d.ts

@@ -1,5 +0,0 @@
-export declare const GET_ADDRESS = "/address";
-export declare const GET_NONCE = "/nonce";
-export declare const GET_RELAY_PAYLOAD = "/relay-payload";
-export declare const GET_TRANSACTION = "/transaction";
-export declare const SUBMIT_TRANSACTION = "/submit";

package/dist/endpoints.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SUBMIT_TRANSACTION = exports.GET_TRANSACTION = exports.GET_RELAY_PAYLOAD = exports.GET_NONCE = exports.GET_ADDRESS = void 0;
-exports.GET_ADDRESS = "/address";
-exports.GET_NONCE = "/nonce";
-exports.GET_RELAY_PAYLOAD = "/relay-payload";
-exports.GET_TRANSACTION = "/transaction";
-exports.SUBMIT_TRANSACTION = "/submit";

package/dist/http-helpers/index.d.ts

@@ -1,10 +0,0 @@
-import { AxiosInstance, AxiosResponse, Method } from "axios";
-export declare const GET = "GET";
-export declare const POST = "POST";
-export declare const DELETE = "DELETE";
-export declare const PUT = "PUT";
-export declare class HttpClient {
-    readonly instance: AxiosInstance;
-    constructor();
-    send(endpoint: string, method: Method, headers?: any, data?: any, params?: any): Promise<AxiosResponse>;
-}

package/dist/http-helpers/index.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpClient = exports.PUT = exports.DELETE = exports.POST = exports.GET = void 0;
-const tslib_1 = require("tslib");
-const axios_1 = tslib_1.__importDefault(require("axios"));
-exports.GET = "GET";
-exports.POST = "POST";
-exports.DELETE = "DELETE";
-exports.PUT = "PUT";
-class HttpClient {
-    instance;
-    constructor() {
-        this.instance = axios_1.default.create({ withCredentials: true });
-    }
-    async send(endpoint, method, headers, data, params) {
-        if (headers != undefined) {
-            headers["Access-Control-Allow-Credentials"] = true;
-        }
-        try {
-            const resp = await this.instance.request({
-                method,
-                url: endpoint,
-                headers,
-                data,
-                params
-            });
-            return resp;
-        }
-        catch (err) {
-            if (axios_1.default.isAxiosError(err)) {
-                if (err.response) {
-                    const errPayload = {
-                        error: "request error",
-                        status: err.response?.status,
-                        statusText: err.response?.statusText,
-                        data: err.response?.data,
-                    };
-                    console.error("request error", errPayload);
-                    throw new Error(JSON.stringify(errPayload));
-                }
-                else {
-                    const errPayload = { error: "connection error" };
-                    console.error("connection error", errPayload);
-                    throw new Error(JSON.stringify(errPayload));
-                }
-            }
-            throw new Error(JSON.stringify({ error: err }));
-        }
-    }
-}
-exports.HttpClient = HttpClient;

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./client";
-export * from "./encode";
-export * from "./types";
-export * from "./response";

package/dist/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./client"), exports);
-tslib_1.__exportStar(require("./encode"), exports);
-tslib_1.__exportStar(require("./types"), exports);
-tslib_1.__exportStar(require("./response"), exports);

package/dist/manual/index.d.ts

@@ -1,5 +0,0 @@
-import { IAbstractSigner } from "@polymarket/abstract-signer";
-import { SafeContractConfig } from "../config";
-import { SafeTransaction, ManualOverrides } from "../types";
-import { ManualTransactionResponse } from "../response";
-export declare function executeManualTransactions(signer: IAbstractSigner, safeContractConfig: SafeContractConfig, transactions: SafeTransaction[], overrides: ManualOverrides): Promise<ManualTransactionResponse>;

package/dist/manual/index.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeManualTransactions = executeManualTransactions;
-const viem_1 = require("viem");
-const viem_2 = require("viem");
-const abis_1 = require("../abis");
-const builder_1 = require("../builder");
-const response_1 = require("../response");
-const safeExecTransaction = (0, viem_2.prepareEncodeFunctionData)({
-    abi: abis_1.safeAbi,
-    functionName: 'execTransaction',
-});
-async function executeManualTransactions(signer, safeContractConfig, transactions, overrides) {
-    const from = await signer.getAddress();
-    const aggTxn = (0, builder_1.aggregateTransaction)(transactions, safeContractConfig.SafeMultisend);
-    const sig = (0, viem_1.encodePacked)(["uint256", "uint256", "uint8"], [BigInt((0, viem_1.hexToBigInt)(from)), BigInt(0), 1]);
-    const safeAddress = (0, builder_1.deriveSafe)(from, safeContractConfig.SafeFactory);
-    // calldata
-    const data = (0, viem_2.encodeFunctionData)({ ...safeExecTransaction, args: [
-            aggTxn.to,
-            aggTxn.value,
-            aggTxn.data,
-            aggTxn.operation,
-            0,
-            0,
-            0,
-            viem_1.zeroAddress,
-            viem_1.zeroAddress,
-            sig,
-        ] });
-    if (overrides.gasLimit == undefined) {
-        const gasLimit = await signer.estimateGas({
-            to: safeAddress,
-            data: data,
-            from: from,
-        });
-        console.log(`Estimated gas Limit: ${gasLimit}`);
-        overrides.gasLimit = gasLimit;
-    }
-    const txHash = await signer.sendTransaction({
-        data: data,
-        to: safeAddress,
-        gasPrice: overrides.gasPrice,
-        gasLimit: overrides.gasLimit,
-    });
-    const waitFunc = (txHash) => {
-        return signer.waitTillMined(txHash);
-    };
-    return new response_1.ManualTransactionResponse(txHash, waitFunc);
-}

package/dist/response/index.d.ts

@@ -1,21 +0,0 @@
-import { RelayClient } from "../client";
-import { IManualTransactionResponse, RelayerTransaction, RelayerTransactionResponse } from "../types";
-export declare class ClientRelayerTransactionResponse implements RelayerTransactionResponse {
-    readonly client: RelayClient;
-    readonly transactionID: string;
-    readonly transactionHash: string;
-    readonly hash: string;
-    readonly state: string;
-    constructor(transactionID: string, state: string, transactionHash: string, client: RelayClient);
-    getTransaction(): Promise<RelayerTransaction[]>;
-    wait(): Promise<RelayerTransaction | undefined>;
-}
-type WaitUntilMinedFunction = (transactionHash: string) => Promise<any>;
-export declare class ManualTransactionResponse implements IManualTransactionResponse {
-    readonly hash: string;
-    readonly transactionHash: string;
-    private waitTillMined;
-    constructor(transactionHash: string, waitTillMinedFunc: WaitUntilMinedFunction);
-    wait(): Promise<any>;
-}
-export {};

package/dist/response/index.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ManualTransactionResponse = exports.ClientRelayerTransactionResponse = void 0;
-const types_1 = require("../types");
-class ClientRelayerTransactionResponse {
-    client;
-    transactionID;
-    transactionHash;
-    hash;
-    state;
-    constructor(transactionID, state, transactionHash, client) {
-        this.transactionID = transactionID;
-        this.state = state;
-        this.transactionHash = transactionHash;
-        this.hash = transactionHash;
-        this.client = client;
-    }
-    async getTransaction() {
-        return this.client.getTransaction(this.transactionID);
-    }
-    async wait() {
-        return this.client.pollUntilState(this.transactionID, [
-            types_1.RelayerTransactionState.STATE_MINED,
-            types_1.RelayerTransactionState.STATE_CONFIRMED,
-        ], types_1.RelayerTransactionState.STATE_FAILED, 30);
-    }
-}
-exports.ClientRelayerTransactionResponse = ClientRelayerTransactionResponse;
-class ManualTransactionResponse {
-    hash;
-    transactionHash;
-    waitTillMined;
-    constructor(transactionHash, waitTillMinedFunc) {
-        this.transactionHash = transactionHash;
-        this.hash = transactionHash;
-        this.waitTillMined = waitTillMinedFunc;
-    }
-    async wait() {
-        return this.waitTillMined(this.hash);
-    }
-}
-exports.ManualTransactionResponse = ManualTransactionResponse;