Skip to content

Commit a9bae21

Browse files
committed
readme updates terra-money#2
1 parent 8b811bc commit a9bae21

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ console.log(`Job is ${isActive ? "active" : "inactive"}.`)
2525
```
2626
## Methods
2727

28-
**isJobActive(jobId: string): Promise<boolean>:** Check if a job is active by its ID.
28+
isJobActive(jobId: string): Promise<boolean>: Check if a job is active by its ID.
2929

3030
```typescript
3131
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -34,15 +34,15 @@ const isActive = await warpSdk.isJobActive(jobId);
3434
console.log(isActive);
3535
```
3636

37-
**jobs(opts: QueryJobsMsg = {}): Promise<Job[]>:** List jobs with optional filters.
37+
jobs(opts: QueryJobsMsg = {}): Promise<Job[]>: List jobs with optional filters.
3838

3939
```typescript
4040
const warpSdk = new WarpSdk(wallet, contractAddress);
4141
const allJobs = await warpSdk.jobs();
4242
console.log(allJobs);
4343
```
4444

45-
**job(id: string): Promise<Job>:** Get a job by its ID.
45+
job(id: string): Promise<Job>: Get a job by its ID.
4646

4747
```typescript
4848
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -51,15 +51,15 @@ const jobDetails = await warpSdk.job(jobId);
5151
console.log(jobDetails);
5252
```
5353

54-
**templates(opts: QueryTemplatesMsg = {}): Promise<Template[]>:** List templates with optional filters.
54+
templates(opts: QueryTemplatesMsg = {}): Promise<Template[]>: List templates with optional filters.
5555

5656
```typescript
5757
const warpSdk = new WarpSdk(wallet, contractAddress);
5858
const allTemplates = await warpSdk.templates();
5959
console.log(allTemplates);
6060
```
6161

62-
**template(id: string): Promise<Template>:** Get a template by its ID.
62+
template(id: string): Promise<Template>: Get a template by its ID.
6363

6464
```typescript
6565
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -68,7 +68,7 @@ const templateDetails = await warpSdk.template(templateId);
6868
console.log(templateDetails);
6969
```
7070

71-
**simulateQuery(query: QueryRequestFor_String): Promise<object>:** Simulate a query.
71+
simulateQuery(query: QueryRequestFor_String): Promise<object>: Simulate a query.
7272

7373
```typescript
7474
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -77,7 +77,7 @@ const queryResult = await warpSdk.simulateQuery(query);
7777
console.log(queryResult);
7878
```
7979

80-
**account(owner: string): Promise<Account>:** Get an account by its owner.
80+
account(owner: string): Promise<Account>: Get an account by its owner.
8181

8282
```typescript
8383
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -86,23 +86,23 @@ const accountDetails = await warpSdk.account(accountId);
8686
console.log(accountDetails);
8787
```
8888

89-
**accounts(opts: QueryAccountsMsg): Promise<Account[]>:** List accounts with optional filters.
89+
accounts(opts: QueryAccountsMsg): Promise<Account[]>: List accounts with optional filters.
9090

9191
```typescript
9292
const warpSdk = new WarpSdk(wallet, contractAddress);
9393
const allAccounts = await warpSdk.accounts();
9494
console.log(allAccounts);
9595
```
9696

97-
**config(): Promise<Config>:** Get the config of the Warp Protocol.
97+
config(): Promise<Config>: Get the config of the Warp Protocol.
9898

9999
```typescript
100100
const warpSdk = new WarpSdk(wallet, contractAddress);
101101
const configInfo = await warpSdk.config();
102102
console.log(configInfo);
103103
```
104104

105-
**createJob(sender: string, msg: CreateJobMsg): Promise<TxInfo>:** Create a job.
105+
createJob(sender: string, msg: CreateJobMsg): Promise<TxInfo>: Create a job.
106106

107107
```typescript
108108
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -133,7 +133,7 @@ const job = await warpSdk.createJob(sender, msg);
133133
console.log(job);
134134
```
135135

136-
**createJobSequence(sender: string, sequence: CreateJobMsg[]): Promise<TxInfo>:** Create a sequence of jobs.
136+
createJobSequence(sender: string, sequence: CreateJobMsg[]): Promise<TxInfo>: Create a sequence of jobs.
137137

138138
```typescript
139139
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -185,7 +185,7 @@ const jobSequence = await warpSdk.createJobSequence(sender, [msg1, msg2]);
185185
console.log(jobSequence);
186186
```
187187

188-
**deleteJob(sender: string, jobId: string): Promise<TxInfo>:** Delete a job.
188+
deleteJob(sender: string, jobId: string): Promise<TxInfo>: Delete a job.
189189

190190
```typescript
191191
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -196,7 +196,7 @@ const response = await warpSdk.deleteJob(sender, jobId);
196196
console.log(response);
197197
```
198198

199-
**updateJob(sender: string, msg: UpdateJobMsg): Promise<TxInfo>:** Update a job.
199+
updateJob(sender: string, msg: UpdateJobMsg): Promise<TxInfo>: Update a job.
200200

201201
```typescript
202202
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -207,7 +207,7 @@ const response = await warpSdk.updateJob(sender, msg);
207207
console.log(response);
208208
```
209209

210-
**executeJob(sender: string, jobId: string): Promise<TxInfo>:** Execute a job.
210+
executeJob(sender: string, jobId: string): Promise<TxInfo>: Execute a job.
211211

212212
```typescript
213213
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -218,7 +218,7 @@ const response = await warpSdk.executeJob(sender, jobId);
218218
console.log(response);
219219
```
220220

221-
**submitTemplate(sender: string, msg: SubmitTemplateMsg): Promise<TxInfo>:** Submit a template.
221+
submitTemplate(sender: string, msg: SubmitTemplateMsg): Promise<TxInfo>: Submit a template.
222222

223223
```typescript
224224
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -229,7 +229,7 @@ const response = await sdk.submitTemplate(sender, msg);
229229
console.log(response);
230230
```
231231

232-
**deleteTemplate(sender: string, templateId: string): Promise<TxInfo>:** Delete a template.
232+
deleteTemplate(sender: string, templateId: string): Promise<TxInfo>: Delete a template.
233233

234234
```typescript
235235
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -240,7 +240,7 @@ const response = await sdk.deleteTemplate(sender, templateId);
240240
console.log(response);
241241
```
242242

243-
**editTemplate(sender: string, msg: EditTemplateMsg): Promise<TxInfo>:** Edit a template.
243+
editTemplate(sender: string, msg: EditTemplateMsg): Promise<TxInfo>: Edit a template.
244244

245245
```typescript
246246
const warpSdk = new WarpSdk(wallet, contractAddress);
@@ -251,7 +251,7 @@ const response = await warpSdk.editTemplate(sender, msg);
251251
console.log(response);
252252
```
253253

254-
**createAccount(sender: string): Promise<TxInfo>**
254+
createAccount(sender: string): Promise<TxInfo>
255255

256256
```typescript
257257
const warpSdk = new WarpSdk(wallet, contractAddress);

0 commit comments

Comments
 (0)