@abstraxn/relayer 0.1.15 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/Readme.md +38 -0
  2. package/package.json +1 -1
package/Readme.md CHANGED
@@ -71,6 +71,44 @@ relayer.buildRelayerTx(buildTxParams).then(async (txData) => {
71
71
  });
72
72
  ```
73
73
 
74
+ ## Server wallet signing (`@abstraxn/server-signer`)
75
+
76
+ For backend agents using an **Abstraxn Server Wallet**, use `createRelayerSigner` from
77
+ `@abstraxn/server-signer` instead of a local private-key/ethers wallet:
78
+
79
+ ```bash
80
+ npm install @abstraxn/server-signer
81
+ ```
82
+
83
+ ```typescript
84
+ import { Relayer } from "@abstraxn/relayer";
85
+ import { ServerSignerClient } from "@abstraxn/server-signer";
86
+ import { JsonRpcProvider, type Signer } from "ethers";
87
+
88
+ const client = new ServerSignerClient({ apiKey: process.env.ABSTRAXN_API_KEY! });
89
+ await client.authenticate({
90
+ userIdentity: "backend-agent",
91
+ accessKey: process.env.SERVER_WALLET_ACCESS_KEY!,
92
+ });
93
+
94
+ const rpcUrl = process.env.RPC_URL!;
95
+ const { signer } = client.createRelayerSigner({
96
+ rpcUrl,
97
+ chainId: 137,
98
+ organizationId: process.env.TURNKEY_ORG_ID!,
99
+ fromAddress: "0xYourServerWallet",
100
+ });
101
+
102
+ const relayer = new Relayer({
103
+ relayerUrl: process.env.RELAYER_URL!,
104
+ chainId: 137,
105
+ provider: new JsonRpcProvider(rpcUrl),
106
+ signer: signer as unknown as Signer,
107
+ });
108
+ ```
109
+
110
+ See `@abstraxn/server-signer` README for the full gasless flow.
111
+
74
112
  ## API
75
113
 
76
114
  ### Core Methods
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@abstraxn/relayer",
3
- "version": "0.1.15",
3
+ "version": "1.0.0",
4
4
  "description": "Abstraxn Relayer package for handling gas-less transactions, facilitating smart contract interactions, and relaying user transactions efficiently.",
5
5
  "type": "module",
6
6
  "main": "./dist/src/index.js",