Acre SDK - staking module #106

Create wrappers for some of objects from `@keep-network/tbtc-v2.ts` lib to use in Acre SDK.

The main idea is to hide the signing process under the exact implementation for a given chain. For example, we can use `ethers` lib for Ethereum implementation, but different lib for other chains. The Acre staking flow will require a signature and the signig message implementation will be used in the staking module.

Create a module that is responsible for initializing a stake for a receiver via tBTC depositor contract from `Acre`.

This function is responsible for creating the `Acre` SDK for any `Ethereum` network. It also creates necessary modules that allow developers to interact with Acre system.

We want to build the Ethereum implementation on top of the `ethers` lib.

Add `ChainSignedMessage` that represents a signature. This interface exposes `verify` function that returns an address of the private key that produced the signature. Also here we update the `ChainMessages` interface - `sign` function should return the `ChainSignedMessage` object.

Implement signing process for Ethereum chain. Here we use the `ethers` lib under the hood.

We make sure that the `receiver` address is equal to the address that produced the signature.

We need types generated by typechain tool.

Create Ethereum contract wrapper using ethers. We do not want to expose ethers contract instance outside the SDK.

We should use our wrappers because we expose them outside the SDK.

`Staking` -> `StakeInitialization`. The previous name was confusing - we want to name classes as steps of the staking flow to make the sdk more dev-friendly.

To simplify accept `Signer` or `VoidSigner` only. Developers can use `VoidSigner` from `ethers` if they want to initialize the Ethereum Acre SDK in readonly mode instead of `Provider`.

`Jest` testing framework has built-in support for mocks, stubs, and spies. Chai requires the installation of additional dependencies but most of them are no longer maintained. I also tried using the `chai` with `ethereum-waffle` package, that adds support for mocking contracts, but it only supports ethers in v5, we want to use the latest version of ethers - it is v6.

`ChainMessages` -> `ChainMessageSigner`

Add unit test for `EthereumTBTCDepositor.initializeStake` function.

The staking flow in Acre will require the typed messages so here we rename the `ChainMessageSigner` to `ChainEIP712Signer`. The Ethereum implementation uses the ethers lib to handle the signing and verifying process.

Add `receiver` and `referral` params to the `initializeStake` function. We need to pass these values as parsed hex as extra data to the tBTC system. Currently left only TODO because we need to wait for extra data feature in tbtc-v2.ts lib. Also we decided to not include the signing process here but the `StakeInitialization` should be responsible for this.

Rename `getDepositAddress` -> `getBitcoinAddress` to better understand what type of address it is. It should be called as first step of the staking to get the Bitcoin address and send a given amount of BTC to a received address.

Add `receiver` and `referral` those values should be stored in this object to not pass them again to the `stake` function. Also here we update the type of `messageSigner`.

User shuold sign message before the stake. We decided to implelemnt it as a separate function that should be called before stake because we want to give developers more flexibility. It's not a part of `stake` function because e.g. in the dapp after signing message there may be some additional steps. After signing we save the signed message in the instance of `StakeInitialization` which then can be used inside `stake` function w/o passing message to this function.

Clean up tests by extracting test data to variables outside of the tests brackets. Add unit test for `StakeInitialization` object which is created by `StakingModule.initializeStake`.

Use `--verbose` flag to display individual test results with the test suite hierarchy.

`message-signer` -> `eip712-signer`. The staking flow will require only eip712 typed messages so we decided to rename to a more specific name.

Add unit test for Ethereum implementation of ChainSignedMessage.

Also leave a `TODO` not to revisit the message structure before the launch.

Currently to do not block the integration SDK <-> dApp we want to send Ethereum transaction as part of the staking flow. In the final version users won't have to sign the Ethereum transaction, they will just send stake details to a relayer bot which will stake BTC on user's behalf.

Based on the network param this function creates Acre SDK for supported Ethereum networks eg. `mainnet` or `sepolia`. Here we leave few TODOs that we should handle later once we get contract artifacts for different networks. Also we need to make sure the tBTC SDK will work ok with ethers v6 - we will check this while working on poc for Acre SDK and dApp integration.

Get the chain id from `ethers.provider` instead of passing it to a `sign` fn in `domain` param. The main idea is to not expose chain-specific API outside the lib components. Modules should not know about ethers lib.

Cover a case when ethers provider can not return chain id.

Add docs comments to TBTCDepositor interface and to the Ethereum implementation of this contract.

Add docs comments to abstract interfaces and to Ethereum implementation.

Here we also disable `@typescript-eslint/unbound-method` rule for test files because it reporst that we use unbonded method for `expect` function from jest. For example, with this rule we can't do the following check: ``` expect(...).toBeDefined() ```

The tBTC-v2.ts SDK uses the ethers v5 and signers are not compatible with signers from ethers v6. Here we create an abstract signer that adds necessary methods (only used by tBTC-v2 SDK) to be compatible with ethers v5 signer which is used in the tBTC-v2.ts SDK.

Use `EthereumSignerCompatibleWithEthersV5` type for `signer` param to force developers to pass signer compatible with signer used in tbtc-v2.ts SDK. Thansk to this we can pass signer from ethers v6 but it must implements necessary functions or extends `EthereumSignerCompatibleWithEthersV5` abstract class.

To use the latest version.

Disable `import/no-unresolved` and leave a `TODO` to fix this issue. Disabling this rule for now because probably the path will change once we publish npm package for `core` module.

The ethers contract expects the address in prefixed format so we must add `0x` prefix. I've updated unit tests in one of the previous commits.

To be able to use the sdk in our dapp.

`depositor` -> `tbtcDepositor` to match the contract name.

Specify the return type of the private static method in Acre class.

`messages` -> `messageSigner`.

We would require this account to sign the messages, so it makes more sense to name it `staker` rather than `receiver`.

Use `TbtcDeposit` alias for `Deposit` import and rename the field in the `StakeInitialization` class to `tbtcDepositor`. To indicate this is deposit from tbtc-v2.ts SDK.

The contract name is `TbtcDepositor` not `TBTCDepositor`.

The message should contain the Bitcoin recovery address instead of the public key hash of this address.

The latest version of the `tbtc-v2.ts` lib adds support for revealing deposit with extra data. We need this feature to stake BTC(tBTC) on user's behalf.

The `TBTCDepositor` should implement the `DepositorProxy` interface to reveal the deposit with extra data on user's behalf. Here we also add `encodeExtraData` and `decodeExtraData` functions to encodes and decodes extra data passed to the tBTC Bridge contract. The Acre extra data is staker address and referral number.

Adujst staking module to the new TBTCDepositor interface and the latest version of the `tbtc-v2.ts` lib. We need to initiate the deposit with extra data using the `tbtc-v2.ts` SDK by injecting our implementation of the `DepositorProxy`.

Adjust unit tests to the latest version of tbtc-v2.ts lib that adds support for revealing deposits with extra data via depositor proxy.

We can get the referral and staker from tBTC deposit object.

Expose shared components, feature modules and the `Acre` entry point class from the root `index.ts` file. The `Acre` entry point class currently provides static function to initialize the Acre SDK for Ethereum network.

Pass the `bitcoinRecoveryAddress` to the `StakeInitialization` class. Since we can't easily determine if we should use `true` or `false` in `BitcoinAddressConverter.publicKeyHashToAddress` to convert public key hash to `P2PKH` or `P2WPKH` we can use what the input was w/o doing a conversion. Here we also get rid of: - the bitcoin client from the `StakeInitailization` class because at least for now it is unnecessary, - `referral` field - it is decoded and passed to the contract function under the hood.

We need `build` and `typechain` artifacts from `core` package in `sdk` because we import artifacts and types generated by `typechain` in `sdk` package. To achieve this, we extract a reusable workflow that builds the `core` package and uploads necessary artifacts. Then we use this reusable workflow to run successfully the `sdk` jobs. Here we also update the `jest` config - we should ignore tests inside `dist` dir if exists.

We want to omit the `signerOrProvider` because it points to ethers v5. We use ethers v6 in Acre SDK.

Ignore `sdk` monorepo package - `sdk` package has own prettier config.

According to the contract source code, the referral should be `uint16`. Here we also add more unit tests to cover more cases eg. when a referral is `0` (min `uint16`) and `65535` (max `uint16`).

We do not expect to support it.

And create the ethereum contract instance based on this artifact.

`receiver` -> `ethereumStakerAddress`. Add more context to the name of field for clarity when user sees it on the device, so they know what the value means.

Check if the staker address is a valid ethereum and non-zero address.

Based on the #91. We need this contract to get types generated by `typechain` and import them in `sdk`. Currently our SDK uses only `initializeStakeRequest` function and there is no need to add more functions like in #91.

Pass the `staker` value the same as was used in this function input parameter and use it insied `StakeInitialization` constructor to initialize the value of `#staker` field, instead of recovering it from the ` _tbtcDeposit.getReceipt()` extra data, as this is an external library that can be compromised and return invalid value.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Acre SDK - staking module #106

Acre SDK - staking module #106

Commits on Feb 7, 2024