Define wallet APIs

[rishkwal]

We can have a query to get the necessary wallet details

getWalletDetails {
    onchainAddress
    balance
    balanceLastUpdated
}

[otech47]

• As a Funder, I want to see the on-chain address of a contributor who has set up a Simple wallet so that I can send them sats

Contributor.onchainAddress

ContributorType {
  ...
  onchainAddress: String
}

• Fail if the user has not set up their wallet

• If the user has a Simple wallet configured, return the string value

• If the user has an Advanced wallet configured, use the LND API /address/next (https://api.lightning.community/#v2-wallet-address-next) to retrieve a new BTC address

• If the user has a Federated wallet, their macaroon should have been automatically filled out so the process is the same as an Advanced wallet

Contributor.lightningInvoice

ContributorType {
  ...
  lightningInvoice(amount: Int!, memo: String): String
}

• Fail if the user has not set up their wallet
• Fail if the user does not have a macaroon configured (Simple wallets do not support Lightning invoice generation)
• use the LND APIs (either /v2/invoices/hodl or POST:/v1/invoices )
  • Fail if the LND API fails

WalletType: query - getInvoiceStatus

query {
  getInvoiceStatus(invoice: String!): String
}

• Use LND API: /v2/invoices/lookup and return the status of the invoice
• Two possible results: PAID or UNPAID
• If we can't lookup the invoice from any Lightning node we will have to track the contributor id or wallet ID that originated the invoice creation to hit the lookup endpoint there

WalletType: mutation - configureWallet

type SimpleWalletConfig {
  onchainAddress: String!
}
type AdvancedWalletConfig {
  macaroon: String!,
  host: String!
}
mutation {
  configureWallet(
    simpleConfig: SimpleWalletConfig,
    advancedConfig: AdvancedWalletConfig,
    federatedConfig: Boolean
  )
}

• Fail if more than 1 config option is provided in a single request: "Please provide only 1 of simpleConfig, advancedConfig, or federatedConfig"
• Fail if federatedConfig is provided, but the Contributor does not have any Allocations for Projects linked to a Wallet with a voltage_api_key
• If the user already has a Wallet record, simply update it with whatever new config is provided
• If the federatedConfig is provided, check for a voltage_api_key on the Contirbutor's Allocations for Projects linked to a Wallet
  • If api keys are found, use them to hit the Voltage API: https://api-docs.voltage.cloud/#tag/Node/paths/~1node~1create/post