deBridge 백서

deBridge

원문

bitpro가 원문에서 글자만 모은 내용이에요. 표·그림·수식은 빠지거나 깨질 수 있어요. 전체 31쪽 중 1쪽

# Get v10supported chains Source: https://docs.debridge.com/api-reference/appcontrollerv10/get-v10supported-chains /dln-details/swagger/create-tx.json get /v1.0/supported-chains # Get v10supported chains info Source: https://docs.debridge.com/api-reference/appcontrollerv10/get-v10supported-chains-info /dln-details/swagger/create-tx.json get /v1.0/supported-chains-info # Get v10token list Source: https://docs.debridge.com/api-reference/appcontrollerv10/get-v10token-list /dln-details/swagger/create-tx.json get /v1.0/token-list # Generates a transaction that cancels external call in the given order Source: https://docs.debridge.com/api-reference/dln/generates-a-transaction-that-cancels-external-call-in-the-given-order /dln-details/swagger/create-tx.json get /v1.0/dln/order/{id}/extcall-cancel-tx This endpoint generates a transaction that cancels external call in the given order. # Generates a transaction that cancels the given order Source: https://docs.debridge.com/api-reference/dln/generates-a-transaction-that-cancels-the-given-order /dln-details/swagger/create-tx.json get /v1.0/dln/order/{id}/cancel-tx This endpoint generates a transaction that cancels the given order. This transaction must be published to the destination chain of the order. Unlocked funds would be transferred to the address specified as the orderAuthority of the given order on the source chain. This transaction can only be executed by th orderAuthority of the given order on the destination chain # This endpoint returns the data for a transaction to place a cross-chain DLN order. Source: https://docs.debridge.com/api-reference/dln/this-endpoint-returns-the-data-for-a-transaction-to-place-a-cross-chain-dln-order /dln-details/swagger/create-tx.json get /v1.0/dln/order/create-tx This endpoint returns the data for a transaction to place a cross-chain DLN order. # This endpoint returns the data of order. Source: https://docs.debridge.com/api-reference/dln/this-endpoint-returns-the-data-of-order /dln-details/swagger/create-tx.json get /v1.0/dln/order/{id} This endpoint returns the data of order. # This endpoint returns the status of order. Source: https://docs.debridge.com/api-reference/dln/this-endpoint-returns-the-status-of-order /dln-details/swagger/create-tx.json get /v1.0/dln/order/{id}/status This endpoint returns the status of order. # This endpoint returns the status of order. Source: https://docs.debridge.com/api-reference/dln/this-endpoint-returns-the-status-of-order-1 /dln-details/swagger/create-tx.json get /v1.0/dln/tx/{hash}/order-ids This endpoint returns the status of order. # Returns information about Solana transactions in a given block range Source: https://docs.debridge.com/api-reference/orderevents/returns-information-about-solana-transactions-in-a-given-block-range /dln-details/swagger/monitoring.json get /api/OrderEvents/solanaDepositsAndWithdrawals # Get external call processed events by orderId Source: https://docs.debridge.com/api-reference/orders/get-external-call-processed-events-by-orderid /dln-details/swagger/monitoring.json get /api/Orders/{orderId}/externalCallProcess # Get filtered list of orders (ordered by block timestamp desc) max page size: 100 Source: https://docs.debridge.com/api-reference/orders/get-filtered-list-of-orders-ordered-by-block-timestamp-desc-max-page-size:-100 /dln-details/swagger/monitoring.json post /api/Orders/filteredList # Get order by events by creation transaction hash Source: https://docs.debridge.com/api-reference/orders/get-order-by-events-by-creation-transaction-hash /dln-details/swagger/monitoring.json get /api/Orders/creationTxHash/{creationTxHash} # Get order by events by orderId Source: https://docs.debridge.com/api-reference/orders/get-order-by-events-by-orderid /dln-details/swagger/monitoring.json get /api/Orders/{orderId} # Returns lite order model by order Id Source: https://docs.debridge.com/api-reference/orders/returns-lite-order-model-by-order-id /dln-details/swagger/monitoring.json get /api/Orders/{orderId}/liteModel # Returns number of orders in Created or Canceling state where given user (wallet) is initiator (sender of CreateEvent's transaction) Source: https://docs.debridge.com/api-reference/orders/returns-number-of-orders-in-created-or-canceling-state-where-given-user-wallet-is-initiator-sender-of-createevents-transaction /dln-details/swagger/monitoring.json get /api/Orders/getInitiatorsPendingOrdersCount # Returns order offers for unlock authorities Source: https://docs.debridge.com/api-reference/orders/returns-order-offers-for-unlock-authorities /dln-details/swagger/monitoring.json post /api/Orders/getForUnlockAuthorities # Returns order state by order Id Source: https://docs.debridge.com/api-reference/orders/returns-order-state-by-order-id /dln-details/swagger/monitoring.json get /api/Orders/{orderId}/state # Returns aggregated information about users, that used given referral code Source: https://docs.debridge.com/api-reference/referralprogram/returns-aggregated-information-about-users-that-used-given-referral-code /dln-details/swagger/monitoring.json get /api/ReferralProgram/{referralCode}/referredUsers # Returns referral code which user used in first DeBridge order Source: https://docs.debridge.com/api-reference/referralprogram/returns-referral-code-which-user-used-in-first-debridge-order /dln-details/swagger/monitoring.json get /api/ReferralProgram/referrerCode/{walletAddress} # Returns referral statistics for given referral code Source: https://docs.debridge.com/api-reference/referralprogram/returns-referral-statistics-for-given-referral-code /dln-details/swagger/monitoring.json get /api/ReferralProgram/{referralCode}/summary # Retrieves the SameChainSwapDTO object for a given swap ID. Source: https://docs.debridge.com/api-reference/samechainswap/retrieves-the-samechainswapdto-object-for-a-given-swap-id /dln-details/swagger/monitoring.json get /api/SameChainSwap/{swapId} # Retrieves the SameChainSwapDTO object for a given transaction hash. Source: https://docs.debridge.com/api-reference/samechainswap/retrieves-the-samechainswapdto-object-for-a-given-transaction-hash /dln-details/swagger/monitoring.json get /api/SameChainSwap/{chainId}/tx/{transactionHash} # Get daily statistics for given timespan Source: https://docs.debridge.com/api-reference/satistics/get-daily-statistics-for-given-timespan /dln-details/swagger/monitoring.json get /api/Satistics/getDaily # Returns locked assets statistics for given address Source: https://docs.debridge.com/api-reference/satistics/returns-locked-assets-statistics-for-given-address /dln-details/swagger/monitoring.json get /api/Satistics/{takerAddress}/lockedAssets # Returns orders statistics summary for all time Source: https://docs.debridge.com/api-reference/satistics/returns-orders-statistics-summary-for-all-time /dln-details/swagger/monitoring.json get /api/Satistics/getAllTime # Returns orders statistics summary for last 24 hours Source: https://docs.debridge.com/api-reference/satistics/returns-orders-statistics-summary-for-last-24-hours /dln-details/swagger/monitoring.json get /api/Satistics/getLatestTwentyFourHours # Get v10chainestimation Source: https://docs.debridge.com/api-reference/single-chain-swap/get-v10chainestimation /dln-details/swagger/create-tx.json get /v1.0/chain/estimation # Get v10chaintransaction Source: https://docs.debridge.com/api-reference/single-chain-swap/get-v10chaintransaction /dln-details/swagger/create-tx.json get /v1.0/chain/transaction # Adds signature for the terms and conditions Source: https://docs.debridge.com/api-reference/termsandconditions/adds-signature-for-the-terms-and-conditions /dln-details/swagger/monitoring.json post /api/TermsAndConditions/signConditions # checks if the user has signed the terms and conditions Source: https://docs.debridge.com/api-reference/termsandconditions/checks-if-the-user-has-signed-the-terms-and-conditions /dln-details/swagger/monitoring.json get /api/TermsAndConditions/{signatoryAddress}/hasSigned # Returns current terms and conditions Source: https://docs.debridge.com/api-reference/termsandconditions/returns-current-terms-and-conditions /dln-details/swagger/monitoring.json get /api/TermsAndConditions/current # Get list of tokens from a specific chain, transferred with DLN, sorted by popularity Source: https://docs.debridge.com/api-reference/tokenmetadata/get-list-of-tokens-from-a-specific-chain-transferred-with-dln-sorted-by-popularity /dln-details/swagger/monitoring.json get /api/TokenMetadata/popularTokens/{chainId} # Get list of tokens, transferred with DLN, sorted by popularity Source: https://docs.debridge.com/api-reference/tokenmetadata/get-list-of-tokens-transferred-with-dln-sorted-by-popularity /dln-details/swagger/monitoring.json get /api/TokenMetadata/popularTokens # Returns ids of orders, that were created in a transaction Source: https://docs.debridge.com/api-reference/transaction/returns-ids-of-orders-that-were-created-in-a-transaction /dln-details/swagger/monitoring.json get /api/Transaction/{orderCreationTransactionHash}/orderIds # Returns lite order models list by order tx hash Source: https://docs.debridge.com/api-reference/transaction/returns-lite-order-models-list-by-order-tx-hash /dln-details/swagger/monitoring.json get /api/Transaction/{transactionHash}/liteModels # Returns users leaderboard (at the top of the board are users, that have generated the most fees) Source: https://docs.debridge.com/api-reference/users/returns-users-leaderboard-at-the-top-of-the-board-are-users-that-have-generated-the-most-fees /dln-details/swagger/monitoring.json post /api/Users/usersLeaderboard # Returns users leaderboard (at the top of the board are users, whose referrals have generated the most fees) Source: https://docs.debridge.com/api-reference/users/returns-users-leaderboard-at-the-top-of-the-board-are-users-whose-referrals-have-generated-the-most-fees /dln-details/swagger/monitoring.json post /api/Users/referralProgramLeaderboard # Affiliate Fees Source: https://docs.debridge.com/dln-details/affiliates/affiliate-fees Referral Code, Same-Chain and Cross-Chain Affiliate Fees, and Additional Considerations for Cross-Chain Affiliate Fees. # Referral Code To enable affiliate fees, a referral code must be included in the `create-tx` request [parameters](/dln-details/integration-guidelines/order-creation/creating-order/api-parameters/api-parameters). Further details on obtaining a referral code and its additional use-cases are available in the Referrers and Integrators Overview sections. # Affiliate Fees Affiliate fees can be earned through both cross-chain and same-chain swaps by including the appropriate parameters in the request. This allows integrators to monetize swap activity within their applications. # Cross-Chain Affiliate Fees To enable affiliate fees for cross-chain swaps, the following [parameters](/dln-details/integration-guidelines/order-creation/creating-order/api-parameters/api-parameters) must be included when creating an order: * `affiliateFeePercent`: The percentage of the order input amount allocated as the affiliate fee. * `affiliateFeeRecipient`: The address or public key of the affiliate fee beneficiary. This must be: * A public key on Solana * A wallet address on EVM chains Affiliate fees become available once an order reaches the `ClaimedUnlock` [state](/dln-details/integration-guidelines/order-creation/order-tracking-api/order-states). * On EVM chains, the affiliate fee is [automatically transferred to the specified recipient when a solver claims the order](/dln-details/dln-specifics/order-fulfillment/claiming-order) * On Solana, the fee must be withdrawn manually. Further details on withdrawing affiliate fees are provided [here](/dln-details/affiliates/withdrawing-affiliate-fees). ### Additional Considerations for Cross-Chain Affiliate Fees Gas costs for affiliate fee transfers are capped at 2300 gas on EVM chains. If the `affiliateFeeRecipient` is a contract that requires more gas to process the transfer, the affiliate fees will not be sent, but the order will still be processed normally. In those cases, affiliate fees have to be claimed manually by calling `DlnSource.withdrawUnclaimedAffiliateFees(...)`. The caller can be anyone, but the specified beneficiary must be the `affiliateFeeRecipient` set in the request. # Same-Chain Affiliate Fees Affiliate fees are supported for same-chain swaps as well. These swaps use the same `affiliateFeePercent` and `affiliateFeeRecipient` [parameters](/dln-details/integration-guidelines/order-creation/creating-order/api-parameters/api-parameters), with [Solana requiring additional configuration](/dln-details/affiliates/affiliate-fees#solana). ### EVM Chains Affiliate fees for same-chain swaps on EVM chains are handled automatically during the swap transaction execution and they are not subject to the 2300 gas limit on transfers, as the cross-chain affiliate fees are. ### Solana For same-chain swaps on Solana: * The `affiliateFeeRecipient` **must be a Jupiter referral key**. * Referral keys can be generated at [https://referral.jup.ag/dashboard](https://referral.jup.ag/dashboard). * Earned fees can be claimed via the [Jupiter Referral Dashboard](https://referral.jup.ag/dashboard). # Auto Cancellation Source: https://docs.debridge.com/dln-details/affiliates/auto-cancellations How auto cancellations work for orders with a referral code. # Overview Auto cancellation can be enabled for orders associated with a [referral code](/dln-details/integration-guidelines/order-creation/creating-order/api-parameters/api-parameters#referral-code). This mechanism improves user experience by automatically cancelling unfulfilled orders after a timeout period. <Note> This feature is strictly available through an approval from deBridge. To enable this feature, deBridge must be contacted. </Note> *** ## How it works * **Timeout duration:** 5 minutes for unprofitable orders, 15 minutes for other causes (e.g. compliance issues) * **Condition:** If an order is not fulfilled within this period, it is automatically cancelled, along with any external calls (hooks) * **Benefit:** Users do not need to manually cancel the order on the destination chain, greatly improving the UX * **Cost:** The cancellation fee is subsidized by deBridge * **Market orders:** Only market orders can be cancelled, not [limit orders](/dln-details/integration-guidelines/order-creation/creating-order/quoting-strategies#limit-order-not-recommended). *** ## Returned funds and asset types Upon cancellation, returned funds are generally not the same asset originally sent.\ When orders are created, tokens are swapped for [**reserve assets**](/dln-details/dln-specifics/reserve-assets) to simplify solver book balancing.\ Assets with sufficient on-chain liquidity remain tradable. <Warning> In most cases, USDC will be used. If the reserve asset on one chain is USDC, but on another it is ETH, wETH or USDC - USDC will be used on both the source and destination chains. </Warning> The refund asset and amount can be found in `create-tx` response payload by inspecting the `srcChainTokenOut` [field](/dln-details/integration-guidelines/order-creation/creating-order/api-parameters/response#srcchaintokenout-optional). The entire input amount and all of the [fees incurred by creating an order](/dln-details/overview/fee-structure) are returned to the user. <Note> If the `srcChainTokenOut` is not present in the response payload, the refund asset is specified in `srcChainTokenIn` [field](/dln-details/integration-guidelines/order-creation/creating-order/api-parameters/response#srcchaintokenin). The reason for that is that [pre-order-swap was not performed](/dln-details/dln-specifics/bridging-non-reserve-assets#pre-order-swap) because the order input asset was a [reserve asset](/dln-details/dln-specifics/reserve-assets). </Note> *** ## Required integration parameters <Danger> When auto cancellation is enabled - `dstChainOrderAuthorityAddress` [parameter](/dln-details/integration-guidelines/order-creation/creating-order/api-parameters/api-parameters#authorities-and-recipient-address) will be overridden to a deBridge-controlled address to [cancel orders on the destination chain](/dln-details/integration-guidelines/order-creation/cancelling-order). Cancellation costs will be subsidized by deBridge in this case. The `srcAllowedCancelBeneficiary` [parameter](/dln-details/integration-guidelines/order-creation/creating-order/api-parameters/api-parameters#cancellation-beneficiary) must be set to the user's wallet address. This address acts as the beneficiary of returned funds in the event of a cancellation. **If not set correctly, funds may be lost**. It is recommended for partners to set the `srcAllowedCancelBeneficiary` parameter to a user-controlled address explicitly. If not set, the `srcChainOrderAuthorityAddress` will be used as a [fallback](/dln-details/affiliates/auto-cancellations#fallbacks). </Danger> ### Fallbacks If [`srcChainOrderAuthorityAddress` parameter](/dln-details/integration-guidelines/order-creation/creating-order/api-parameters/api-parameters#authorities-and-recipient-address) is set in `create-tx` requests, the value of it will be used as `srcAllowedCancelBeneficiary` if `srcAllowedCancelBeneficiary` is not set explicitly. *** ## Feature request steps * Integrator gives an explicit, unambiguous approval for the feature to be switched on * Integrator sets the `create-tx` [request parameters correctly](#required-integration-parameters) * Integrator confirms the parameter settings via an established communication channel * deBridge reviews several recent orders created by the integrator after the settings confirmation * deBridge switches the feature on and confirms it to the integrator # Integrators Overview Source: https://docs.debridge.com/dln-details/affiliates/integrators How integrators earn deBridge Points, generate referral links, and track integration activity. # Overview We’re super excited to introduce and announce the deBridge points program, an ecosystem initiative we have launched for all our stakeholders including current and future project partners and integrators to have a way to gain points based on the value and fees they have provided to the deBridge ecosystem which will be rewarded later this year. Points are meant to act as a significant incentive for projects to facilitate integration as points will be accumulated based on users' activity (25% goes to the specific integrator) and this will give each project a say in the future governance and value-creation within the deBridge ecosystem. # How does it work? Projects can integrate our cross-chain infrastructure in different ways — deBridge messaging, deBridge Widget, and deBridge API — to start accumulating points. Your users will earn 100 points for every \$1 in fees paid to the protocol. Similarly, paying \$10 in fees will earn 1000 points for this example transaction, and you will receive 25%. We believe those who have used deBridge and our applications deserve a share in our collective and future success. The launch of this program is a medium to incorporate decentralized governance and hand over power to the community in the future which includes users, project integrators, community members, and other stakeholders. # How to start accumulating points? Here are our go-to docs with details on how to get started in the best possible way: * [deBridge Messaging](/dmp-details/dmp/protocol-overview) * [deBridge API](/dln-details/integration-guidelines/order-creation/creating-order/quick-start) * [deBridge Widget](/dln-details/widget/deBridge-widget) # How to make sure your integration activity is accounted for? All projects need to generate the specific referral link that they pass on the backend of the deBridge integration they do to make s
프로젝트로 돌아가기