0.0.1 • Published 2 years ago

@alex.gracia.dev/aspen v0.0.1

Weekly downloads
-
License
UNLICENSED
Repository
github
Last release
2 years ago

Aspen Publishing SDK

Aspen Publishing SDK is a developer-friendly interface where allow developers/creators/clients to interact with Aspen's Publishing contracts out-of-the-box.

How it works

Aspen Publishing SDK's has a folder where the JSON abis of the Solidity contracts are located. With these files using the library typechain we are able to create the necessary types to call them as needed.

Software Build

Step 1: Get sources from Github

   $ git clone https://github.com/monax/aspen-publishing-sdk.git
   $ cd aspen-publishing-sdk

Step 2: Install dependencies

First we install the general dependencies and create the workspaces to allow the interaction between pkgs.

   $ yarn install

Step 3: Generate Typescript contracts

Once is installed we should go to the pkg/sdk and create the types files in Typescript from the contracts that we set as an example. Doing this proces, will allow the developers/users to see the flow of generating them.

  $ cd sdk
  $ yarn generate
  $ yarn build
  $ yarn prettier
  $ yarn lint

Now it's all set to use it in any Typescript project. This contracts could work in any other languague, this has been put as an example.