https://github.com/terra-money/warp-sdk
https://github.com/terra-money/warp-sdk
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/terra-money/warp-sdk
- Owner: terra-money
- License: mit
- Created: 2022-11-24T16:42:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T11:18:42.000Z (over 1 year ago)
- Last Synced: 2025-05-03T23:32:19.582Z (6 months ago)
- Language: TypeScript
- Size: 471 KB
- Stars: 8
- Watchers: 12
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# warp-sdk
The Warp SDK provides a Typescript API for interacting with Warp Protocol, the decentralized automation tool for the Cosmos ecosystem. Warp allows developers to create novel features or experiences for their users through cost-efficient, on-chain automation—no smart contract changes necessary.
The SDK provides a simple way to interact with Warp Protocol's contracts to automatically execute transactions in the future based on any available on-chain data. The trigger for execution is referred to as a condition, and the corresponding job encompasses the executable message. Warp jobs are submitted to a job queue, where participants called keepers monitor the conditions and—once met—execute the pre-signed job message.
Read on below, check out the [docs](https://docs.warp.money/) for more information, or [get in touch](https://docs.google.com/forms/d/e/1FAIpQLSeYGdWL9tIHC3BP2riYXtT_cyZVDMGKrrSH0JCPCdV3PtZGyg/viewform) with the team to start building with Warp.
## Installation
```bash
npm install -S @terra-money/warp-sdk
```
## Usage
Warp sdk provides a fluent API for building more complex payloads such as creating job and templates.
Here is an example of an harvest rewards job used by eris-protocol built using composers.
```typescript
import { LCDClient, LCDClientConfig, MnemonicKey, Wallet } from '@terra-money/feather.js';
import { uint, cond, fn, msg, variable, job, ts, WarpSdk } from '@terra-money/warp-sdk';
const piscoLcdClientConfig: LCDClientConfig = {
lcd: 'https://pisco-lcd.terra.dev',
chainID: 'pisco-1',
gasAdjustment: 1.75,
gasPrices: { uluna: 0.015 },
prefix: 'terra',
};
const lcd = new LCDClient({
'pisco-1': piscoLcdClientConfig,
});
const wallet = new Wallet(lcd, new MnemonicKey({ mnemonic: '...' }));
const sdk = new WarpSdk(wallet, piscoLcdClientConfig);
const sender = wallet.key.accAddress(piscoLcdClientConfig.prefix);
const nextExecution = variable
.static()
.kind('uint')
.name('next_execution')
.value(ts.date(new Date('2023-04-10T12:30:00.000Z')))
.onSuccess(fn.uint(uint.expr(uint.simple(ts.days(1)), 'add', uint.env('time'))))
.onError(fn.uint(uint.expr(uint.simple(ts.hours(1)), 'add', uint.env('time'))))
.compose();
const condition = cond.uint(uint.env('time'), 'gt', uint.ref(nextExecution));
const executions = [
{
condition,
msgs: [msg.execute('terra10788fkzah89xrdm27zkj5yvhj9x3494lxawzm5qq3vvxcqz2yzaqyd3enk', { harvest: {} })],
},
];
const recurring = true;
const durationDays = '30';
const vars = [nextExecution];
const estimateJobRewardMsg = job
.estimate()
.recurring(recurring)
.durationDays(durationDays)
.vars(vars)
.executions(executions)
.compose();
const reward = await sdk.estimateJobReward(sender, estimateJobRewardMsg);
const operationalAmount = await sdk.estimateJobFee(sender, estimateJobRewardMsg, reward.amount.toString());
const createJobMsg = job
.create()
.name('eris-harvest')
.description('This job harvests rewards for eris protoocl vaults each day.')
.labels([])
.recurring(recurring)
.reward(reward.amount.toString())
.operationalAmount(operationalAmount.amount.toString())
.vars(vars)
.durationDays(durationDays)
.executions(executions)
.compose();
sdk.createJob(sender, createJobMsg, [operationalAmount]).then((response) => {
console.log(response);
});
```
## Methods
isJobActive(jobId: string): Promise: Check if a job is active by its ID.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const jobId = 'jobId';
const isActive = await warpSdk.isJobActive(jobId);
console.log(isActive);
```
jobs(opts: QueryJobsMsg = {}): Promise: List jobs with optional filters.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const allJobs = await warpSdk.jobs();
console.log(allJobs);
```
job(id: string): Promise: Get a job by its ID.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const jobId = 'jobId';
const jobDetails = await warpSdk.job(jobId);
console.log(jobDetails);
```
templates(opts: QueryTemplatesMsg = {}): Promise: List templates with optional filters.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const allTemplates = await warpSdk.templates();
console.log(allTemplates);
```
template(id: string): Promise: Get a template by its ID.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const templateId = 'templateId';
const templateDetails = await warpSdk.template(templateId);
console.log(templateDetails);
```
simulateQuery(query: QueryRequestFor_String): Promise: Simulate a query.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const query = { ... };
const queryResult = await warpSdk.simulateQuery(query);
console.log(queryResult);
```
account(owner: string): Promise: Get an account by its owner.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const accountId = 'accountId';
const accountDetails = await warpSdk.account(accountId);
console.log(accountDetails);
```
accounts(opts: QueryAccountsMsg): Promise: List accounts with optional filters.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const allAccounts = await warpSdk.accounts();
console.log(allAccounts);
```
config(): Promise: Get the config of the Warp Protocol.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const configInfo = await warpSdk.config();
console.log(configInfo);
```
createJob(sender: string, msg: CreateJobMsg): Promise: Create a job.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const cosmosMsg = {
bank: {
send: {
amount: [{ denom: 'uluna', amount: '100000' }],
to_address: 'receiver address',
},
},
};
const msg = {
....,
msgs: [JSON.stringify(cosmosMsg)],
reward: '1000000',
condition: {
and: [{
expr: {
string: {
left: {
value: 'val1',
},
op: 'eq',
right: {
value: 'val1',
},
},
},
}],
},
};
const sender = 'sender address';
const job = await warpSdk.createJob(sender, msg);
console.log(job);
```
createJobSequence(sender: string, sequence: CreateJobMsg[]): Promise: Create a sequence of jobs.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const msg1 = {
...
msgs: [...],
reward: '1000000',
condition: {
and: [{
expr: {
string: {
left: {
value: 'val1',
},
op: 'eq',
right: {
value: 'val1',
},
},
},
}],
}],
};
const msg2 = {
...,
msgs: [...],
reward: '1000000',
condition: {
and: [{
expr: {
string: {
left: {
value: 'val',
},
op: 'eq',
right: {
value: 'val2',
},
},
},
}],
},
};
const sender = 'sender address';
const jobSequence = await warpSdk.createJobSequence(sender, [msg1, msg2]);
console.log(jobSequence);
```
deleteJob(sender: string, jobId: string): Promise: Delete a job.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const sender = 'sender address';
const jobId = 'abc123';
const response = await warpSdk.deleteJob(sender, jobId);
console.log(response);
```
updateJob(sender: string, msg: UpdateJobMsg): Promise: Update a job.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const sender = 'sender address';
const msg = { name: 'Updated Job Name', id: 'abc123' };
const response = await warpSdk.updateJob(sender, msg);
console.log(response);
```
executeJob(sender: string, jobId: string): Promise: Execute a job.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const sender = 'sender address';
const jobId = 'abc123';
const response = await warpSdk.executeJob(sender, jobId);
console.log(response);
```
evictJob(sender: string, jobId: string): Promise: Evict a job.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const sender = 'sender address';
const jobId = 'abc123';
const response = await warpSdk.evictJob(sender, jobId);
console.log(response);
```
submitTemplate(sender: string, msg: SubmitTemplateMsg): Promise: Submit a template.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const sender = 'sender address';
const msg = { name: 'Template 1', formatted_str: 'this is a template', vars: []};
const response = await sdk.submitTemplate(sender, msg);
console.log(response);
```
deleteTemplate(sender: string, templateId: string): Promise: Delete a template.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const sender = 'sender address';
const templateId = 'template_id';
const response = await sdk.deleteTemplate(sender, templateId);
console.log(response);
```
editTemplate(sender: string, msg: EditTemplateMsg): Promise: Edit a template.
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const sender = 'sender address';
const msg = { name: 'Updated Template', id: 'template_id' };
const response = await warpSdk.editTemplate(sender, msg);
console.log(response);
```
createAccount(sender: string): Promise
```typescript
const warpSdk = new WarpSdk(wallet, contractAddress);
const sender = 'sender address';
const account = await warpSdk.createAccount(sender);
console.log(account);
```