https://github.com/exweb3/elixir_ethers_kms
A KMS signer library for Ethers
https://github.com/exweb3/elixir_ethers_kms
aws-kms elixir elliptic-curve-cryptography ethereum web3
Last synced: about 1 month ago
JSON representation
A KMS signer library for Ethers
- Host: GitHub
- URL: https://github.com/exweb3/elixir_ethers_kms
- Owner: ExWeb3
- License: apache-2.0
- Created: 2024-03-01T21:20:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-07T18:53:03.000Z (5 months ago)
- Last Synced: 2025-03-29T09:11:39.595Z (2 months ago)
- Topics: aws-kms, elixir, elliptic-curve-cryptography, ethereum, web3
- Language: Elixir
- Homepage: https://hexdocs.pm/ethers_kms/readme.html
- Size: 67.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# EthersKMS - a KMS Signer for Ethers
EthersKMS is a signer library for [Ethers](https://github.com/ExWeb3/elixir_ethers) using a Key Management Service such as [AWS KMS](https://aws.amazon.com/kms/) apart from the built-in [signers](https://github.com/ExWeb3/elixir_ethers/blob/main/lib/ethers/signer/local.ex) supported by Ethers.
## Installation
You can install the package by adding `ethers_kms` to the list of
dependencies in your `mix.exs` file:
```elixir
def deps do
[
{:ethers_kms, "~> 0.1.0"},
]
end
```
## AWS configuration
```elixir
config :ex_aws,
access_key_id: CHANGEME,
secret_access_key: CHANGEME,
security_token: CHANGEME,
region: CHANGEME
end
```
A [WebIdentityAdapter](https://github.com/ex-aws/ex_aws_sts?tab=readme-ov-file#using-web-identity-tokens-from-env-vars) can also be used in deployed environments.
## Example
```elixir
MyERC20Token.transfer("0x[Recipient]", 1000)
|> Ethers.send(
from: "0x[Sender]",
signer: EthersKMS.AWS.Signer,
# NOTE: provide a valid kms_key_id here (i.e., ECC_SECG_P256K1 key spec)
signer_opts: [kms_key_id: kms_key_id]
)
```
The complete documentation is available on [hexdocs](https://hexdocs.pm/ethers_kms/readme.html).