Skip to content

Commit

Permalink
chore: releasing GMP SDK (#5)
Browse files Browse the repository at this point in the history
* chore(release): version bump

* chore(release): GMP SDK

* feat(readme): utils description

* Update README.md

* Update package.json

* chore(release): package name

* Update README.md

Co-authored-by: Milap Sheth <milap.sheth2010@gmail.com>
  • Loading branch information
re1ro and milapsheth authored Aug 20, 2022
1 parent c279531 commit f61833c
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 8 deletions.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,33 @@
# Axelar Solidity Utilities
# Axelar GMP SDK Solidity
###### General Message Passing Development Kit

This repository contains all the necessary ingredients for successful cross-chain development
utilizing the Axelar General Message Passing protocol.

### AxelarExecutable
Base interface for validating and executing GMP contract calls.

### AxelarForecallable
Interface that allows to expedite GMP calls by lending assets and performing execution
before it fully propagates through the Axelar network.

### ConstAddressDeployer
This contract is used to deploy your Executable to have the same address on different EVM chains.
This simplifies message validation from peer Executables. You can learn more in the
[documentation](https://docs.axelar.dev/dev/build/solidity-utilities).

### Proxy and Upgradable
Base implementation of upgradable contracts designed to be deployed with `ConstAddressDeployer`
and to have the same Proxy address on different EVM chains.

### TokenLinker and NTFLinker
Allows developers to create their own cross-chain gateways for
ERC20 and ERC721 tokens utilizing the GMP protocol.
Also it's a great example how to use AxelarExecutable with Upgradable.

### StringAddressUtils
Allows conversion between `string` and `address` data types

### StringBytesUtil
Allows conversion between `string` and `bytes32` data types
for storing strings under 31 bytes into a single storage slot
File renamed without changes.
1 change: 0 additions & 1 deletion contracts/nft-linking/NftLinkerProxy.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
pragma solidity 0.8.9;

import { Proxy } from '../upgradables/Proxy.sol';
import { IUpgradable } from '../interfaces/IUpgradable.sol';

contract NftLinkerProxy is Proxy {
function contractId() internal pure override returns (bytes32) {
Expand Down
2 changes: 1 addition & 1 deletion contracts/test/UtilTest.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
pragma solidity 0.8.9;

import { StringToAddress, AddressToString } from '../StringAddressUtils.sol';
import { Bytes32ToString, StringToBytes32 } from '../BytesStringUtil.sol';
import { Bytes32ToString, StringToBytes32 } from '../StringBytesUtil.sol';

contract UtilTest {
using AddressToString for address;
Expand Down
1 change: 0 additions & 1 deletion contracts/token-linking/TokenLinkerProxy.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
pragma solidity 0.8.9;

import { Proxy } from '../upgradables/Proxy.sol';
import { IUpgradable } from '../interfaces/IUpgradable.sol';

contract TokenLinkerProxy is Proxy {
function contractId() internal pure override returns (bytes32) {
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@axelar-network/axelar-utils-solidity",
"name": "@axelar-network/axelar-gmp-sdk-solidity",
"version": "1.0.0",
"description": "Solidity libraries and utilities provided by Axelar.",
"description": "Solidity GMP SDK and utilities provided by Axelar for cross-chain development",
"main": "index.js",
"scripts": {
"test": "npx hardhat test",
Expand Down

0 comments on commit f61833c

Please sign in to comment.