Package Exports

ulysses-actions-sdk
ulysses-actions-sdk/dist/ulysses-actions-sdk.cjs.js
ulysses-actions-sdk/dist/ulysses-actions-sdk.esm.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ulysses-actions-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Ulysses Actions SDK

⚒️ Ulysses Actions SDK is a powerful tool that allows you to easily use with Ulysses Protocol for cross-chain contract interactions as well as asset transfers.

Features

Actions
Context Handler
Action Builder

Installation

To install Ulysses Actions SDK, follow on of these steps:

npm install ulysses-actions-sdk

yarn add ulysses-actions-sdk

Usage

Here's a basic example of how to use Ulysses Actions SDK to interact with Hermes remotely:

import { ActionBuilder, BurnHermesAction, ContextHandler, IActionResult, IContextParameters } from 'ulysses-actions-sdk'

// Populate Context Parameters according to details such as origin chain, gas details, etc...
const contextParams: IContextParameters = {
  chainId: originChainId
  useVirtualAccount: true
  userAccount?: '0xCOFFE'
}

// Create Context
const context: ContextHandler = new ContextHandler(context)

// Create Action Builder
const builder: ActionBuilder = new ActionBuilder(context)

// Add action
builder.addAction(new BurnHermesAction({ amount: 100, recipinet: '0xBABE' }))

// Build calldata
const result: IActionResult = builder.build()

Pre-commit hook

We use Husky to run pre-commit hooks. The configuration file is located in lint-staged.js. If you wish to run a commit without running these commit hooks, simply add --no-verify at the end of your commit command.

Contributing

We welcome contributions! Please see our Contributing Guidelines for more details.

License

Ulysses Actions SDK is MIT licensed.

Contact

If you have any questions or issues, please contact us.