-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(scanner-sdk): add SDK implementation (#5)
Adds separate package architecture. Adds SDK implementation. Adds UTs for SDK. --------- Signed-off-by: Luca Georges Francois <[email protected]>
- Loading branch information
1 parent
c8f8baf
commit 0b6c1f6
Showing
11 changed files
with
2,034 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
kind: Added | ||
body: Implemented the TS SDK | ||
time: 2024-03-11T01:11:27.656086+01:00 | ||
custom: | ||
Author: 0xpanoramix | ||
PR: "5" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
.pnpm-debug.log* | ||
|
||
# Diagnostic reports (https://nodejs.org/api/report.html) | ||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
*.lcov | ||
|
||
# nyc test coverage | ||
.nyc_output | ||
|
||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
bower_components | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (https://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directories | ||
node_modules/ | ||
jspm_packages/ | ||
|
||
# Snowpack dependency directory (https://snowpack.dev/) | ||
web_modules/ | ||
|
||
# TypeScript cache | ||
*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Optional stylelint cache | ||
.stylelintcache | ||
|
||
# Microbundle cache | ||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variable files | ||
.env | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.env.local | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
.cache | ||
.parcel-cache | ||
|
||
# Next.js build output | ||
.next | ||
out | ||
|
||
# Nuxt.js build / generate output | ||
.nuxt | ||
dist | ||
|
||
# Gatsby files | ||
.cache/ | ||
# Comment in the public line in if your project uses Gatsby and not Next.js | ||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
# public | ||
|
||
# vuepress build output | ||
.vuepress/dist | ||
|
||
# vuepress v2.x temp and cache directory | ||
.temp | ||
.cache | ||
|
||
# Docusaurus cache and generated files | ||
.docusaurus | ||
|
||
# Serverless directories | ||
.serverless/ | ||
|
||
# FuseBox cache | ||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
.dynamodb/ | ||
|
||
# TernJS port file | ||
.tern-port | ||
|
||
# Stores VSCode versions used for testing VSCode extensions | ||
.vscode-test | ||
|
||
# yarn v2 | ||
.yarn/cache | ||
.yarn/unplugged | ||
.yarn/build-state.yml | ||
.yarn/install-state.gz | ||
.pnp.* | ||
|
||
|
||
# Added by cargo | ||
|
||
**/target | ||
**/pkg |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# massa-sc-scanner-sdk | ||
|
||
This package contains the implementation of the Massa smart contract bytecode scanner SDK. | ||
|
||
## Introduction | ||
|
||
The Massa smart contract bytecode scanner SDK is a tool that allows you to extract information from smart contract bytecode. | ||
It is currently in development and more features will be added in the future. | ||
|
||
## Installation | ||
|
||
To install this package, you can use npm: | ||
|
||
```bash | ||
npm install @quartz-technology/massa-sc-scanner-sdk | ||
``` | ||
|
||
## Usage | ||
|
||
Below is an example of how to use this package: | ||
|
||
```typescript | ||
import { ScannerSDK } from "@quartz-technology/massa-sc-scanner-sdk"; | ||
|
||
const sdk = new ScannerSDK("https://buildnet.massa.net"); | ||
(async () => { | ||
const res = await sdk.scanSmartContract("AS1sKBEGsqtm8vQhQzi7KJ4YhyaKTSkhJrLkRc7mQtPqme3VcFHm"); | ||
|
||
console.log(res); | ||
})(); | ||
``` | ||
|
||
## Features | ||
|
||
- Extracts the names of the smart contract's exported functions. | ||
- Extracts the names of the host functions used in the smart contract. | ||
|
||
## Contributing | ||
|
||
We welcome contributions from everyone. Please refer to the [contributing guidelines](../../CONTRIBUTING.md) for more information. | ||
|
||
## Acknowledgements | ||
|
||
We would like to thank the following entities for their amazing work. Without them, this project would not be possible. | ||
|
||
- [Bytecode Alliance](https://github.com/bytecodealliance) | ||
- [Massa](https://massa.net/) | ||
|
||
## Authors | ||
|
||
This project is maintained by the 📡 at [Quartz](https://quartz.technology). | ||
|
||
It is being developed with the help of [0xtekgrinder](https://github.com/0xtekgrinder). |
Oops, something went wrong.