@lombard.finance/sdk 2.1.2 → 2.2.0

package/README.md

@@ -46,6 +46,8 @@ const { getDepositBtcAddress } = require('@lombard.finance/sdk');
   - [getLBTCExchangeRate](#getLBTCExchangeRate)
   - [storeStakeAndBakeSignature](#storeStakeAndBakeSignature)
   - [getUserStakeAndBakeSignature](#getUserStakeAndBakeSignature)
+  - [storeNetworkFeeSignature](#storeNetworkFeeSignature)
+  - [getNetworkFeeSignature](#getNetworkFeeSignature)
 - Web3 based
   - [signLbtcDestionationAddr](#signLbtcDestionationAddr)
   - [claimLBTC](#claimLBTC)
@@ -53,6 +55,8 @@ const { getDepositBtcAddress } = require('@lombard.finance/sdk');
   - [getBasculeDepositStatus](#getBasculeDepositStatus)
   - [getLBTCTotalSupply](#getLBTCTotalSupply)
   - [signStakeAndBake](#signStakeAndBake)
+  - [getStakeAndBakeFee](#getStakeAndBakeFee)
+  - [signNetworkFee](#signNetworkFee)
 
 #### getDepositBtcAddress
 
@@ -129,10 +133,10 @@ Returns all deposits for a given address.
 
 Parameters:
 
-| name | type | description |
-|-----------|----------|--------------------------------------|
-| `address` | `string` | The EVM address to get deposits for |
-| `env` | `TEnv` | Environment (optional, default: 'prod') |
+| name      | type     | description                             |
+| --------- | -------- | --------------------------------------- |
+| `address` | `string` | The EVM address to get deposits for     |
+| `env`     | `TEnv`   | Environment (optional, default: 'prod') |
 
 Usage
 
@@ -152,11 +156,11 @@ Returns the exchange rate for LBTC.
 
 Parameters:
 
-| name | type | description |
-|-----------|------------|-----------------------------------------------------|
+| name      | type       | description                                            |
+| --------- | ---------- | ------------------------------------------------------ |
 | `chainId` | `TChainId` | The chain id of the asset to get the exchange rate for |
-| `amount` | `number` | The amount of the asset to get the exchange rate for |
-| `env` | `TEnv` | Environment (optional, default: 'prod') |
+| `amount`  | `number`   | The amount of the asset to get the exchange rate for   |
+| `env`     | `TEnv`     | Environment (optional, default: 'prod')                |
 
 Usage
 
@@ -178,11 +182,11 @@ Signing is necessary for the generation of the deposit address.
 
 Parameters:
 
-| name | type | description |
-|------------|------------------|------------------------------|
+| name       | type               | description                    |
+| ---------- | ------------------ | ------------------------------ |
 | `provider` | `IEIP1193Provider` | The EIP-1193 provider instance |
-| `account` | `string` | Current account address |
-| `chainId` | `TChainId` | Current chain ID |
+| `account`  | `string`           | Current account address        |
+| `chainId`  | `TChainId`         | Current chain ID               |
 
 Usage
 
@@ -206,14 +210,14 @@ Claims LBTC.
 
 Parameters:
 
-| name | type | description |
-|-----------------|------------------|--------------------------------------------------------------------------------------|
-| `data` | `string` | Raw payload from deposit notarization. Can be obtained from the `getDepositsByAddress` |
-| `proofSignature` | `string` | Signature from deposit notarization. Can be obtained from the `getDepositsByAddress` |
-| `provider` | `IEIP1193Provider` | The EIP-1193 provider instance |
-| `account` | `string` | Current account address |
-| `chainId` | `TChainId` | Current chain ID |
-| `env` | `TEnv` | Environment (optional, default: 'prod') |
+| name             | type               | description                                                                            |
+| ---------------- | ------------------ | -------------------------------------------------------------------------------------- |
+| `data`           | `string`           | Raw payload from deposit notarization. Can be obtained from the `getDepositsByAddress` |
+| `proofSignature` | `string`           | Signature from deposit notarization. Can be obtained from the `getDepositsByAddress`   |
+| `provider`       | `IEIP1193Provider` | The EIP-1193 provider instance                                                         |
+| `account`        | `string`           | Current account address                                                                |
+| `chainId`        | `TChainId`         | Current chain ID                                                                       |
+| `env`            | `TEnv`             | Environment (optional, default: 'prod')                                                |
 
 Usage
 
@@ -241,14 +245,14 @@ Unstakes LBTC to the specified BTC address.
 
 Parameters:
 
-| name | type | description |
-|--------------|------------------|-------------------------------------------|
-| `btcAddress` | `string` | The BTC address to send the unstaked BTC to |
-| `amount` | `string` | The amount of LBTC to unstake |
-| `provider` | `IEIP1193Provider` | The EIP-1193 provider instance |
-| `account` | `string` | Current account address |
-| `chainId` | `TChainId` | Current chain ID |
-| `env` | `TEnv` | Environment (optional, default: 'prod') |
+| name         | type               | description                                 |
+| ------------ | ------------------ | ------------------------------------------- |
+| `btcAddress` | `string`           | The BTC address to send the unstaked BTC to |
+| `amount`     | `string`           | The amount of LBTC to unstake               |
+| `provider`   | `IEIP1193Provider` | The EIP-1193 provider instance              |
+| `account`    | `string`           | Current account address                     |
+| `chainId`    | `TChainId`         | Current chain ID                            |
+| `env`        | `TEnv`             | Environment (optional, default: 'prod')     |
 
 Usage
 
@@ -276,13 +280,13 @@ Check Deposit Status by hash id through Bascule
 
 Parameters:
 
-| name | type | description |
-|-----------------|------------------|--------------------------------------------------------------------------------------|
-| `txId` | `string` | Payload from deposit notarization. Can be obtained from the `getDepositsByAddress` |
-| `provider` | `IEIP1193Provider` | The EIP-1193 provider instance |
-| `account` | `string` | Current account address |
-| `chainId` | `TChainId` | Current chain ID |
-| `env` | `TEnv` | Environment (optional, default: 'prod') |
+| name       | type               | description                                                                        |
+| ---------- | ------------------ | ---------------------------------------------------------------------------------- |
+| `txId`     | `string`           | Payload from deposit notarization. Can be obtained from the `getDepositsByAddress` |
+| `provider` | `IEIP1193Provider` | The EIP-1193 provider instance                                                     |
+| `account`  | `string`           | Current account address                                                            |
+| `chainId`  | `TChainId`         | Current chain ID                                                                   |
+| `env`      | `TEnv`             | Environment (optional, default: 'prod')                                            |
 
 Usage
 
@@ -307,11 +311,11 @@ Get LBTC total supply
 
 Parameters:
 
-| name | type | description |
-|-----------------|------------------|--------------------------------------------------------------------------------------|
-| `rpcUrl` | `string` | Rpc url for the chain |
-| `chainId` | `TChainId` | Current chain ID |
-| `env` | `TEnv` | Environment (optional, default: 'prod') |
+| name      | type       | description                             |
+| --------- | ---------- | --------------------------------------- |
+| `rpcUrl`  | `string`   | Rpc url for the chain                   |
+| `chainId` | `TChainId` | Current chain ID                        |
+| `env`     | `TEnv`     | Environment (optional, default: 'prod') |
 
 Usage
 
@@ -333,15 +337,15 @@ Sign Stake And Bake
 
 ## Parameters
 
-| name         | type                | description                                                                 |
-|--------------|---------------------|-----------------------------------------------------------------------------|
-| `provider`   | `IProvider`         | Provider instance to interact with the blockchain                          |
-| `address`    | `string`            | The address to sign with (owner)                                           |
-| `chainId`    | `TChainId`          | Chain ID for the signature                                                 |
-| `value`      | `string`            | The value to approve                                                       |
-| `expiry`     | `number`            | Expiry date as a unix timestamp                                            |
-| `rpcUrl`     | `string` (optional) | Optional RPC URL for the network                                           |
-| `vaultKey`   | `string`            | The key of the vault to authorize                                          |
+| name       | type                | description                                       |
+| ---------- | ------------------- | ------------------------------------------------- |
+| `provider` | `IProvider`         | Provider instance to interact with the blockchain |
+| `address`  | `string`            | The address to sign with (owner)                  |
+| `chainId`  | `TChainId`          | Chain ID for the signature                        |
+| `value`    | `string`            | The value to approve                              |
+| `expiry`   | `number`            | Expiry date as a unix timestamp                   |
+| `rpcUrl`   | `string` (optional) | Optional RPC URL for the network                  |
+| `vaultKey` | `string`            | The key of the vault to authorize                 |
 
 Usage
 
@@ -354,7 +358,7 @@ const { signature, signatureData } = await signStakeAndBake({
   chainId,
   value: toSatoshi(approvalValue.toString()).toString(),
   expiry: permitExpiryTime,
-  vaultKey: selectedVault.key
+  vaultKey: selectedVault.key,
 });
 ```
 
@@ -366,19 +370,22 @@ Store stake and bake signature
 
 ## Parameters
 
-| name         | type                | description                                 |
-|--------------|---------------------|---------------------------------------------|
-| `env`        | `TEnv`              | Environment (e.g., 'prod', 'dev', etc.)     |
-| `signature`  | `string`            | The generated signature                     |
-| `typedData`  | `string`            | JSON typed data used for the signature      |
+| name        | type     | description                             |
+| ----------- | -------- | --------------------------------------- |
+| `env`       | `TEnv`   | Environment (e.g., 'prod', 'stage', etc.) |
+| `signature` | `string` | The generated signature                 |
+| `typedData` | `string` | JSON typed data used for the signature  |
 
 Usage
 
 ```typescript
 import { storeStakeAndBakeSignature } from '@lombard.finance/sdk';
 
-const status = await storeStakeAndBakeSignature({ signature, signatureData, env: 'prod' });
-
+const status = await storeStakeAndBakeSignature({
+  signature,
+  signatureData,
+  env: 'prod',
+});
 ```
 
 #### getUserStakeAndBakeSignature
@@ -389,12 +396,11 @@ Get user's stake and bake signature from the API
 
 ## Parameters
 
-| name                    | type     | description                                |
-|-------------------------|----------|--------------------------------------------|
-| `userDestinationAddress`| `string` | The user's destination address             |
-| `chainId`               | `string` | The chain ID                               |
-| `env`                   | `TEnv`   | Environment (e.g., 'prod', 'dev', etc.)    |
-
+| name                     | type     | description                             |
+| ------------------------ | -------- | --------------------------------------- |
+| `userDestinationAddress` | `string` | The user's destination address          |
+| `chainId`                | `string` | The chain ID                            |
+| `env`                    | `TEnv`   | Environment (e.g., 'prod', 'stage', etc.) |
 
 Usage
 
@@ -404,21 +410,76 @@ import { getUserStakeAndBakeSignature } from '@lombard.finance/sdk';
 const response = await getUserStakeAndBakeSignature({
   userDestinationAddress: address,
   chainId,
-  env: 'prod'
+  env: 'prod',
 });
 console.log(response);
 ```
 
+#### storeNetworkFeeSignature
+
+`@returns Promise<IStoreNetworkFeeSignatureResponse>` Response promise with statuses
+
+Store authorize network fee
+
+## Parameters
+
+| name                     | type     | description                             |
+| ------------------------ | -------- | --------------------------------------- |
+| `signature`              | `string` | The signature of signNetworkFee method  |
+| `typedData`              | `string` | JSON typed data used for the signature  |
+| `address`                | `string` | Destination address                     |
+| `env`                    | `TEnv`   | Environment (e.g., 'prod', 'stage', etc.) |
+
+Usage
+
+```typescript
+import { storeNetworkFeeSignature } from '@lombard.finance/sdk';
+
+const status = await storeNetworkFeeSignature({
+  signature: '',
+  typedData: '',
+  address: '0x...',
+  env: 'prod',
+});
+console.log(status); // success
+```
+
+#### getNetworkFeeSignature
+
+`@returns Promise<IStoreNetworkFeeSignatureResponse>` Response promise with statuses
+
+Store authorize network fee
+
+## Parameters
+
+| name                     | type     | description                             |
+| ------------------------ | -------- | --------------------------------------- |
+| `chainId`                | `number` | The chain ID                            |
+| `address`                | `string` | Destination address                     |
+| `env`                    | `TEnv`   | Environment (e.g., 'prod', 'stage', etc.) |
+
+Usage
+
+```typescript
+import { getNetworkFeeSignature } from '@lombard.finance/sdk';
+
+const signatureResponse = await getNetworkFeeSignature({
+  chainId: 1,
+  address: '0x...',
+  env: 'prod',
+});
+console.log(signatureResponse);
+```
+
 #### getStakeAndBakeVaults
 
 `@returns IStakeAndBakeVault[]` A list of available vaults
 
 ## Parameters
 
-| name                    | type     | description                                |
-|-------------------------|----------|--------------------------------------------|
-| `chainId`               | `string` | The chain ID                               |
-
+| name      | type     | description  |
+| --------- | -------- | ------------ |
+| `chainId` | `string` | The chain ID |
 
 Usage
 
@@ -428,4 +489,65 @@ import { getStakeAndBakeVaults } from '@lombard.finance/sdk';
 const vaults = getStakeAndBakeVaults(1);
 
 console.log(vaults);
-```
+```
+
+#### getStakeAndBakeFee
+
+`@returns Promise<string>` Promise that resolves stakeAndBake fee in satoshis
+
+Get Stake and bake fee in satoshis
+
+## Parameters
+
+| name           | type     | description           |
+| -------------- | -------- | --------------------- |
+| `vaultAddress` | `string` | The vault address     |
+| `chainId`      | `string` | The chain ID          |
+| `rpcUrl`       | `string` | Rpc url for the chain |
+
+Usage
+
+```typescript
+import { getStakeAndBakeFee } from '@lombard.finance/sdk';
+
+const response = await getStakeAndBakeFee({
+  chainId: OChainId.binanceSmartChain,
+  rpcUrl: 'https://rpc.ankr.com/bsc',
+  vaultAddress: '0xC8bbF6153D7Ba105f1399D992ebd32B0541996ef',
+});
+console.log(response);
+```
+
+#### signNetworkFee
+
+`@returns Promise<ISignNetworkFeeResponse>` A promise that resolves to the signature and typed data
+
+Signs the network fee transaction in the current account.
+Signing is necessary for the auto-mint.
+
+## Parameters
+
+| name       | type        | description                                       |
+| ---------- | ----------- | ------------------------------------------------- |
+| `address`  | `string`    | The user address                                  |
+| `fee`      | `string`    | The Authorization fee                             |
+| `expiry`   | `number`    | Expiration time                                   |
+| `chainId`  | `string`    | The chain ID                                      |
+| `env`      | `TEnv`      | Environment (e.g., 'prod', 'stage', etc.)           |
+| `provider` | `IProvider` | Provider instance to interact with the blockchain |
+
+Usage
+
+```typescript
+import { signNetworkFee } from '@lombard.finance/sdk';
+
+const response = await signNetworkFee({
+  chainId: OChainId.binanceSmartChain,
+  address: '0x...',
+  provider: window.ethereum,
+  fee: toSatoshi('0.0001'),
+  expiry: Math.floor(Date.now() / 1000) + NETWORK_FEE_EXPIRATION_TIME_SECONDS,
+  env: 'prod',
+});
+console.log(response);
+```