v2

Author: nooxx

.eslintrc.json

@@ -0,0 +1,8 @@
+{
+  "extends": "next/core-web-vitals",
+  "rules": {
+    "object-curly-spacing": ["error", "always"],
+    "indent": ["warn", 2],
+    "semi": ["warn", "always"]
+  }
+}

.github/workflows/publish.yml

@@ -0,0 +1,20 @@
+name: Publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/sdk.yml

@@ -0,0 +1,27 @@
+name: "sdk-js"
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "src/**"
+      - "index.ts"
+      - ".github/workflows/sdk.yml"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "src/**"
+      - "index.ts"
+      - ".github/workflows/sdk.yml"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install modules
+        run: npm install
+      - name: Run ESLint
+        run: npm run lint

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+node_modules/
+lib/
+.idea/

.npmignore

@@ -0,0 +1,3 @@
+node_modules/
+.idea
+examples/

LICENSE

@@ -0,0 +1,71 @@
+Business Source License 1.1
+
+License text copyright © 2022 Kiln SAS, All Rights Reserved.
+"Business Source License" is a trademark of Kiln SAS.
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+Kiln hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark “Business Source License”,
+as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business
+Source License” name and trademark, Licensor covenants to Kiln, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where “compatible” means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text “None”.
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.

README.md

@@ -0,0 +1,102 @@
+## Description
+
+Kiln JS SDK makes it easy to interact with the Kiln staking platform.
+
+It provides a simple way of crafting staking transactions as well getting real time and historical data about your stakes.
+
+Check out the [full documentation](https://docs.kiln.fi/v1/connect/overview).
+
+## Supported protocols
+- ADA
+- ATOM
+- DOT
+- ETH
+- MATIC
+- NEAR
+- SOL
+- XTZ
+- More protocol to come, don't hesitate to contact us ([email protected])
+
+## Installation
+
+You can install the JS SDK with npm:
+
+```sh
+npm install --save @kilnfi/sdk
+```
+
+## Setup
+In order to use this sdk, you will need a kiln api token.  
+Please contact [email protected] to get one.
+
+```typescript
+import { Kiln } from "../src/kiln";
+
+const k = new Kiln({
+  testnet: true,
+  apiToken: 'kiln_xxx',
+});
+```
+
+## Craft 32 ETH staking transaction, sign it with fireblocks and broadcast it
+```typescript
+import { Kiln } from "@kilnfi/sdk";
+import { Integration } from "@kilnfi/sdk/lib/types/integrations";
+const fs = require('fs');
+
+const apiSecret = fs.readFileSync(__dirname + '/path_to_fireblocks_secret', 'utf8');
+
+const k = new Kiln({
+  testnet: true,
+  apiToken: 'kiln_xxx',
+});
+
+const vault: Integration = {
+  provider: 'fireblocks',
+  fireblocksApiKey: 'YOUR_API_USER_KEY', // your fireblocks API user key
+  fireblocksSecretKey: apiSecret, // your fireblocks private key (generated with your CSR file and your API user)
+  vaultId: 7 // your fireblocks vault id
+};
+
+try {
+  // Craft 32 ETH staking transaction
+  const tx = await k.eth.craftStakeTx(
+    'kiln_account_id',
+    'withdrawal_address',
+    32
+  );
+  
+  // Sign it with your fireblock vault
+  const txSigned = await k.eth.sign(vault, tx);
+  
+  // Broadcast it
+  const hash = await k.eth.broadcast(txSigned);
+  
+} catch (err) {
+  // handle errors
+}
+```
+
+## Fetch ETH stakes and network stats
+```typescript
+try {
+    // Get stakes by accounts
+    const stakes = await k.eth.getAccountsRewards(['kiln-account-id']);
+    
+    // Get stakes by wallets
+    const stakesByWallet = await k.eth.getWalletRewards(['wallet-address']);
+
+    // Get stakes by validators
+    const stakesByValidator = await k.eth.getStakesRewards(['validator-address']);
+
+    // Get network stats
+    const stats = await k.eth.getNetworkStats();
+    
+  } catch (err) {
+    // handle errors
+  }
+```
+
+## License
+This package is open-sourced software licensed under the [BUSL-1.1 license](https://github.com/kilnfi/sdk-js/blob/main/LICENSE).
+

index.ts

@@ -0,0 +1 @@
+export * from './src/kiln';