-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
20 changed files
with
1,562 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| package chain | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "os" | ||
| "path" | ||
| ) | ||
|
|
||
| const ( | ||
| defaultOfacListURL = "https://raw.githubusercontent.com/InjectiveLabs/injective-lists/master/wallets/ofac.json" | ||
| defaultofacListFilename = "ofac.json" | ||
| ) | ||
|
|
||
| var ( | ||
| ofacListFilename = defaultofacListFilename | ||
| ) | ||
|
|
||
| type OfacChecker struct { | ||
| ofacListPath string | ||
| ofacList map[string]bool | ||
| } | ||
|
|
||
| func NewOfacChecker() (*OfacChecker, error) { | ||
| checker := &OfacChecker{ | ||
| ofacListPath: getOfacListPath(), | ||
| } | ||
| if _, err := os.Stat(checker.ofacListPath); os.IsNotExist(err) { | ||
| if err := DownloadOfacList(); err != nil { | ||
| return nil, err | ||
| } | ||
| } | ||
| if err := checker.loadOfacList(); err != nil { | ||
| return nil, err | ||
| } | ||
| return checker, nil | ||
| } | ||
|
|
||
| func getOfacListPath() string { | ||
| return getFileAbsPath(path.Join("..", "metadata", ofacListFilename)) | ||
| } | ||
|
|
||
| func DownloadOfacList() error { | ||
| resp, err := http.Get(defaultOfacListURL) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| if resp.StatusCode != http.StatusOK { | ||
| return fmt.Errorf("failed to download OFAC list, status code: %d", resp.StatusCode) | ||
| } | ||
|
|
||
| outFile, err := os.Create(getOfacListPath()) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer outFile.Close() | ||
|
|
||
| _, err = io.Copy(outFile, resp.Body) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| _, err = outFile.WriteString("\n") | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (oc *OfacChecker) loadOfacList() error { | ||
| file, err := os.ReadFile(oc.ofacListPath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| var list []string | ||
| err = json.Unmarshal(file, &list) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| oc.ofacList = make(map[string]bool) | ||
| for _, item := range list { | ||
| oc.ofacList[item] = true | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (oc *OfacChecker) IsBlacklisted(address string) bool { | ||
| return oc.ofacList[address] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| # Injective Chain Keyring Helper | ||
|
|
||
| Creates a new keyring from a variety of options. See `ConfigOpt` and related options. This keyring helper allows initializing the Cosmos SDK keyring used for signing transactions. | ||
|
|
||
| It allows flexibly defining a static configuration of keys, supports multiple pre-defined keys in the same keyring, and allows loading keys from a file, deriving from mnemonic, or reading plain private key bytes from a HEX string. Extremely useful for testing and local development, but also robust for production use cases. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```go | ||
| NewCosmosKeyring(cdc codec.Codec, opts ...ConfigOpt) (sdk.AccAddress, cosmkeyring.Keyring, error) | ||
| ``` | ||
|
|
||
| **ConfigOpts:** | ||
|
|
||
| These options are global on the keyring level. | ||
|
|
||
| * `WithKeyringDir` option sets keyring path in the filesystem, useful when keyring backend is `file`. | ||
| * `WithKeyringAppName` option sets keyring application name (defaults to `injectived`) | ||
| * `WithKeyringBackend` sets the keyring backend. Expected values: `test`, `file`, `os`. | ||
| * `WithUseLedger` sets the option to use hardware wallet, if available on the system. | ||
|
|
||
| These options allow adding keys to the keyring during initialization. | ||
|
|
||
| * `WithKey` adds a single key to the keyring, without having alias name. | ||
| * `WithNamedKey` addes a single key to the keyring, with a name. | ||
| * `WithDefaultKey` sets a default key reference to use for signing (by name). | ||
|
|
||
| **KeyConfigOpts:** | ||
|
|
||
| These options are set per key. | ||
|
|
||
| * `WithKeyFrom` sets the key name to use for signing. Must exist in the provided keyring. | ||
| * `WithKeyPassphrase` sets the passphrase for keyring files. The package will fallback to `os.Stdin` if this option was not provided, but passphrase is required. | ||
| * `WithPrivKeyHex` allows specifying a private key as plain-text hex. Insecure option, use for testing only. The package will create a virtual keyring holding that key, to meet all the interfaces. | ||
| * `WithMnemonic` allows specifying a mnemonic phrase as plain-text hex. Insecure option, use for testing only. The package will create a virtual keyring to derive the keys and meet all the interfaces. | ||
|
|
||
| ## Examples | ||
|
|
||
| Initialize an in-memory keyring with a private key hex: | ||
|
|
||
| ```go | ||
| NewCosmosKeyring( | ||
| cdc, | ||
| WithKey( | ||
| WithPrivKeyHex("e6888cb164d52e4880e08a8a5dbe69cd62f67fde3d5906f2c5c951be553b2267"), | ||
| WithKeyFrom("sender"), | ||
| ), | ||
| ) | ||
| ``` | ||
|
|
||
| Initialize an in-memory keyring with a mnemonic phrase: | ||
|
|
||
| ```go | ||
| NewCosmosKeyring( | ||
| s.cdc, | ||
| WithKey( | ||
| WithMnemonic("real simple naive ....... love"), | ||
| WithKeyFrom("sender"), | ||
| ), | ||
| ) | ||
| ``` | ||
|
|
||
| Real world use case of keyring initialization from CLI flags, with a single named key set as default: | ||
|
|
||
| ```go | ||
| NewCosmosKeyring( | ||
| cdc, | ||
| WithKeyringDir(*keyringDir), | ||
| WithKeyringAppName(*keyringAppName), | ||
| WithKeyringBackend(Backend(*keyringBackend)), | ||
| WithNamedKey( | ||
| "dispatcher", | ||
| WithKeyFrom(*dispatcherKeyFrom), | ||
| WithKeyPassphrase(*dispatcherKeyPassphrase), | ||
| WithPrivKeyHex(*dispatcherKeyPrivateHex), | ||
| WithMnemonic(*dispatcherKeyMnemonic), | ||
| ), | ||
| WithDefaultKey( | ||
| "dispatcher", | ||
| ), | ||
| ) | ||
| ``` | ||
|
|
||
| ## Testing | ||
|
|
||
| ```bash | ||
| go test -v -cover | ||
|
|
||
| PASS | ||
| coverage: 83.1% of statements | ||
| ``` | ||
|
|
||
| ## Generating a Test Fixture | ||
|
|
||
| ```bash | ||
| > cd testdata | ||
|
|
||
| > injectived keys --keyring-dir `pwd` --keyring-backend file add test | ||
| ``` | ||
|
|
||
| Passphrase should be `test12345678` for this fixture to work. |
Oops, something went wrong.