Skip to content

README.md

Latest commit

 

History

History
177 lines (126 loc) · 9.17 KB

README.md

File metadata and controls

177 lines (126 loc) · 9.17 KB

Nuget version

Hot-reload key activation (AutoNazar integration)

Services that use RegisterEmbeddedFireblocksClientFromStorage can rotate Fireblocks credentials at runtime without a pod restart by subscribing to AutoNazar key push notifications.

How it works

RegisterEmbeddedFireblocksClientFromStorage now registers EmbeddedKeyActivators in the DI container. This object holds two KeyActivator instances — one for Admin credentials, one for Signer credentials.

When AutoNazar pushes a new key via INotificatorSubscriber, the service calls ActivateKeys() on the matching activator. JwtTokenGenerator immediately swaps to the new RSA key (atomic swap — no request is dropped during rotation).

Service-side setup (ApplicationLifetimeManager)

// Inject in constructor:
private readonly EmbeddedKeyActivators _keyActivators;
private readonly INotificatorSubscriber _notificatorSubscriber;

// Subscribe in OnStarted():
_notificatorSubscriber.Subscribe(key =>
{
    if (key.Id == Program.Settings.FireblocksAdminKeyId)
        _keyActivators.Admin.ActivateKeys(key.ApiKeyValue, key.PrivateKeyValue);

    if (key.Id == Program.Settings.FireblocksSignerKeyId)
        _keyActivators.Signer.ActivateKeys(key.ApiKeyValue, key.PrivateKeyValue);
});

Settings required

FireblocksAdminKeyId  — AutoNazar key ID for admin credentials  (e.g. "embedded-fireblocks-admin-key")
FireblocksSignerKeyId — AutoNazar key ID for signer credentials (e.g. "embedded-fireblocks-signer-key")

Fallback behaviour

If AutoNazar is unavailable at startup, credentials from environment variables (FallbackAdminApiKey, FallbackAdminPrivateKey, etc. in EmbeddedFireblocksStorageOptions) are used as initial values. The Notificator subscription will activate hot-reload as soon as AutoNazar becomes available.

Generate Fireblocks API Client flow

  1. Update api-spec-2.yaml

  2. Genereate ApiClients.cs from console:

    dotnet new tool-manifest --force

    dotnet tool install NSwag.ConsoleCore

    dotnet nswag version

    dotnet nswag run nswag.json

  3. In ApiClients.cs replace:

    • status_ == 5XX -> status_ >= 500 && status_ < 600

    • public ExternalCorrelationData ExternalCorrelationData -> public CorrelationData ExternalCorrelationData

    • System.Threading.Tasks.Task<Response> ExecutePostAsync -> System.Threading.Tasks.Task<Response> WorkflowExecutePostAsync

    • System.Threading.Tasks.Task<Response> PositionsGetAsync(string id -> System.Threading.Tasks.Task<Response> PositionsGetByIdAsync(string id

    • System.Collections.Generic.List -> System.Collections.Generic.List

    In class CreateWorkflowConfigurationRequest:

    • public System.Collections.Generic.List ConfigOperations { get; set; } = new System.Collections.Generic.List(); -> public System.Collections.Generic.List ConfigOperations { get; set; } = new System.Collections.Generic.List();

    In class WorkflowConfiguration:

    • public System.Collections.Generic.List ConfigOperations { get; set; } = new System.Collections.Generic.List(); -> public System.Collections.Generic.List ConfigOperations { get; set; } = new System.Collections.Generic.List();

    In class WorkflowConfigurationSnapshot:

    • public System.Collections.Generic.List ConfigOperations { get; set; } = new System.Collections.Generic.List(); -> public System.Collections.Generic.List ConfigOperations { get; set; } = new System.Collections.Generic.List();

    In class WorkflowExecution:

    • public System.Collections.Generic.List ExecutionOperations { get; set; } = new System.Collections.Generic.List(); -> public System.Collections.Generic.List ExecutionOperations { get; set; } = new System.Collections.Generic.List();

    In class class TransactionResponse:

    • [Newtonsoft.Json.JsonProperty("externalTxId", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] -> [Newtonsoft.Json.JsonProperty("externalTxId", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]

    • [Newtonsoft.Json.JsonProperty("customerRefId", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] -> [Newtonsoft.Json.JsonProperty("customerRefId", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]

    • [Newtonsoft.Json.JsonProperty("requestedAmount", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] -> [Newtonsoft.Json.JsonProperty("requestedAmount", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]

    • [Newtonsoft.Json.JsonProperty("amount", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] -> [Newtonsoft.Json.JsonProperty("amount", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]

    • [Newtonsoft.Json.JsonProperty("netAmount", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] -> [Newtonsoft.Json.JsonProperty("netAmount", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]

    • [Newtonsoft.Json.JsonProperty("serviceFee", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] -> [Newtonsoft.Json.JsonProperty("serviceFee", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]

    • [Newtonsoft.Json.JsonProperty("fee", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] -> [Newtonsoft.Json.JsonProperty("fee", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]

    • [Newtonsoft.Json.JsonProperty("networkFee", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] -> [Newtonsoft.Json.JsonProperty("networkFee", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]

    In class class TransactionsClient:

    • public partial class TransactionsClient : BaseClient, ITransactionsClient -> public partial class TransactionsClient : BaseClient, ITransactionsClient, ITransactionsAdminClient, ITransactionsSignerClient

  4. Add to enum AssetTypeResponseType:

    [System.Runtime.Serialization.EnumMember(Value = @"TON_ASSET")]
TON_ASSET = 11,

[System.Runtime.Serialization.EnumMember(Value = @"ETH_CONTRACT")]
ETH_CONTRACT = 12,

[System.Runtime.Serialization.EnumMember(Value = @"XRP_ASSET")]
XRP_ASSET = 13,

[System.Runtime.Serialization.EnumMember(Value = @"ERC721")]
ERC721 = 14,

[System.Runtime.Serialization.EnumMember(Value = @"ERC1155")]
ERC1155 = 15

[System.Runtime.Serialization.EnumMember(Value = @"TOKEN")]
TOKEN = 16

[System.Runtime.Serialization.EnumMember(Value = @"SUI_ASSET")]
SUI_ASSET = 17,

  5. Add to enum ExchangeType:

     [System.Runtime.Serialization.EnumMember(Value = @"BYBIT_V2")]
 BYBIT_V2 = 26,
 [System.Runtime.Serialization.EnumMember(Value = @"WHITEBIT")]
 WHITEBIT = 27,

  6. fix API specification:

In class RawMessageData

  • public RawMessageDataAlgorithm? Algorithm { get; set; } Algorithm should be nullable

In class SourceTransferPeerPath:

  • public TransferPeerPathSubType? SubType { get; set; } SubType should be nullable

In class UnsignedMessage:

  • public int? Bip44addressIndex { get; set; } Bip44addressIndex should be nullable
  • public double? Bip44change { get; set; } Bip44change should be nullable
  • public string Content { get; set; } Content should be nullable and typed like object

In class AmountInfo:

  • public string Amount { get; set; } Amount should be nullable
  • public string RequestedAmount { get; set; } RequestedAmount should be nullable
  • public string NetAmount { get; set; } NetAmount should be nullable
  • public string AmountUSD { get; set; } AmountUSD should be nullable

  1. Add to enum TransactionSubStatus:

    [System.Runtime.Serialization.EnumMember(Value = @"INVALID_TYPED_MESSAGE_PARAMETERS")] INVALID_TYPED_MESSAGE_PARAMETERS = 115,