kylefang/xverse-stacks-transaction-sponsor
1
0
Fork 0
mirror of https://github.com/alexgo-io/xverse-stacks-transaction-sponsor.git synced 2026-01-12 08:43:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
yknl
2022-12-05 20:14:29 +08:00
parent c2bb0fb5fb
commit 47123aaf46
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -4,7 +4,7 @@ This is a web service that functions as a open sponsor for Stacks transactions.
POST to the `/v1/sponsor` endpoint with the user signed transaction in the JSON body. The transaction must be created as a sponsored transaction. The service will sign the transaction as the sponsor and broadcast it.
The service will use multiple addresses from the same wallet at random to sponsor transactions. You can set the number of addresses to use in the `.env` file. Each addresses must be funded with STX. This allows the sponsor to handle more simultaneous pending transactions.
The service will use multiple addresses from the same wallet at random to sponsor transactions. This allows the sponsor to handle more simultaneous pending transactions. You can set the number of addresses to use in the `.env` file. Each address must be funded with STX.
`/v1/info` will return the list of addresses used by the service for sponsoring transactions
@@ -22,7 +22,9 @@ npm install
```
Create an `.env` file in the project root using the included `.env.example` file as a guide.
Configure the .env file with your wallet seed phrase.
Configure the `.env` file with your wallet seed phrase.
Fund all addresses that you will be using with STX.
## Running