Struct NodeClient 

pub struct NodeClient { /* private fields */ }

The client to the user node.

Requests are proxied via the gateway CONNECT proxies. These proxies avoid exposing user nodes to the public internet and enforce user authentication and other request rate limits.

• Requests made to running nodes use the Run-specific RestClient.
• Requests made to provisioning nodes use a RestClient which is created on-the-fly. This is because it is necessary to include a TLS config which checks the server’s remote attestation against a Measurement which is only known at provisioning time. This is also desirable because provision requests generally happen only once, so there is no need to maintain a connection pool after provisioning has complete.

Implementations

impl NodeClient

pub fn new( rng: &mut impl Crng, use_sgx: bool, deploy_env: DeployEnv, gateway_client: GatewayClient, credentials: CredentialsRef<'_>, ) -> Result<Self>

pub fn user_pk(&self) -> Option<UserPk>

Returns the user’s public key, if available from the credentials.

Returns None if credentials were created before node v0.8.11, which didn’t include user_pk.

pub async fn create_client_credentials( &self, req: CreateRevocableClientRequest, ) -> Result<(RevocableClient, ClientCredentials)>

Ask the user node to create a new RevocableClient and return it along with its ClientCredentials.

pub async fn request_provision_token(&self) -> Result<BearerAuthToken>

Get a short-lived auth token with Scope::All for provisioning.

Trait Implementations

impl AppNodeProvisionApi for NodeClient

async fn provision( &self, measurement: Measurement, data: NodeProvisionRequest, ) -> Result<Empty, NodeApiError>

Provision a node with the given Measurement. The provisioning node’s remote attestation will be checked against the given Measurement.

impl AppNodeRunApi for NodeClient

async fn node_info(&self) -> Result<NodeInfo, NodeApiError>

GET /app/node_info Empty -> NodeInfo

async fn list_channels(&self) -> Result<ListChannelsResponse, NodeApiError>

GET /app/list_channels Empty -> ListChannelsResponse

async fn sign_message( &self, data: SignMsgRequest, ) -> Result<SignMsgResponse, NodeApiError>

POST /app/sign_message SignMsgRequest -> SignMsgResponse

async fn verify_message( &self, data: VerifyMsgRequest, ) -> Result<VerifyMsgResponse, NodeApiError>

POST /app/verify_message VerifyMsgRequest -> VerifyMsgResponse

async fn open_channel( &self, data: OpenChannelRequest, ) -> Result<OpenChannelResponse, NodeApiError>

POST /app/open_channel OpenChannelRequest -> OpenChannelResponse

async fn preflight_open_channel( &self, data: PreflightOpenChannelRequest, ) -> Result<PreflightOpenChannelResponse, NodeApiError>

POST /app/preflight_open_channel PreflightOpenChannelRequest -> PreflightOpenChannelResponse

async fn close_channel( &self, data: CloseChannelRequest, ) -> Result<Empty, NodeApiError>

POST /app/close_channel CloseChannelRequest -> Empty

async fn preflight_close_channel( &self, data: PreflightCloseChannelRequest, ) -> Result<PreflightCloseChannelResponse, NodeApiError>

POST /app/preflight_close_channel PreflightCloseChannelRequest -> PreflightCloseChannelResponse

async fn create_invoice( &self, data: CreateInvoiceRequest, ) -> Result<CreateInvoiceResponse, NodeApiError>

POST /app/create_invoice CreateInvoiceRequest -> CreateInvoiceResponse

async fn pay_invoice( &self, req: PayInvoiceRequest, ) -> Result<PayInvoiceResponse, NodeApiError>

POST /app/pay_invoice PayInvoiceRequest -> PayInvoiceResponse

async fn preflight_pay_invoice( &self, req: PreflightPayInvoiceRequest, ) -> Result<PreflightPayInvoiceResponse, NodeApiError>

POST /app/preflight_pay_invoice PreflightPayInvoiceRequest -> PreflightPayInvoiceResponse

async fn pay_onchain( &self, req: PayOnchainRequest, ) -> Result<PayOnchainResponse, NodeApiError>

POST /app/pay_onchain PayOnchainRequest -> PayOnchainResponse

async fn preflight_pay_onchain( &self, req: PreflightPayOnchainRequest, ) -> Result<PreflightPayOnchainResponse, NodeApiError>

POST /app/preflight_pay_onchain PreflightPayOnchainRequest -> PreflightPayOnchainResponse

async fn create_offer( &self, req: CreateOfferRequest, ) -> Result<CreateOfferResponse, NodeApiError>

POST /app/create_offer CreateOfferRequest -> CreateOfferResponse

async fn pay_offer( &self, req: PayOfferRequest, ) -> Result<PayOfferResponse, NodeApiError>

POST /app/pay_offer PayOfferRequest -> PayOfferResponse

async fn preflight_pay_offer( &self, req: PreflightPayOfferRequest, ) -> Result<PreflightPayOfferResponse, NodeApiError>

POST /app/preflight_pay_offer PreflightPayOfferRequest -> PreflightPayOfferResponse

async fn get_address(&self) -> Result<GetAddressResponse, NodeApiError>

POST /app/get_address Empty -> GetAddressResponse

async fn get_payments_by_indexes( &self, _: PaymentCreatedIndexes, ) -> Result<VecBasicPaymentV1, NodeApiError>

👎Deprecated:

since app-v0.8.9+29 and sdk-sidecar-v0.3.1: Use get_payments_by_ids instead

POST /app/payments/indexes PaymentCreatedIndexes -> VecDbPaymentV1

async fn get_new_payments( &self, _: GetNewPayments, ) -> Result<VecBasicPaymentV1, NodeApiError>

👎Deprecated:

since app-v0.8.9+29 and sdk-sidecar-v0.3.1: Use get_updated_payments instead

GET /app/payments/new GetNewPayments -> VecBasicPaymentV1

async fn get_updated_payments( &self, req: GetUpdatedPayments, ) -> Result<VecBasicPaymentV2, NodeApiError>

GET /app/payments/updated GetUpdatedPayments -> VecBasicPaymentV2

async fn get_payment_by_id( &self, req: PaymentIdStruct, ) -> Result<MaybeBasicPaymentV2, NodeApiError>

GET /app/v1/payments/id PaymentIdStruct -> MaybeBasicPaymentV2

async fn update_payment_note( &self, req: UpdatePaymentNote, ) -> Result<Empty, NodeApiError>

PUT /app/payments/note UpdatePaymentNote -> Empty

async fn get_revocable_clients( &self, req: GetRevocableClients, ) -> Result<RevocableClients, NodeApiError>

Lists all revocable clients.

async fn create_revocable_client( &self, req: CreateRevocableClientRequest, ) -> Result<CreateRevocableClientResponse, NodeApiError>

Creates a new revocable client. Returns the newly issued client cert.

async fn update_revocable_client( &self, req: UpdateClientRequest, ) -> Result<UpdateClientResponse, NodeApiError>

Updates this revocable client. Returns the updated client.

async fn list_broadcasted_txs(&self) -> Result<Value, NodeApiError>

List all broadcasted transactions.

async fn backup_info(&self) -> Result<BackupInfo, NodeApiError>

Get the current status of Node backup.

async fn setup_gdrive(&self, req: SetupGDrive) -> Result<Empty, NodeApiError>

Setup GDrive backup.

async fn get_human_bitcoin_address( &self, ) -> Result<HumanBitcoinAddress, NodeApiError>

Get current user’s human Bitcoin address.

async fn update_human_bitcoin_address( &self, req: UsernameStruct, ) -> Result<HumanBitcoinAddress, NodeApiError>

Update current user’s human Bitcoin address.

async fn get_payment_address(&self) -> Result<HumanBitcoinAddress, NodeApiError>

👎Deprecated:

since app-v0.9.3 and sdk-sidecar-v0.4.2: Use get_human_bitcoin_address instead

GET /app/payment_address Empty -> HumanBitcoinAddress

async fn update_payment_address( &self, req: UsernameStruct, ) -> Result<HumanBitcoinAddress, NodeApiError>

👎Deprecated:

since app-v0.9.3 and sdk-sidecar-v0.4.2: Use update_human_bitcoin_address instead

PUT /app/payment_address UsernameStruct -> HumanBitcoinAddress

async fn list_nwc_clients(&self) -> Result<ListNwcClientResponse, NodeApiError>

List NWC clients for the current user. Returns client info without sensitive data (no connection strings).

async fn create_nwc_client( &self, req: CreateNwcClientRequest, ) -> Result<CreateNwcClientResponse, NodeApiError>

Create a new NWC client. Generates new keys and returns the connection string.

async fn update_nwc_client( &self, req: UpdateNwcClientRequest, ) -> Result<UpdateNwcClientResponse, NodeApiError>

Update an existing NWC client’s label.

async fn delete_nwc_client( &self, req: NostrPkStruct, ) -> Result<Empty, NodeApiError>

Delete an NWC client given its nostr client public key.

impl Clone for NodeClient

fn clone(&self) -> NodeClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.