@polymarket/relayer-client 0.0.13 → 1.0.1

package/dist/client.d.ts

@@ -1,7 +1,7 @@
 import { Wallet } from "@ethersproject/wallet";
 import { JsonRpcSigner } from "@ethersproject/providers";
 import { HttpClient } from "./http-helpers";
-import { AddressPayload, AuthArgs, NoncePayload, ProxyTransaction, RelayPayload, SafeTransaction } from "./types";
+import { AddressPayload, AuthArgs, NoncePayload, ProxyTransaction, RelayerTransaction, RelayerTransactionResponse, RelayPayload, SafeTransaction } from "./types";
 import { AuthHandler } from "./auth";
 export declare class RelayClient {
     readonly relayerUrl: string;
@@ -13,11 +13,12 @@ export declare class RelayClient {
     getRelayAddress(): Promise<AddressPayload>;
     getNonce(signerAddress: string, signerType: string): Promise<NoncePayload>;
     getRelayPayload(signerAddress: string, signerType: string): Promise<RelayPayload>;
-    getTransaction(transactionId: string): Promise<RelayPayload>;
-    getTransactions(): Promise<RelayPayload>;
-    executeProxyTransactions(txns: ProxyTransaction[]): Promise<any>;
-    executeSafeTransactions(txns: SafeTransaction[]): Promise<any>;
-    deploySafe(): Promise<any>;
-    private post;
+    getTransaction(transactionId: string): Promise<RelayerTransaction[]>;
+    getTransactions(): Promise<RelayerTransaction[]>;
+    executeProxyTransactions(txns: ProxyTransaction[]): Promise<RelayerTransactionResponse>;
+    executeSafeTransactions(txns: SafeTransaction[]): Promise<RelayerTransactionResponse>;
+    deploySafe(): Promise<RelayerTransactionResponse>;
+    pollUntilState(transactionId: string, states: string[], maxPolls?: number): Promise<RelayerTransaction | undefined>;
+    private submitTransaction;
     private send;
 }

package/dist/client.js

@@ -11,6 +11,7 @@ const builder_1 = require("./builder");
 const encode_1 = require("./encode");
 const builder_2 = require("./builder");
 const auth_1 = require("./auth");
+const utils_1 = require("./utils");
 class RelayClient {
     constructor(relayerUrl, chainId, signer, authArgs) {
         this.relayerUrl = relayerUrl.endsWith("/") ? relayerUrl.slice(0, -1) : relayerUrl;
@@ -68,7 +69,7 @@ class RelayClient {
             };
             const request = yield builder_1.buildProxyTransactionRequest(this.signer, args);
             console.log(`Client side request creation took: ${(Date.now() - start) / 1000} seconds`);
-            return this.post(request);
+            return this.submitTransaction(request);
         });
     }
     executeSafeTransactions(txns) {
@@ -88,7 +89,7 @@ class RelayClient {
             };
             const request = yield builder_1.buildSafeTransactionRequest(this.signer, args);
             console.log(`Client side request creation took: ${(Date.now() - start) / 1000} seconds`);
-            return this.post(request);
+            return this.submitTransaction(request);
         });
     }
     deploySafe() {
@@ -108,10 +109,32 @@ class RelayClient {
             };
             const request = yield builder_2.buildSafeCreateTransactionRequest(this.signer, args);
             console.log(`Client side request creation took: ${(Date.now() - start) / 1000} seconds`);
-            return this.post(request);
+            return this.submitTransaction(request);
         });
     }
-    post(req) {
+    // Periodically polls the transaction id until it reaches a desired state
+    // Returns the relayer transaction if it does each the desired state
+    // Times out after 10s
+    pollUntilState(transactionId, states, maxPolls) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            console.log(`Waiting for transaction ${transactionId} matching states: ${states}...`);
+            const maxPollCount = maxPolls != undefined ? maxPolls : 10;
+            let pollCount = 0;
+            while (pollCount < maxPollCount) {
+                const txns = yield this.getTransaction(transactionId);
+                if (txns.length > 0) {
+                    const txn = txns[0];
+                    if (states.includes(txn.state)) {
+                        return txn;
+                    }
+                }
+                pollCount++;
+                yield utils_1.sleep(1000);
+            }
+            console.log(`Transaction not found or not in given states, timing out`);
+        });
+    }
+    submitTransaction(req) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             return this.send(`${this.relayerUrl}${endpoints_1.SUBMIT_TRANSACTION}`, http_helpers_1.POST, undefined, req);
         });

package/dist/types.d.ts

@@ -80,6 +80,17 @@ export interface SafeCreateTransactionArgs {
     payment: string;
     paymentReceiver: string;
 }
+export declare enum RelayerTransactionState {
+    STATE_NEW = "STATE_NEW",
+    STATE_EXECUTED = "STATE_EXECUTED",
+    STATE_INVALID = "STATE_INVALID",
+    STATE_CONFIRMED = "STATE_CONFIRMED",
+    STATE_FAILED = "STATE_FAILED"
+}
+export interface RelayerTransactionResponse {
+    transactionID: string;
+    state: string;
+}
 export interface RelayerSubRequest {
     address: string;
     transactions: string[];
@@ -89,3 +100,18 @@ export interface AuthArgs {
     authUrl: string;
     authToken: string;
 }
+export interface RelayerTransaction {
+    transactionID: string;
+    transactionHash: string;
+    from: string;
+    to: string;
+    proxyAddress: string;
+    data: string;
+    nonce: string;
+    value: string;
+    state: string;
+    type: string;
+    metadata: string;
+    createdAt: Date;
+    updatedAt: Date;
+}

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OperationType = exports.CallType = exports.TransactionType = void 0;
+exports.RelayerTransactionState = exports.OperationType = exports.CallType = exports.TransactionType = void 0;
 var TransactionType;
 (function (TransactionType) {
     TransactionType["PROXY"] = "PROXY";
@@ -19,3 +19,11 @@ var OperationType;
     OperationType[OperationType["Call"] = 0] = "Call";
     OperationType[OperationType["DelegateCall"] = 1] = "DelegateCall";
 })(OperationType = exports.OperationType || (exports.OperationType = {}));
+var RelayerTransactionState;
+(function (RelayerTransactionState) {
+    RelayerTransactionState["STATE_NEW"] = "STATE_NEW";
+    RelayerTransactionState["STATE_EXECUTED"] = "STATE_EXECUTED";
+    RelayerTransactionState["STATE_INVALID"] = "STATE_INVALID";
+    RelayerTransactionState["STATE_CONFIRMED"] = "STATE_CONFIRMED";
+    RelayerTransactionState["STATE_FAILED"] = "STATE_FAILED";
+})(RelayerTransactionState = exports.RelayerTransactionState || (exports.RelayerTransactionState = {}));

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export declare function sleep(ms: number): Promise<unknown>;

package/dist/utils/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = void 0;
+function sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+exports.sleep = sleep;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@polymarket/relayer-client",
     "description": "Client for Polymarket relayers",
-    "version": "0.0.13",
+    "version": "1.0.1",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "files": [