https://github.com/resilientecosystem/typescript_sdk
Typescript SDK for ResilientDB
https://github.com/resilientecosystem/typescript_sdk
Last synced: 2 months ago
JSON representation
Typescript SDK for ResilientDB
- Host: GitHub
- URL: https://github.com/resilientecosystem/typescript_sdk
- Owner: ResilientEcosystem
- License: apache-2.0
- Created: 2023-11-06T07:34:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-07T00:57:39.000Z (over 2 years ago)
- Last Synced: 2026-01-02T00:55:33.516Z (6 months ago)
- Language: TypeScript
- Size: 398 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ResilientDB TypeScript SDK
Use our ResilientDB TypeScript SDK to transact on ResilientDB, which leverages BigChainDB and mirrors the fucntionality of the python SDK.
NOTE:
* Has not undergone extensive software testing
* Currently missing some functionality
## Table of Contents
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Getting Started
Make sure Node v21.1.0 is installed on your machine via homebrew (MACOS), NVM (ANY), or any native package manager
```bash
# Using NVM
cd your-project
nvm install 21.1.0
# switch to Node v21.1.0
nvm use 21.1.0
# check version
node -v
```
### Prerequisites
* Node v21.1.0
* NOTE: If you do not use the correct version, you may need to download additional polyfills
### Installation
Add the SDK's remote URI to pull the repository upon calling `npm i`
```json
{
"...": "",
"dependencies": {
"...": "",
"resilient-sdk": "",
"...": "",
},
"...": ""
}
```
```bash
# Example installation steps
cd your-project
// installs all dependencies in node modules
npm install
```
## Usage
```javascript
const resilient-sdk = require("resilient-sdk")
// OR DESTRUCTURED IMPORTS
import { ... } from 'resilient-sdk'
// you will have have access to all classes and interfaces for your application
```
## Contributing
The ExpoLab at the University of California, Davis
Primary contributor: Steve Chen
## License
This project is licensed under the Apache License, Version 2.0 - see the [LICENSE](LICENSE) file for details.