Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stove-labs/wrapped-xtz-sdk

This SDK enables you to interact with Tezos smart contracts of the Wrapped-XTZ project by StakerDAO.
https://github.com/stove-labs/wrapped-xtz-sdk

blockchain javascript sdk tezos typescript

Last synced: about 2 months ago
JSON representation

This SDK enables you to interact with Tezos smart contracts of the Wrapped-XTZ project by StakerDAO.

Host: GitHub
URL: https://github.com/stove-labs/wrapped-xtz-sdk
Owner: stove-labs
License: mit
Created: 2020-12-25T20:31:54.000Z (about 4 years ago)
Default Branch: dev
Last Pushed: 2021-02-23T16:32:53.000Z (almost 4 years ago)
Last Synced: 2024-11-01T13:12:07.438Z (2 months ago)
Topics: blockchain, javascript, sdk, tezos, typescript
Language: TypeScript
Homepage:
Size: 1.25 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        [![npm version](https://badge.fury.io/js/%40stove-labs%2Fwxtz-sdk.svg)](https://badge.fury.io/js/%40stove-labs%2Fwxtz-sdk)

![build](https://github.com/stove-labs/wrapped-xtz-sdk/workflows/build/badge.svg)

![Delphinet](https://github.com/stove-labs/wrapped-xtz-sdk/workflows/Delphinet/badge.svg)

[![codecov](https://codecov.io/gh/stove-labs/wrapped-xtz-sdk/branch/dev/graph/badge.svg?token=V62SO4RIFD)](https://codecov.io/gh/stove-labs/wrapped-xtz-sdk)

[![Made with TypeScript](https://img.shields.io/badge/made_with-TypeScript-blue.svg)](https://www.typescriptlang.org)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

# Wrapped-XTZ SDK

This SDK for TypeScript and JavaScript enables you to interact with Tezos smart contracts of the [Wrapped-XTZ](https://github.com/stakerdao/wrapped-xtz) project by StakerDAO.

# Quickstart 🪄

```sh

npm install @stove-labs/wxtz-sdk

```

## Usage 🕹

### Typescript

```ts

import { WXTZSDK, NetworkType } from '@stove-labs/wxtz-sdk';

import { InMemorySigner } from '@taquito/signer';

import { TezosToolkit } from '@taquito/taquito';

const Tezos = new TezosToolkit('https://testnet-tezos.giganode.io');

Tezos.setProvider({

  signer: new InMemorySigner(

    'edskSAVepaB1qJvJBrR9WK3X6JQneSGq2wf4jF4czWjMF3LyqtyELhGxqmx9gBADquKHr12uYpsDJA1H1RQJNBUUjkefytWs6e'

  ),

});

const wXTZConfig = {

  tezos: Tezos,

  network: NetworkType.delphinet,

  indexerUrl: 'https://you.better-call.dev',

};

(async function () {

  // initialize SDK

  const wXTZ = await WXTZSDK.at('KT1VMHXqjocCDZJ9cVwbtM1saLmXjyxwPb2h', wXTZConfig);

  // perform optional check

  const isValidContractCode = await wXTZ.checkContractCodeIntegrity();

  const createOvenContractMethod = await wXTZ.createOven('tz1QFeixME3pnRFwGFArJ5EFEc7uPjqxDNHY');

  const transactionOperation = await createOvenContractMethod.send();

  await transactionOperation.confirmation(1);

  // interact with oven

  const wXTZOven = await wXTZ.oven('KT1ovenAddress');

  await wXTZOven.initialize();

  // perform optional check

  const isValid = await wXTZOven.checkContractCodeIntegrity();

  // deposit

  const depositOperation = await (await wXTZOven.deposit()).send({

    amount: 100,

    mutez: true,

  });

  await depositOperation.confirmation(1);

  // withdraw

  const withdrawOperation = await (await wXTZOven.withdraw(100)).send();

  await withdrawOperation.confirmation(1);

  // set delegate

  const setDelegateOperation = await (await wXTZOven.setDelegate('tz1...')).send();

  await setDelegateOperation.confirmation(1);

  // remove delegate

  const removeDelegateOperation = await (await wXTZOven.setDelegate(null)).send();

  await removeDelegateOperation.confirmation(1);

  // get delegate

  const delegateAddress = await wXTZOven.getDelegate();

  // get core address

  const coreAddress = await wXTZOven.getCoreAddress();

  // get oven details for date/time of origination and last action, block height of origination

  const ovenDetails = await wXTZOven.getDetails();

})();

```

### JavaScript

Example



```js

const { WXTZSDK, NetworkType } = require('@stove-labs/wxtz-sdk');

const { InMemorySigner } = require('@taquito/signer');

const { TezosToolkit } = require('@taquito/taquito');

const Tezos = new TezosToolkit('https://testnet-tezos.giganode.io');

Tezos.setProvider({

  signer: new InMemorySigner(

    'edskSAVepaB1qJvJBrR9WK3X6JQneSGq2wf4jF4czWjMF3LyqtyELhGxqmx9gBADquKHr12uYpsDJA1H1RQJNBUUjkefytWs6e'

  ),

});

const wXTZConfig = {

  tezos: Tezos,

  network: NetworkType.delphinet,

  indexerUrl: 'https://you.better-call.dev',

};

(async function () {

  // initialize SDK

  const wXTZ = await WXTZSDK.at('KT1VMHXqjocCDZJ9cVwbtM1saLmXjyxwPb2h', wXTZConfig);

  // perform optional check

  const isValidContractCode = await wXTZ.checkContractCodeIntegrity();

  const createOvenContractMethod = await wXTZ.createOven('tz1QFeixME3pnRFwGFArJ5EFEc7uPjqxDNHY');

  const transactionOperation = await createOvenContractMethod.send();

  await transactionOperation.confirmation(1);

  // interact with oven

  const wXTZOven = await wXTZ.oven('KT1ovenAddress');

  await wXTZOven.initialize();

  // perform optional check

  const isValid = await wXTZOven.checkContractCodeIntegrity();

  // deposit

  const depositOperation = await (await wXTZOven.deposit()).send({

    amount: 100,

    mutez: true,

  });

  await depositOperation.confirmation(1);

  // withdraw

  const withdrawOperation = await (await wXTZOven.withdraw(100)).send();

  await withdrawOperation.confirmation(1);

  // set delegate

  const setDelegateOperation = await (await wXTZOven.setDelegate('tz1...')).send();

  await setDelegateOperation.confirmation(1);

  // remove delegate

  const removeDelegateOperation = await (await wXTZOven.setDelegate(null)).send();

  await removeDelegateOperation.confirmation(1);

  // get delegate

  const delegateAddress = await wXTZOven.getDelegate();

  // get core address

  const coreAddress = await wXTZOven.getCoreAddress();

  // get oven details for date/time of origination and last action, block height of origination

  const ovenDetails = await wXTZOven.getDetails();

})();

```



## API Reference 📚

Checkout the complete TypeDoc [API reference](https://stove-labs.github.io/wrapped-xtz-sdk).

## Tests 🧪

For running tests it is necessary to spin up a local Tezos sandbox node, migrating the test state and then executing the test runner. 

Make sure to have [Docker](https://www.docker.com) running, [node.js v12.x](https://nodejs.org) and [jq](https://stedolan.github.io/jq/) installed.

```sh

npm run sandbox:start

npm run test:migrate

npm run test

```

## License 📃

Wrapped-XTZ SDK is available under the MIT License.

## Powered by