release: update docs for v1.0.0-beta.2 (#142)

docs: update docs for v1.0.0-beta.2

.github/workflows/release.yml

@@ -4,7 +4,6 @@ on:
   push:
     tags:
       - "v*.*.*"
-  workflow_dispatch:
 
 jobs:
   release:

CHANGELOG.md

@@ -13,7 +13,7 @@ for new features.
 
 ### Changed
 
-* `Signer` `signTransaction` method to `sendTransaction`
+for changes in existing functionality.
 
 ### Deprecated
 
@@ -27,6 +27,13 @@ for now removed features.
 
 for any bug fixes.
 
+## [1.0.0-beta.2] - 2022-12-01
+
+### Changed
+
+* `Signer` `signTransaction` method to `sendTransaction`
+* `StarkKey.generateLegacyStarkPrivateKey` to take in a `signer` instead of the seed and address
+
 ## [1.0.0-beta.1] - 2022-11-28
 
 ### Added

README.md

@@ -87,6 +87,40 @@ Utility functions that will chain necessary API calls to complete a process or p
 
 In order to call authorised API and use workflow functions, you will need to pass in the connected wallet provider. This means you will need to implement your own Wallet L1 [Signer](https://github.com/immutable/imx-core-sdk-kotlin-jvm/blob/main/imx-core-sdk-kotlin-jvm/src/main/kotlin/com/immutable/sdk/Signer.kt) and L2 [StarkSigner](https://github.com/immutable/imx-core-sdk-kotlin-jvm/blob/main/imx-core-sdk-kotlin-jvm/src/main/kotlin/com/immutable/sdk/Signer.kt).
 
+#### L1 Signer
+
+Example implementation of the L1 Signer using [web3j](https://github.com/web3j/web3j):
+
+```kt
+class L1Signer(private val credentials: Credentials) : Signer {
+
+    val web3j = Web3j.build(HttpService(NODE_URL))
+
+    override fun getAddress(): CompletableFuture<String> {
+        return CompletableFuture.completedFuture(credentials.address)
+    }
+
+    override fun signMessage(message: String): CompletableFuture<String> {
+        val signatureData = Sign.signPrefixedMessage(message.toByteArray(), credentials.ecKeyPair)
+        val retval = ByteArray(65)
+        System.arraycopy(signatureData.r, 0, retval, 0, 32)
+        System.arraycopy(signatureData.s, 0, retval, 32, 32)
+        System.arraycopy(signatureData.v, 0, retval, 64, 1)
+        val signed = Numeric.toHexString(retval)
+        return CompletableFuture.completedFuture(signed)
+    }
+
+    @Suppress("TooGenericExceptionCaught")
+    override fun sendTransaction(rawTransaction: RawTransaction): CompletableFuture<String> {
+        val signedTransaction = TransactionEncoder.signMessage(rawTransaction, credentials)
+        return web3j.ethSendRawTransaction(Numeric.toHexString(signedTransaction)).sendAsync()
+            .thenApply { it.transactionHash }
+    }
+}
+```
+
+#### L2 StarkSigner
+
 Use `StarkKey.generateStarkPrivateKey()` to create an instance of `StandardStarkSigner`, an implementation of `StarkSigner`.
 #### 🚨🚨🚨 Warning 🚨🚨🚨
 > You will have to persist the Stark private key. The key is [randomly generated](/src/utils/stark/starkCurve.ts#L99) so **_cannot_** be deterministically re-generated.

imx-core-sdk-kotlin-jvm/generated/src/main/kotlin/com/immutable/sdk/BuildConfig.java

@@ -1,4 +1,4 @@
 package com.immutable.sdk;
 public class BuildConfig {
-    public static String VERSION = "1.0.0-beta.1";
+    public static String VERSION = "1.0.0-beta.2";
 }

version.yml

@@ -1 +1 @@
-version: 1.0.0-beta.1
+version: 1.0.0-beta.2