chore: wip

Author: janniks

packages/sbtc/CHANGELOG.md

@@ -0,0 +1,3 @@
+const makeJestConfig = require('../../configs/jestConfig');
+
+module.exports = makeJestConfig(__dirname);

packages/sbtc/README.md

@@ -0,0 +1,51 @@
+{
+  "name": "@stacks/sbtc",
+  "version": "6.7.0",
+  "description": "Library for sBTC.",
+  "license": "MIT",
+  "author": "Hiro Systems PBC (https://hiro.so)",
+  "homepage": "https://hiro.so/stacks-js",
+  "scripts": {
+    "build": "npm run clean && npm run build:cjs && npm run build:esm && npm run build:umd",
+    "build:cjs": "tsc -b tsconfig.build.json",
+    "build:esm": "tsc -p tsconfig.build.json --module ES6 --outDir ./dist/esm",
+    "build:umd": "NODE_OPTIONS=--max-old-space-size=8192 webpack --config webpack.config.js",
+    "clean": "rimraf dist && tsc -b tsconfig.build.json --clean",
+    "pack": "npm pack",
+    "prepublishOnly": "npm run test && NODE_ENV=production npm run build",
+    "start": "tsc -b tsconfig.build.json --watch --verbose",
+    "test": "jest",
+    "test:watch": "jest --watch --coverage=false",
+    "typecheck": "tsc --noEmit",
+    "typecheck:watch": "npm run typecheck -- --watch"
+  },
+  "dependencies": {
+    "@stacks/encryption": "^6.7.0",
+    "@stacks/transactions": "^6.7.0"
+  },
+  "devDependencies": {
+    "jest-fetch-mock": "^3.0.3",
+    "rimraf": "^3.0.2"
+  },
+  "sideEffects": false,
+  "typings": "dist/index.d.ts",
+  "main": "dist/index.js",
+  "module": "dist/esm/index.js",
+  "umd:main": "dist/umd/index.js",
+  "unpkg": "dist/umd/index.js",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "keywords": [
+    "sBTC",
+    "Stacks"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hirosystems/stacks.js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/hirosystems/stacks.js/issues"
+  }
+}

packages/sbtc/jest.config.js

@@ -0,0 +1,37 @@
+interface MintOptions {
+  amount: number; // (amount uint)
+  destination: string; // (destination principal)
+  depositTxid: string; // (deposit-txid (buff 32))
+  burnChainHeight: number; // (burn-chain-height uint)
+  merkleProof: string[]; // (merkle-proof (list 14 (buff 32)))
+  txIndex: number; // (tx-index uint)
+  treeDepth: number; // (tree-depth uint)
+  blockHeader: string; // (block-header (buff 80)))
+}
+
+export class sBTCClient {
+  constructor(public network: StacksNetwork) {}
+
+  /**
+
+   */
+  async mint(options: MintOptions): Promise<void> {
+    const [contractAddress, contractName] = this.parseContractId(options?.contractId);
+    const result = await callReadOnlyFunction({
+      network: this.network,
+      senderAddress: this.address,
+      contractAddress,
+      contractName,
+      functionArgs: [uintCV(options.rewardCyleId), uintCV(options.rewardSetIndex)],
+      functionName: 'get-reward-set-pox-address',
+    });
+
+    return unwrapMap(result as OptionalCV<TupleCV>, tuple => ({
+      pox_address: {
+        version: ((tuple.data['pox-addr'] as TupleCV).data['version'] as BufferCV).buffer,
+        hashbytes: ((tuple.data['pox-addr'] as TupleCV).data['hashbytes'] as BufferCV).buffer,
+      },
+      total_ustx: (tuple.data['total-ustx'] as UIntCV).value,
+    }));
+  }
+}

packages/sbtc/package.json

@@ -0,0 +1,27 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "noEmit": false,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "tsBuildInfoFile": "./tsconfig.build.tsbuildinfo",
+    "composite": true
+  },
+  "references": [
+    {
+      "path": "../common/tsconfig.build.json"
+    },
+    {
+      "path": "../encryption/tsconfig.build.json"
+    },
+    {
+      "path": "../network/tsconfig.build.json"
+    },
+    {
+      "path": "../transactions/tsconfig.build.json"
+    }
+  ],
+  "include": [
+    "src/**/*"
+  ]
+}

packages/sbtc/src/index.ts

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*", "tests/**/*"],
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"]
+  }
+}

packages/sbtc/tsconfig.build.json

@@ -0,0 +1,7 @@
+const config = require('../../configs/webpack.config.js');
+
+config.output.library.name = 'StacksStacking';
+
+config.resolve.fallback = {};
+
+module.exports = config;

packages/sbtc/tsconfig.json

@@ -55,6 +55,7 @@ test('Length prefixed list serialization and deserialization', () => {
   expect(deserialized.values.length).toBe(addressList.length);
 
   for (let index = 0; index < addressList.length; index++) {
+    // todo: toString() doesn't make sense FIX
     expect(deserialized.values[index].toString()).toBe(addressList[index].toString());
   }
 });