townespace-ts-sdk
v0.1.1
Published
TowneSpace TypeScript SDK
Downloads
6
Readme
SDK for TowneSpace
Description: The TowneSpace TypeScript SDK allows developers to interact with townespace smart contract including minting and composibility.
Installation
For use in Node.js or a web application
npm install townespace
You can also use yarn or pnpm.
For use in a browser
<script src="https://unpkg.com/townesquare@latest/dist/index.global.js" />
the SDK can then be accessed through window.townesquareSDK
.
Documentation and examples
- The Townesquare documentation site provides step-by-step instructions, code snippets, and best practices to use this library.
- For in-depth examples, check out the examples folder with ready-made
package.json
files to get you going quickly!
Testing
To run the full SDK tests, From the root of this package, run:
npm test
If you see strange behavior regarding HTTP clients, try running the tests with
--detectOpenHandles
.
To test a single file in the SDK, From the root of this package, run:
npx jest -- <path/to/file.test.ts>
To use the local build in a local project:
// run from the root of this package
npm build
// run on your local project
npm add PATH_TO_LOCAL_SDK_PACKAGE
Contributing
If you found a bug or would like to request a feature, please file an issue. If, based on the discussion on an issue you would like to offer a code change, please make a pull request. If neither of these describes what you would like to contribute, checkout out the contributing guide.
TODO: add links