Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dteam-top/safe-signer
Creating an ethers.Signer from the third party secret storages
https://github.com/dteam-top/safe-signer
Last synced: about 1 month ago
JSON representation
Creating an ethers.Signer from the third party secret storages
- Host: GitHub
- URL: https://github.com/dteam-top/safe-signer
- Owner: DTeam-Top
- License: mit
- Created: 2023-04-23T03:21:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-04-23T08:45:00.000Z (over 1 year ago)
- Last Synced: 2024-11-12T16:46:45.258Z (about 1 month ago)
- Language: TypeScript
- Size: 94.7 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# safe-signer
[](https://www.npmjs.com/package/@dteam/safe-signer)
[](https://www.npmjs.com/package/@dteam/safe-signer)
**If you need a wallet or singer in your backend server, this project is for you.**
It aims to create an [ethers.Signer](https://docs.ethers.org/v5/api/signer/#Signer) from the third party secret storages. Currently, it supports:
- Private key
- This is only for testing purposes, not recommend in production environments.
- Environment variables
- AWS Secrets Manager
- AWS Key Management Service (KMS)
- Hashicorp Vault
NOTE:
> Currently it supports `ethers@^5` only.
## How to use
### Install
Node >= 16.
```sh
npm i @dteam/safe-signer
```
### Import
Javascript:
```js
const SafeSigner = require('@dteam/safe-signer');
```
Typescript:
```ts
import SafeSigner from '@dteam/safe-signer';
```
### Examples
1. `fromPrivateKey` will return a Wallet.
```ts
const privateKeyWallet = await SafeSigner.fromPrivateKey('YOUR_PRIVATE_KEY');
```
2. `fromEnv` will return a Wallet.
```ts
const envWallet = await SafeSigner.fromEnv('ENV_VAR_FOR_PRIVATE_KEY');
```
3. `fromAwsSecretsManager` will return a Wallet.
```ts
const awsSecretsManagerWallet = await SafeSigner.fromAwsSecretsManager(
{
SecretId: 'FULL_ARN_FOR_SECRET',
SecretKeyName: 'KEY_NAME_STORED_PRIVATE_KEY',
},
{
credentials: {
accessKeyId: 'YOUR_AWS_ACCESS_KEY_ID',
secretAccessKey: 'YOUR_AWS_SECRET_ACCESS_KEY',
},
region: 'YOUR_REGION',
}
);
```
4. `fromHashicorpVault` will return a Wallet.
```ts
const hashicorpVaultWallet = await SafeSigner.fromHashicorpVault(
{
// you can set to your own vault server
// baseUrl: 'http://127.0.0.1:8200/v1',
rootPath: 'secret',
timeout: 6000,
secretName: 'wallet-secret',
secretKey: 'privateKey',
},
// login method can be any of the following:
// {token: 'plaintext-token'}
// {appRole: {roleId: 'roleId', secretId: 'secretId'}}
// {cert: {certName: 'certName'}}
// {k8s: {role: 'role', jwt: 'jwt'}}
// {ldap: {username: 'user', password: 'password'}}
// {userpass: {username: 'user', password: 'password'}}
{token: 'vault-plaintext-token'},
{secretName: 'wallet-secret', secretKey: 'privateKey'}
);
```
5. `fromAwsKms` will return a Signer because you can't get the raw private key from AWS KMS.
```ts
const awsKmsSigner = await SafeSigner.fromAwsKms('YOUR_AWS_KMS_KEY_ARN', {
credentials: {
accessKeyId: 'YOUR_AWS_ACCESS_KEY_ID',
secretAccessKey: 'YOUR_AWS_SECRET_ACCESS_KEY',
},
region: 'YOUR_REGION',
});
```
## How to build
Requirements:
- Node >= 16
- [docker](https://docs.docker.com/engine/install/) / [podman](https://podman.io/getting-started/installation) (required for testing)
- [docker-compose](https://docs.docker.com/compose/) (required for testing)
```sh
npm ci
npm run build
npm test
```