x402-chainlink
    Preparing search index...

      x402-chainlink

      Chainlink CRE x402 Payment Protocol Library

      A pure library providing core functionality for implementing the x402 payment protocol on EVM chains using Chainlink CRE.

      Spec compliance: x402 v2

      Classes

      CREClient
      CREFacilitatorClient
      CREWorkflowHandler
      DiscoveryClient
      ExtensionRegistry
      FacilitatorClient
      NetworkError
      PaymentError
      X402Error

      Interfaces

      AccountConfig
      CreateExtensionDataOptions
      CreatePaymentWithPermitOptions
      CRECLIConfig
      CREClientConfig
      CREConfig
      CREConsensusInfo
      CREEndpointConfig
      CREEvmReadRequest
      CREEvmWriteRequest
      CREHttpRequest
      CREPaymentAuthorization
      CREPermitData
      CRESettlementResult
      CRESimulationResult
      CRESupportedCapabilities
      CREVerificationResult
      CREWorkflowMetadata
      CREWorkflowRequest
      CREWorkflowRequestWithRequirements
      CREWorkflowResponse
      CREWorkflowResponseExtended
      CREWorkflowResult
      DiscoveredResource
      DiscoveryClientConfig
      DiscoveryPagination
      DiscoveryParams
      DiscoveryResponse
      EIP2612PermitMessage
      EIP712PaymentMessage
      EIP712TypedData
      ErrorDTO
      ExactEVMPayload
      Extension
      ExtensionData
      FacilitatorClientConfig
      FacilitatorDeployment
      IDiscoveryClient
      IExtensionRegistry
      IFacilitatorClient
      JSONSchema
      LINKPaymentParams
      NativeCurrency
      NetworkConfig
      PaymentAuthorization
      PaymentPayload
      PaymentRequired
      PaymentRequirements
      PaymentRequirementsParams
      PermitData
      PermitDomain
      PermitTokenInfo
      PriceFeedResult
      ProviderOptions
      RegisterResourceRequest
      RegisterResourceResponse
      ResourceInfo
      ResourceMetadata
      SettlementOptions
      SettleRequest
      SettleResponse
      Signature
      SimulationClientOptions
      SupportedKind
      SupportedResponse
      TokenInfo
      TokenMetadata
      USDCPaymentParams
      ValidationResult
      VerifyRequest
      VerifyResponse

      Type Aliases

      CompactSignature
      CRECapability
      CREExecutionMode
      CRETriggerType
      CREWorkflowAction
      ErrorCode
      EVMNetworkId
      InvalidPaymentReason
      NetworkReference
      NetworkType
      PaymentRequirementsSelector
      PaymentScheme
      ResourceType
      Result
      TokenSymbol
      TransactionStatus
      VerificationReason

      Variables

      ACCOUNT_CONFIG_SCHEMA
      ADDRESS_SCHEMA
      CHAIN_ID_TO_REFERENCE
      CHAIN_IDS
      CRE_WORKFLOW_RESULT_SCHEMA
      DEFAULT_BACKOFF_MULTIPLIER
      DEFAULT_CONFIRMATIONS
      DEFAULT_CRE_ENDPOINTS
      DEFAULT_PROVIDER_TIMEOUT
      DEFAULT_RETRY_ATTEMPTS
      DEFAULT_RPC_URLS
      DISCOVERED_RESOURCE_SCHEMA
      DISCOVERY_PAGINATION_SCHEMA
      DISCOVERY_PARAMS_SCHEMA
      DISCOVERY_RESPONSE_SCHEMA
      EIP712_DOMAIN_SCHEMA
      EIP712_TYPED_DATA_SCHEMA
      ERC20_ABI
      ERC20_PERMIT_ABI
      err
      ERROR_CODES
      EVM_NETWORK_ID_SCHEMA
      EVM_NETWORKS
      EXACT_EVM_PAYLOAD_SCHEMA
      EXPLORER_URLS
      EXTENSION_DATA_SCHEMA
      FACILITATOR_DEPLOYMENTS
      FORWARDER_ADDRESSES
      globalRegistry
      HTTP_HEADERS
      INVALID_PAYMENT_REASON_SCHEMA
      NATIVE_CURRENCIES
      NATIVE_CURRENCY_SCHEMA
      NETWORK_CONFIG_SCHEMA
      NETWORK_CONFIGS
      NETWORK_ID_SCHEMA
      NETWORK_NAMES
      NETWORK_REFERENCES
      NETWORK_TYPES
      NULLABLE_ADDRESS_SCHEMA
      PAYMENT_AUTHORIZATION_SCHEMA
      PAYMENT_PAYLOAD_SCHEMA
      PAYMENT_PAYLOAD_V2_SCHEMA
      PAYMENT_REQUIRED_SCHEMA
      PAYMENT_REQUIREMENTS_SCHEMA
      PAYMENT_REQUIREMENTS_V2_SCHEMA
      PAYMENT_SCHEME_SCHEMA
      PERMIT_EIP712_TYPES
      PERMIT_SUPPORTED_TOKENS
      PRICE_FEED_ADDRESSES
      PROVIDER_OPTIONS_SCHEMA
      REGISTER_RESOURCE_REQUEST_SCHEMA
      REGISTER_RESOURCE_RESPONSE_SCHEMA
      RESOURCE_INFO_SCHEMA
      RESOURCE_METADATA_SCHEMA
      RESOURCE_TYPE_SCHEMA
      SETTLE_RESPONSE_SCHEMA
      SETTLE_RESPONSE_V2_SCHEMA
      SIGNATURE_SCHEMA
      SUPPORTED_KIND_SCHEMA
      SUPPORTED_RESPONSE_SCHEMA
      TOKEN_ADDRESSES
      TOKEN_DECIMALS
      TOKEN_NAMES
      TRANSACTION_STATUS_SCHEMA
      USDC_ADDRESSES
      VERIFY_RESPONSE_SCHEMA
      VERIFY_RESPONSE_V2_SCHEMA
      VIEM_CHAINS
      X402_EIP712_DOMAIN
      X402_EIP712_TYPES
      X402_VERSION

      Functions

      addressesEqual
      assertNever
      buildEVMCAIP2
      buildLINKPayment
      buildPaymentRequirements
      buildPaymentTypedData
      buildUSDCPayment
      bytesToHex
      checkPermitSupport
      createCREClient
      createCREClientForNetwork
      createCREConfig
      createCREFacilitatorClient
      createDiscoveryClient
      createExtensionData
      createExtensionRegistry
      createFacilitatorClient
      createPaymentPayload
      createPaymentPayloadWithPermit
      createPermitSignature
      createProvider
      createSimulationClient
      createWalletProvider
      createWorkflowHandler
      decodeBase64
      decodeCompactSignature
      decodePaymentRequired
      decodePaymentResponse
      decodePaymentSignature
      defineExtension
      encodeBase64
      encodeCompactSignature
      encodePaymentRequired
      encodePaymentResponse
      encodePaymentSignature
      executeCREWorkflow
      executeWorkflow
      extractPayerAddress
      filterRegisteredExtensions
      formatTokenAmount
      fromAtomicUnits
      getAddressUrl
      getAvailablePriceFeeds
      getAvailableTokens
      getBlockNumber
      getChainId
      getChainIdFromNetwork
      getCRECLIVersion
      getEndpointConfig
      getExtensionInfo
      getExtensionNames
      getFacilitatorDeployment
      getForwarderAddress
      getLatestPrice
      getNativeBalance
      getNetworkConfig
      getNetworkFromChainId
      getNetworkReference
      getNetworksByType
      getPermitDomain
      getPermitNonce
      getPermitSupportedTokens
      getPriceFeedAddress
      getSupportedNetworks
      getTokenAddress
      getTokenAllowance
      getTokenBalance
      getTokenDecimals
      getTokenInfo
      getTokenMetadata
      getTokenName
      getTokenSymbol
      getTransactionUrl
      getViemChain
      hasExtension
      hash
      hasPriceFeed
      hasSufficientAllowance
      hasSufficientBalance
      hexToBigInt
      hexToBytesArray
      hexToNumber
      isCAIP2Network
      isCREAvailable
      isCRECLIAvailable
      isEVMNetwork
      isLocal
      isMainnet
      isNetworkReachable
      isPermitSupported
      isPriceStale
      isTestnet
      isTokenAvailable
      isValidAddress
      isX402Error
      mergeExtensions
      networksEqual
      normalizeAddress
      normalizeNetwork
      numberToHex
      padHex
      parseEVMNetwork
      parseTokenAmount
      recoverSigner
      retryRpcCall
      safe
      selectPaymentRequirements
      settlePayment
      toAtomicUnits
      toCAIP2Network
      toDTO
      tokenToUsd
      usdToToken
      validateExtensions
      validateNetwork
      validateNetworkConfig
      verifyAndSettle
      verifyPayment
      verifySignature
      waitForSettlement
      wrapUnknown

      Settings

      Member Visibility

      On This Page

      Classes
      Interfaces
      AccountConfigCreateExtensionDataOptionsCreatePaymentWithPermitOptionsCRECLIConfigCREClientConfigCREConfigCREConsensusInfoCREEndpointConfigCREEvmReadRequestCREEvmWriteRequestCREHttpRequestCREPaymentAuthorizationCREPermitDataCRESettlementResultCRESimulationResultCRESupportedCapabilitiesCREVerificationResultCREWorkflowMetadataCREWorkflowRequestCREWorkflowRequestWithRequirementsCREWorkflowResponseCREWorkflowResponseExtendedCREWorkflowResultDiscoveredResourceDiscoveryClientConfigDiscoveryPaginationDiscoveryParamsDiscoveryResponseEIP2612PermitMessageEIP712PaymentMessageEIP712TypedDataErrorDTOExactEVMPayloadExtensionExtensionDataFacilitatorClientConfigFacilitatorDeploymentIDiscoveryClientIExtensionRegistryIFacilitatorClientJSONSchemaLINKPaymentParamsNativeCurrencyNetworkConfigPaymentAuthorizationPaymentPayloadPaymentRequiredPaymentRequirementsPaymentRequirementsParamsPermitDataPermitDomainPermitTokenInfoPriceFeedResultProviderOptionsRegisterResourceRequestRegisterResourceResponseResourceInfoResourceMetadataSettlementOptionsSettleRequestSettleResponseSignatureSimulationClientOptionsSupportedKindSupportedResponseTokenInfoTokenMetadataUSDCPaymentParamsValidationResultVerifyRequestVerifyResponse
      Type Aliases
      Variables
      ACCOUNT_CONFIG_SCHEMAADDRESS_SCHEMACHAIN_ID_TO_REFERENCECHAIN_IDSCHAINLINK_PRICE_FEED_ABICRE_WORKFLOW_RESULT_SCHEMADEFAULT_BACKOFF_MULTIPLIERDEFAULT_CONFIRMATIONSDEFAULT_CRE_ENDPOINTSDEFAULT_PROVIDER_TIMEOUTDEFAULT_RETRY_ATTEMPTSDEFAULT_RPC_URLSDISCOVERED_RESOURCE_SCHEMADISCOVERY_PAGINATION_SCHEMADISCOVERY_PARAMS_SCHEMADISCOVERY_RESPONSE_SCHEMAEIP712_DOMAIN_SCHEMAEIP712_TYPED_DATA_SCHEMAERC20_ABIERC20_PERMIT_ABIerrERROR_CODESEVM_NETWORK_ID_SCHEMAEVM_NETWORKSEXACT_EVM_PAYLOAD_SCHEMAEXPLORER_URLSEXTENSION_DATA_SCHEMAFACILITATOR_DEPLOYMENTSFORWARDER_ADDRESSESglobalRegistryHTTP_HEADERSINVALID_PAYMENT_REASON_SCHEMALINK_ADDRESSESNATIVE_CURRENCIESNATIVE_CURRENCY_SCHEMANETWORK_CONFIG_SCHEMANETWORK_CONFIGSNETWORK_ID_SCHEMANETWORK_NAMESNETWORK_REFERENCESNETWORK_TYPESNULLABLE_ADDRESS_SCHEMAPAYMENT_AUTHORIZATION_SCHEMAPAYMENT_PAYLOAD_SCHEMAPAYMENT_PAYLOAD_V2_SCHEMAPAYMENT_REQUIRED_SCHEMAPAYMENT_REQUIREMENTS_SCHEMAPAYMENT_REQUIREMENTS_V2_SCHEMAPAYMENT_SCHEME_SCHEMAPERMIT_EIP712_TYPESPERMIT_SUPPORTED_TOKENSPRICE_FEED_ADDRESSESPROVIDER_OPTIONS_SCHEMAREGISTER_RESOURCE_REQUEST_SCHEMAREGISTER_RESOURCE_RESPONSE_SCHEMARESOURCE_INFO_SCHEMARESOURCE_METADATA_SCHEMARESOURCE_TYPE_SCHEMASETTLE_RESPONSE_SCHEMASETTLE_RESPONSE_V2_SCHEMASIGNATURE_SCHEMASUPPORTED_KIND_SCHEMASUPPORTED_RESPONSE_SCHEMATOKEN_ADDRESSESTOKEN_DECIMALSTOKEN_NAMESTRANSACTION_STATUS_SCHEMAUSDC_ADDRESSESVERIFY_RESPONSE_SCHEMAVERIFY_RESPONSE_V2_SCHEMAVIEM_CHAINSX402_EIP712_DOMAINX402_EIP712_TYPESX402_VERSION
      Functions
      addressesEqualassertNeverbuildEVMCAIP2buildLINKPaymentbuildPaymentRequirementsbuildPaymentTypedDatabuildUSDCPaymentbytesToHexcheckPermitSupportcreateCREClientcreateCREClientForNetworkcreateCREConfigcreateCREFacilitatorClientcreateDiscoveryClientcreateExtensionDatacreateExtensionRegistrycreateFacilitatorClientcreatePaymentPayloadcreatePaymentPayloadWithPermitcreatePermitSignaturecreateProvidercreateSimulationClientcreateWalletProvidercreateWorkflowHandlerdecodeBase64decodeCompactSignaturedecodePaymentRequireddecodePaymentResponsedecodePaymentSignaturedefineExtensionencodeBase64encodeCompactSignatureencodePaymentRequiredencodePaymentResponseencodePaymentSignatureexecuteCREWorkflowexecuteWorkflowextractPayerAddressfilterRegisteredExtensionsformatTokenAmountfromAtomicUnitsgetAddressUrlgetAvailablePriceFeedsgetAvailableTokensgetBlockNumbergetChainIdgetChainIdFromNetworkgetCRECLIVersiongetEndpointConfiggetExtensionInfogetExtensionNamesgetFacilitatorDeploymentgetForwarderAddressgetLatestPricegetNativeBalancegetNetworkConfiggetNetworkFromChainIdgetNetworkReferencegetNetworksByTypegetPermitDomaingetPermitNoncegetPermitSupportedTokensgetPriceFeedAddressgetSupportedNetworksgetTokenAddressgetTokenAllowancegetTokenBalancegetTokenDecimalsgetTokenInfogetTokenMetadatagetTokenNamegetTokenSymbolgetTransactionUrlgetViemChainhasExtensionhashhasPriceFeedhasSufficientAllowancehasSufficientBalancehexToBigInthexToBytesArrayhexToNumberisCAIP2NetworkisCREAvailableisCRECLIAvailableisEVMNetworkisLocalisMainnetisNetworkReachableisPermitSupportedisPriceStaleisTestnetisTokenAvailableisValidAddressisX402ErrormergeExtensionsnetworksEqualnormalizeAddressnormalizeNetworknumberToHexpadHexparseEVMNetworkparseTokenAmountrecoverSignerretryRpcCallsafeselectPaymentRequirementssettlePaymenttoAtomicUnitstoCAIP2NetworktoDTOtokenToUsdusdToTokenvalidateExtensionsvalidateNetworkvalidateNetworkConfigverifyAndSettleverifyPaymentverifySignaturewaitForSettlementwrapUnknown