# @ditto-research/staking-sdk > Ditto SDK Latest version **0.6.0** (published 2023-10-18) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @ditto-research/staking-sdk pnpm add @ditto-research/staking-sdk yarn add @ditto-research/staking-sdk bun add @ditto-research/staking-sdk ``` ## Health **Score 20/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.6.0 | | Published | 2023-10-18 | | First published | 2022-08-26 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 7 | | Unpacked size | 93.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | rode0_cl0wn, dittosis | ## Links - npm: https://www.npmjs.com/package/@ditto-research/staking-sdk - npm.io page: https://npm.io/package/@ditto-research/staking-sdk ## Dependencies (7) - [fmt](https://npm.io/package/fmt.md) ^2.0.0 - [aptos](https://npm.io/package/aptos.md) 1.19.0 - [tslib](https://npm.io/package/tslib.md) ^2.4.0 - [js-sha3](https://npm.io/package/js-sha3.md) ^0.8.0 - [tweetnacl](https://npm.io/package/tweetnacl.md) ^1.0.3 - [@types/node](https://npm.io/package/@types/node.md) ^17.0.21 - [cross-fetch](https://npm.io/package/cross-fetch.md) ^3.1.5 ## Recent versions - 0.6.0 (latest) — 2023-10-18 - 0.5.0 — 2022-10-21 - 0.4.45 — 2022-10-19 - 0.4.2 — 2022-10-17 - 0.4.1 — 2022-10-17 - 0.4.0 — 2022-10-17 - 0.3.1 — 2022-10-05 - 0.3.0 — 2022-09-30 - 0.2.2 — 2022-09-23 - 0.2.1 — 2022-09-15 - 0.2.0 — 2022-09-12 - 0.1.6 — 2022-09-08 - 0.1.5 — 2022-09-07 - 0.1.3 — 2022-08-27 - 0.1.2 — 2022-08-27 - … 3 more at https://npm.io/package/@ditto-research/staking-sdk/versions ## README # SDK # Smart contract address | Network | Value | | ------- | :------------------------------------------------------------------: | | Devnet | `0x6567b43f1448e03430c4cac31a337d8d96d136a23063a6d2bf5db52b35109338` | | Testnet | `0x6567b43f1448e03430c4cac31a337d8d96d136a23063a6d2bf5db52b35109338` | # How to use it ## Basic functionality ### Loading ditto state ```ts import * as aptos from "aptos"; import { Ditto, Client, types, utils, wallet, payload, } from "@ditto-research/staking-sdk"; // Load the Ditto object singleton, needed to do all operations with the SDK await Ditto.load( new wallet.DummyWallet(), // Wallet object types.Network.DEVNET, "https://fullnode.devnet.aptoslabs.com/v1", // REST url endpoint new aptos.HexString(SMART_CONTRACT_ADDRESS), 5000 // Txn confirmation timeout - unused for now ); ``` ### Create a local node wallet ```ts // Parameters for your aptos transactions. const DEFAULT_TXN_CONFIG: types.AptosTxnConfig = { maxGasAmount: 1000n, gasUnitPrice: 1n, txnExpirationOffset: 10n, }; let wallet: wallet.DittoWallet = new wallet.DittoWallet( new aptos.HexString(USER_PRIVATE_KEY), DEFAULT_TXN_CONFIG ); ``` ### Using a wallet adapter The SDK's Client constructor just expects a wallet that implements this interface. ```ts // All objects that implement this interface (including wallet adapter). export interface Wallet { account: AccountKeys; signAndSubmitTransaction(transaction: any): Promise; signTransaction(transaction: any): Promise; } ``` ### Creating a ditto client ```ts // Any wallet object implementing the interface can be passed in. let client = new Client(wallet, types.Network.DEVNET, 5000); // Example of how to stake aptos: let txResponse = await client.stakeAptos(STAKE_AMOUNT); // These functions will return an object of type - // interface TxnResponse { // hash: string; // The txn hash // msg: string; // Whether the transaction was successful // } console.log(`Stake aptos txn reponse =`, txResponse); // How to instant unstake stAPT (subject to instant unstake fee). await client.instantUnstake(); // *** Note delayed unstake and claim functionality is not available on devnet ***. // How to delayed unstake stAPT. await client.delayedUnstake(); // View user delayed unstake state. let userClaimState = await Ditto.getUserClaimStateFromTable(client.address); // How to claim processed delayed unstake tickets. await client.claimAptos(); // For the rest of the client functionality you can look at `client.ts` ``` ### Getting payloads ```ts // Example of creating an add validator payload let addValidatorPayload = payload.addValidatorPayload(); // Example of creating a stake aptos payload let stakeAptosPayload = payload.stakeAptosPayload(STAKE_AMOUNT); // For the rest of the payload generation functionality you can look at payload.ts ``` Useful utility functions ```ts // Get staked aptos index. let index = await Ditto.staptosIndex(); // Get aptos balance for an account let aptosBalance = await getAccountAptosBalance(ACCOUNT_ADDR); // Get staked aptos balance for an account let stAptosBalance = await getAccountStaptosBalance(ACCOUNT_ADDR); // Get staked aptos coin info: returns CoinInfo // interface CoinInfo { // decimals: number; // name: string; // supply: bigint; // symbol: string; // } let stAptosCoinInfo = await getStAptosInfo(); // For the rest of the utility functionality you can look at utils.ts ``` ### Extra state fetching ```ts // This will refresh the smart contract's resources with up-to-date on chain data. // This is called on load as well. await Ditto.refreshDittoResources(); // You can check Ditto's smart contract resources via the Ditto object console.log(Ditto.dittoConfig); console.log(Ditto.dittoPool); console.log(Ditto.validatorWhitelist); // You can query on chain state from Ditto as well- some examples // This will get validator state for a certain validator let validatorState = await Ditto.getValidatorStateFromTable(VALIDATOR_KEY); // This will get how much aptos users can claim from their delayed unstake requests let userClaimState = await Ditto.getUserClaimStateFromTable(USER_KEY); // For the rest of Ditto functionality you can look at client.ts // This includes more available entry-points and on chain state queries ``` ### Permissionless cranking There are several permissionless entry-points that can be called via the Ditto singleton. ```ts // Distribute pending stake to validators. await Ditto.distributeUnstakedCoins(); // Update Ditto's smart contract state on new epochs. await Ditto.updateDittoState(); // Reactive inactive validator. await Ditto.joinValidatorSet(validatorPoolAddress); ``` --- _Source: https://npm.io/package/@ditto-research/staking-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._