Skip to content

Latest commit

 

History

History
96 lines (78 loc) · 3.62 KB

README.md

File metadata and controls

96 lines (78 loc) · 3.62 KB
Raw

ACS Actions Widget

This is a web widget to help you integrate with ACS protocol Actions.

Usage

In order to embed the widget add the following snippet at any location on the hosting page:

<head>
  <!-- Import the styles from us or provide your own -->
  <link rel="stylesheet" href="https://d365a01fpruiwk.cloudfront.net/acs-widget-actions-staging/main.css" /> 
</head>
<body>
  ...
  <div id="acs-blink"></div> <!-- <= Place where the ACS button will show -->
  ...
  <script>
    (function (w, d, s, o, f, js, fjs) {
        w[o] = w[o] || function () { (w[o].q = w[o].q || []).push(arguments) };
        js = d.createElement(s), fjs = d.getElementsByTagName(s)[0];
        js.id = o; js.src = f; js.async = 1; fjs.parentNode.insertBefore(js, fjs);
    }(window, document, 'script', '_acs_blink', 'https://d365a01fpruiwk.cloudfront.net/acs-widget-actions-staging/widget.js'));
    _acs_blink('init', {
      element: document.getElementById('acs-blink'),
      poolId: 'Fxh4hDFHJuTfD3Eq4en36dTk8QvbsSMoTE5Y2hVX3qVt',
      poolName: "The Block",
      poolSlug: "the-block" // contact Access Protocol to get the right slug value
      websiteUrl: "https://theblock.co",
      showWebsite: true,
      showTitle: true,
      showDescription: true,
      showImage: true
    });
    // Here's how you listen for connected wallet and you'll receive:
    // { address: string; locked: number, airdrop: number }
    // address - user's wallet address
    // locked - amount of ACS (with decimals) locked against your pool
    // airdrop - amount of ACS (with decimals) airdroped against your pool
    // ----------------------------------------------------------------
    // NOTE: To get ACS withtout decimals divide the numbers by 10 ** 6
    document.querySelector("#acs-blink").addEventListener("connected", (event) => {
      console.log("Connected to the wallet: " + JSON.stringify(event.detail));
    });
    document.querySelector("#acs-blink").addEventListener("bought", (event) => {
      console.log("Bought tNFT with signature: " + JSON.stringify(event.detail));
    });
  </script>
</body>

You can find a full list of configurations in AppConfigurations interface. To make it work for you own pool, make sure you're change the poolId and poolName. You can optionally change CSS class prefix classPrefix to provide your CSS styling for the app and prevent collision with your names. (By default our classPrefix is set to "acs__" which should be enough to not colide with anyone).

Production builds

For production use these URLs:

  • https://d365a01fpruiwk.cloudfront.net/acs-widget-actions/widget.js
  • https://d365a01fpruiwk.cloudfront.net/acs-widget-actions/main.css

Develop

The widget dev setup is similar to regular client application. To get started:

yarn install
cp .env.example .env.development
vim .env.development # Fill in the right contract program ID
yarn dev

This will open browser with "demo" page which hosts the widget.

Release new version to staging

git push origin main
git tag vX.X.X-beta && git push origin vX.X.X-beta

After this wait for the Github Actions to finish the deploy to S3 and Cloudfront. The demo app will be avail at: https://d365a01fpruiwk.cloudfront.net/acs-widget-actions-staging/index.html

Release new version to production

git push origin main
git tag vX.X.X && git push origin vX.X.X

After this wait for the Github Actions to finish the deploy to S3 and Cloudfront. The demo app will be avail at: https://d365a01fpruiwk.cloudfront.net/acs-widget-actions/index.html

License

The source and documentation in this project are released under the MIT License